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