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 |
| Предоставляет административный контроль для включения или выключения поиска DNS. Когда этот аргумент установлен в значение True, выполняется поиск, а когда он установлен в значение False, поиск не выполняется. | |
| lookup_source | Аргумент lookup_source предоставляет один или несколько интерфейсов источника для использования при выполнении поиска DNS. Интерфейс, указанный в lookup_source, должен быть действительным интерфейсом, настроенным на устройстве. | ||
| name_servers | Аргумент name_serves принимает список DNS-серверов с помощью полных доменных имён (FQDN) или IP-адресов, которые будут использоваться для поиска разрешения имён. Этот аргумент принимает список DNS-серверов. Смотрите примеры. | ||
| provider | По умолчанию: None | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Дополнительную информацию можно найти в руководстве по сети Network Guide. Объект словаря, содержащий сведения о подключении. | |
| username | Настройка имени пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя DNS-хоста или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | |
| password | По умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| port | По умолчанию: 22 | Указывает порт, используемый при создании подключения к удалённому устройству. | |
| 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 Cisco integration page.
Примеры
- 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 список | всегда (пустой список, если нет xml rpc для отправки) | XML-rpc NetConf, отправленное устройству с транспортом 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>'] |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантирует обратной совместимости.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний Knowledge Base article
Автор
- 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.5/modules/iosxr_system_module.html
