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

Примечание

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

Для его установки используйте: 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 булево		Варианты: no yes ←	Предоставляет административный контроль для включения или отключения поиска DNS. При установке этого аргумента в True, выполняется поиск, а при установке в False, поиск не выполняется.
lookup_source строка			Аргумент `lookup_source` предоставляет один или несколько исходных интерфейсов для использования при выполнении поиска DNS. Интерфейс, указанный в `lookup_source`, должен быть действительным интерфейсом, настроенным на устройстве.
name_servers список / элементы=строка			Аргумент `name_serves` принимает список серверов DNS, используя либо полные доменные имена (FQDN), либо 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/iosxr/iosxr_system_module.html