iosxr_system – Управление системными атрибутами на устройствах Cisco IOS XR

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Этот модуль обеспечивает декларативное управление системными атрибутами узлов на устройствах Cisco IOS XR. Он предоставляет возможность настроить параметры системного узла или удалить эти параметры из активной конфигурации устройства.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ncclient >= 0.5.3 при использовании netconf
lxml >= 4.1.1 при использовании netconf

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain_name -			Настройка имени домена IP на удалённом устройстве на предоставленное значение. Значение должно быть в форме доменного имени и будет добавлено к `hostname`, чтобы создать полное доменное имя.
domain_search -			Предоставляет список суффиксов домена для добавления к имени хоста с целью выполнения разрешения имён. Этот аргумент принимает список имён и будет согласован с текущей активной конфигурацией на работающем узле.
hostname -			Настройка параметра имени хоста устройства. Этот параметр принимает значение ASCII-строки.
lookup_enabled boolean		Варианты: no yes	Обеспечивает административный контроль включения или выключения поиска DNS. Когда этот аргумент установлен в значение True, выполняется поиск, а при установке в False — нет.
lookup_source -			Аргумент `lookup_source` предоставляет один или несколько исходных интерфейсов для использования при выполнении поиска DNS. Интерфейс, указанный в `lookup_source`, должен быть корректным интерфейсом, настроенным на устройстве.
name_servers -			Аргумент `name_serves` принимает список DNS-серверов по имени или IP-адресу, используемых для выполнения поиска разрешения имён. Этот аргумент принимает список DNS-серверов. См. примеры.
provider dictionary			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий сведения о подключении.
	host string / обязательно		Указывает имя или адрес хоста DNS для подключения к удалённому устройству по указанному транспорту. Значение параметра host используется в качестве целевого адреса для транспорта.
	password string		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port integer	По умолчанию: 22	Указывает порт, используемый при создании подключения к удалённому устройству.
	ssh_keyfile path		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer	По умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут превышен до завершения операции, модуль вернёт ошибку.
	username string		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_USERNAME`.
state -		Варианты: present ← absent	Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в значение present значения должны быть настроены в активной конфигурации устройства, а при установке в absent — нет.
vrf - добавлен в 2.5			Имя VRF для услуг домена

Примечания

Примечание

Этот модуль работает с подключением network_cli и netconf. См. варианты платформы IOS-XR.
Проверено на IOS XRv 6.1.3
Операция name-servers state=absent с транспортом netconf завершается успешно, но с ошибкой rpc. Это связано с проблемой платформы XR. Рекомендуется использовать параметр ignore_errors в задаче в качестве обходного решения.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны в этом разделе. Следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
commands list	всегда	Список команд конфигурации для отправки на устройство Пример: ['hostname iosxr01', 'ip domain-name test.example.com']
xml list добавлен в 2.5	всегда (пустой список, если нет xml rpc для отправки)	NetConf rpc xml отправлен на устройство с помощью транспорта `netconf`. Пример: ['<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>']

Статус

Гарантируется, что у этого модуля не будет обратной совместимости. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке Red Hat этого модуля см. в статье базы знаний Red Hat.

Авторы

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.9/modules/iosxr_system_module.html