iosxr_system - Управление системными атрибутами на устройствах Cisco IOS XR
Новое в версии 2.3.
Обзор
- Этот модуль обеспечивает декларативное управление атрибутами системы узла на устройствах Cisco IOS XR. Он предоставляет возможность настроить параметры системы хоста или удалить эти параметры из активной конфигурации устройства.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- ncclient >= 0.5.3 при использовании netconf
- lxml >= 4.1.1 при использовании netconf
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| domain_name | Настроить имя домена IP на удалённом устройстве на указанное значение. Значение должно быть в формате доменного имени и будет добавлено к hostname, чтобы создать полное доменное имя. | ||
| domain_search | Предоставляет список суффиксов домена, которые необходимо добавить к имени хоста для целей разрешения имён. Этот аргумент принимает список имён и будет согласован с текущей активной конфигурацией на рабочем узле. | ||
| hostname | Настроить параметр имени хоста устройства. Этот параметр принимает значение ASCII-строки. | ||
| lookup_enabled bool |
| Предоставляет административный контроль для включения или отключения поиска 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 используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: 22 | Указывает порт, который необходимо использовать при построении соединения с удалённым устройством. | |
| username | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| state |
| Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в значение present значения должны быть настроены в активной конфигурации устройства, а при установке в значение absent — значения не должны присутствовать в активной конфигурации устройства. | |
| vrf (добавлено в 2.5) | Имя VRF для служб домена | ||
Примечания
Примечание
- Проверено на IOS XRv 6.1.2
- Операция 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 список | всегда | Список команд режима конфигурации, которые необходимо отправить устройству Пример: ['hostname iosxr01', 'ip domain-name test.example.com'] |
| xml список (добавлено в 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 по сети. Дополнительную информацию см. в Руководстве по поддержке модулей.
Список других модулей, также поддерживаемых командой Ansible по сети, см. в здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.6/modules/iosxr_system_module.html
