ce_netconf – Run an arbitrary netconf command on HUAWEI CloudEngine switches — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ce_netconf – Run an arbitrary netconf command on HUAWEI CloudEngine switches

New in version 2.4.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Sends an arbitrary netconf command on HUAWEI CloudEngine switches.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
cfg_xml - / required |  | The config xml string.
rpc - / required | Choices: get edit-config execute-action execute-cli | The type of rpc.

## Notes

Note

- This module requires the netconf system service be enabled on the remote device being managed.
- Recommended connection is `netconf`.
- This module also works with `local` connections for legacy playbooks.

## Examples

    - name: CloudEngine netconf test
      hosts: cloudengine
      connection: local
      gather_facts: no
      vars:
        cli:
          host: "{{ inventory_hostname }}"
          port: "{{ ansible_ssh_port }}"
          username: "{{ username }}"
          password: "{{ password }}"
          transport: cli

      tasks:

      - name: "Netconf get operation"
        ce_netconf:
          rpc: get
          cfg_xml: '<filter type="subtree">
                      <vlan xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
                        <vlans>
                          <vlan>
                            <vlanId>10</vlanId>
                            <vlanif>
                              <ifName></ifName>
                              <cfgBand></cfgBand>
                              <dampTime></dampTime>
                            </vlanif>
                          </vlan>
                        </vlans>
                      </vlan>
                    </filter>'
          provider: "{{ cli }}"

      - name: "Netconf edit-config operation"
        ce_netconf:
          rpc: edit-config
          cfg_xml: '<config>
                        <aaa xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
                          <authenticationSchemes>
                            <authenticationScheme operation="create">
                              <authenSchemeName>default_wdz</authenSchemeName>
                              <firstAuthenMode>local</firstAuthenMode>
                              <secondAuthenMode>invalid</secondAuthenMode>
                            </authenticationScheme>
                          </authenticationSchemes>
                        </aaa>
                       </config>'
          provider: "{{ cli }}"

      - name: "Netconf execute-action operation"
        ce_netconf:
          rpc: execute-action
          cfg_xml: '<action>
                         <l2mc xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
                           <l2McResetAllVlanStatis>
                             <addrFamily>ipv4unicast</addrFamily>
                           </l2McResetAllVlanStatis>
                         </l2mc>
                       </action>'
          provider: "{{ cli }}"

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
changed boolean | always | check to see if a change was made on the device Sample: True
end_state dictionary | always | k/v pairs of aaa params after module execution Sample: {'result': ['ok']}

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- wangdezhuang (@QijunPan)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.