iosxr_system – Manage the system attributes on Cisco IOS XR devices
iosxr_system – Manage the system attributes on Cisco IOS XR devices
New in version 2.3.
Synopsis
- This module provides declarative management of node system attributes on Cisco IOS XR devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.
Requirements
The below requirements are needed on the host that executes this module.
- ncclient >= 0.5.3 when using netconf
- lxml >= 4.1.1 when using netconf
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
domain_name - |
Configure the IP domain name on the remote device to the provided value. Value should be in the dotted name form and will be appended to the | ||
domain_search - |
Provides the list of domain suffixes to append to the hostname for the purpose of doing name resolution. This argument accepts a list of names and will be reconciled with the current active configuration on the running node. | ||
hostname - |
Configure the device hostname parameter. This option takes an ASCII string value. | ||
lookup_enabled boolean |
|
Provides administrative control for enabling or disabling DNS lookups. When this argument is set to True, lookups are performed and when it is set to False, lookups are not performed. | |
lookup_source - |
The | ||
name_servers - |
The | ||
provider dictionary |
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Network Guide. A dict object containing connection details. | ||
host string / required |
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
password string |
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
port integer |
Default: 22 |
Specifies the port to use when building the connection to the remote device. | |
ssh_keyfile path |
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
timeout integer |
Default: 10 |
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | |
username string |
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
state - |
|
State of the configuration values in the device's current active configuration. When set to present, the values should be configured in the device active configuration and when set to absent the values should not be in the device active configuration | |
vrf - added in 2.5 |
VRF name for domain services |
Notes
Note
- Tested against IOS XRv 6.1.2
- name-servers state=absent operation with
netconf
transport is a success, but with rpc-error. This is due to XR platform issue. Recommended to use ignore_errors option with the task as a workaround. - For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Examples
- name: configure hostname and domain-name (default vrf=default)
iosxr_system:
hostname: iosxr01
domain_name: test.example.com
domain-search:
- ansible.com
- redhat.com
- cisco.com
- name: remove configuration
iosxr_system:
hostname: iosxr01
domain_name: test.example.com
domain-search:
- ansible.com
- redhat.com
- cisco.com
state: absent
- name: configure hostname and domain-name with vrf
iosxr_system:
hostname: iosxr01
vrf: nondefault
domain_name: test.example.com
domain-search:
- ansible.com
- redhat.com
- cisco.com
- name: configure DNS lookup sources
iosxr_system:
lookup_source: MgmtEth0/0/CPU0/0
lookup_enabled: True
- name: configure name servers
iosxr_system:
name_servers:
- 8.8.8.8
- 8.8.4.4
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands list |
always |
The list of configuration mode commands to send to the device
Sample: ['hostname iosxr01', 'ip domain-name test.example.com'] |
xml list added in 2.5 |
always (empty list when no xml rpc to send) |
NetConf rpc xml sent to device with transport
Sample: [' default 0 redhat.com '] |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Peter Sprygada (@privateip)
- Kedar Kekan (@kedarX)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/iosxr_system_module.html