The below requirements are needed on the host that executes this module.
| 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 |
| || |
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 |
| name_servers |
| provider |
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 |
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 |
| Default: |
Specifies the port to use when building the connection to the remote device.
| ssh_keyfile |
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 |
| Default: |
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 |
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
netconf. See the IOS-XR Platform Options.
netconftransport 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.
- 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: - 18.104.22.168 - 22.214.171.124
Common return values are documented here, the following are the fields unique to this module:
| commands |
The list of configuration mode commands to send to the device
['hostname iosxr01', 'ip domain-name test.example.com']
| xml |
added in 2.5
|always (empty list when no xml rpc to send)|| |
NetConf rpc xml sent to device with transport
['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <ip-domain xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ip-domain-cfg"> <vrfs> <vrf> <vrf-name>default</vrf-name> <lists> <list xc:operation="merge"> <order>0</order> <list-name>redhat.com</list-name> </list> </lists> </vrf> </vrfs> </ip-domain> </config>']
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.