cisco.iosxr.iosxr_system_module.rst

cisco.iosxr.iosxr_system

Module to manage the system attributes.

Version added: 1.0.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

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 string		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 hostname to create a fully-qualified domain name.
domain_search list / elements=string		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 string		Configure the device hostname parameter. This option takes an ASCII string value.
lookup_enabled boolean	Choices: no yes ←	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 string		The lookup_source argument provides one or more source interfaces to use for performing DNS lookups. The interface provided in lookup_source must be a valid interface configured on the device.
name_servers list / elements=string		The name_serves argument accepts a list of DNS name servers by way of either FQDN or IP address to use to perform name resolution lookups. This argument accepts wither a list of DNS servers See examples.
state string	Choices: present ← absent	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 string	Default: "default"	VRF name for domain services

Notes

Note

• This module works with connection network_cli and netconf. See the IOS-XR Platform Options.
• 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 :ref:`Ansible Network Guide <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)
  cisco.iosxr.iosxr_system:
    hostname: iosxr01
    domain_name: test.example.com
    domain_search:
      - ansible.com
      - redhat.com
      - cisco.com
- name: remove configuration
  cisco.iosxr.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
  cisco.iosxr.iosxr_system:
    hostname: iosxr01
    vrf: nondefault
    domain_name: test.example.com
    domain_search:
      - ansible.com
      - redhat.com
      - cisco.com
- name: configure DNS lookup sources
  cisco.iosxr.iosxr_system:
    lookup_source: MgmtEth0/0/CPU0/0
    lookup_enabled: true
- name: configure name servers
  cisco.iosxr.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	always (empty list when no xml rpc to send)	NetConf rpc xml sent to device with transport netconf Sample: ['<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>']

Status

Authors

• Peter Sprygada (@privateip)
• Kedar Kekan (@kedarX)