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-серверов с помощью полного доменного имени или IP-адреса для выполнения поиска разрешения имен. Этот аргумент принимает список DNS-серверов. См. примеры. | ||
| provider - | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Дополнительную информацию см. в руководстве по сети Руководство по сети. Объект словаря, содержащий сведения о подключении. | ||
| host - / обязательно | Указывает имя или адрес хоста DNS для подключения к удаленному устройству по указанному транспорту. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль для проверки подлинности подключения к удаленному устройству. Это значение используется для проверки подлинности сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port - | По умолчанию: 22 | Указывает порт для создания подключения к удаленному устройству. | |
| ssh_keyfile - | Указывает SSH-ключ для проверки подлинности подключения к удаленному устройству. Это значение — путь к ключу, используемому для проверки подлинности сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | |
| username - | Настраивает имя пользователя для проверки подлинности подключения к удаленному устройству. Это значение используется для проверки подлинности сеанса 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 страница интеграции 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 Team. [сетевой]
Поддержка 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.7/modules/iosxr_system_module.html
