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

Примечание

Этот плагин входит в коллекцию cisco.iosxr (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install cisco.iosxr

Для использования в playbook, укажите: cisco.iosxr.iosxr_system

Новое в версии 1.0.0: плагина cisco.iosxr

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

Описание

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

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain_name строка			Настройте имя домена IP на удаленном устройстве на предоставленное значение. Значение должно быть в формате имени с точками и будет добавлено к `hostname`, чтобы создать полностью квалифицированное доменное имя.
domain_search список / элементы=строка			Предоставляет список суффиксов домена для добавления к имени хоста для целей разрешения имен. Этот аргумент принимает список имен и будет согласован с текущей активной конфигурацией на работающем узле.
hostname строка			Настройте параметр имени хоста устройства. Этот параметр принимает значение ASCII-строки.
lookup_enabled булево		Варианты: нет да ←	Обеспечивает административный контроль для включения или выключения разрешения DNS-запросов. При установке этого аргумента в True, выполняется поиск, а при установке в False - нет.
lookup_source строка			Аргумент `lookup_source` предоставляет один или несколько исходных интерфейсов для выполнения DNS-поиска. Интерфейс, указанный в `lookup_source`, должен быть валидным интерфейсом, настроенным на устройстве.
name_servers список / элементы=строка			Аргумент `name_serves` принимает список DNS-серверов в виде полного доменного имени или IP-адреса для выполнения поиска разрешения имен. Этот аргумент принимает список DNS-серверов. См. примеры.
provider словарь			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. Руководство по сетям. Объект словаря, содержащий сведения о подключении.
	host строка		Указывает имя или адрес хоста DNS для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для проверки подлинности подключения к удаленному устройству. Это значение используется для проверки подлинности сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт, используемый при построении подключения к удаленному устройству.
	ssh_keyfile путь		Указывает SSH-ключ для проверки подлинности подключения к удаленному устройству. Это значение - путь к ключу, используемому для проверки подлинности сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli ← netconf	Указывает тип транспорта подключения.
	username строка		Настраивает имя пользователя для проверки подлинности подключения к удаленному устройству. Это значение используется для проверки подлинности сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_USERNAME`.
state строка		Варианты: present ← absent	Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в present значения должны быть настроены в активной конфигурации устройства, а при установке в absent - нет.
vrf строка		По умолчанию: "default"	Имя 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)
  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

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

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

Ключ	Возвращаемое значение	Описание
commands список / элементы=строка	всегда	Список команд конфигурации режима для отправки устройству Пример: ['hostname iosxr01', 'ip domain-name test.example.com']
xml список / элементы=строка	всегда (пустой список, если нет 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>']

Авторы

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.10/collections/cisco/iosxr/iosxr_system_module.html