iosxr_interface - Управление интерфейсами на сетевых устройствах Cisco IOS XR
Новая версия 2.4.
Обзор
- Этот модуль обеспечивает декларативное управление интерфейсами на сетевых устройствах Cisco IOS XR.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ncclient >= 0.5.3 при использовании netconf
- lxml >= 4.1.1 при использовании netconf
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| active (добавлено в 2.5) |
| Указывает, является ли интерфейс active или preconfigured. Предварительная настройка позволяет настраивать модульные сетевые карты до их установки в маршрутизатор. При установке карт они немедленно настраиваются. Активные карты — это те, которые уже установлены. | |
| aggregate | Список определений интерфейсов. Объединяет несколько конфигураций интерфейсов, по одной на отдельной строке. | ||
| delay | Значение по умолчанию: 10 | Время в секундах ожидания проверки операционного состояния на удалённом устройстве. Это ожидание применимо к параметрам операционного состояния, которые представляют собой state со значениями up/down, tx_rate и rx_rate. | |
| description | Описание настраиваемого интерфейса. | ||
| duplex |
| Настройка режима дуплекса интерфейса. По умолчанию используется автоматическое согласование, если не указано иное. | |
| enabled bool |
| Удаляет настройку отключения, которая снимает принудительное административное отключение интерфейса, позволяя ему перейти в состояние «включено» или «выключено». | |
| mtu | Устанавливает значение MTU для интерфейса. Диапазон от 64 до 65535. | ||
| name обязательно | Имя интерфейса для настройки в формате type + path. Например, GigabitEthernet0/0/0/0.
| ||
| 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. | ||
| rx_rate | Скорость приёма в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
| speed |
| Настройка скорости интерфейса. По умолчанию используется автоматическое согласование, если не указано иное. | |
| state |
| Состояние конфигурации интерфейса, up означает присутствие и работоспособность, а down означает присутствие и операционное состояние down.
| |
| tx_rate | Скорость передачи в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
Примечания
Примечание
- Проверено на IOS XRv 6.1.2
- Предварительная настройка физических интерфейсов не поддерживается с транспортом
netconf. - Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по Ansible для сети
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco на сайте Ansible.
Примеры
- name: configure interface
iosxr_interface:
name: GigabitEthernet0/0/0/2
description: test-interface
speed: 100
duplex: half
mtu: 512
- name: remove interface
iosxr_interface:
name: GigabitEthernet0/0/0/2
state: absent
- name: make interface up
iosxr_interface:
name: GigabitEthernet0/0/0/2
enabled: True
- name: make interface down
iosxr_interface:
name: GigabitEthernet0/0/0/2
enabled: False
- name: Create interface using aggregate
iosxr_interface:
aggregate:
- name: GigabitEthernet0/0/0/3
- name: GigabitEthernet0/0/0/2
speed: 100
duplex: full
mtu: 512
state: present
- name: Create interface using aggregate along with additional params in aggregate
iosxr_interface:
aggregate:
- { name: GigabitEthernet0/0/0/3, description: test-interface 3 }
- { name: GigabitEthernet0/0/0/2, description: test-interface 2 }
speed: 100
duplex: full
mtu: 512
state: present
- name: Delete interface using aggregate
iosxr_interface:
aggregate:
- name: GigabitEthernet0/0/0/3
- name: GigabitEthernet0/0/0/2
state: absent
- name: Check intent arguments
iosxr_interface:
name: GigabitEthernet0/0/0/5
state: up
delay: 20
- name: Config + intent
iosxr_interface:
name: GigabitEthernet0/0/0/5
enabled: False
state: down
delay: 20
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда (пустой список, если нет команд для отправки) | Список команд режима конфигурации, отправленных устройству с транспортом cli
Пример: ['interface GigabitEthernet0/0/0/2', 'description test-interface', 'duplex half', 'mtu 512'] |
| xml список (добавлено в 2.5) | всегда (пустой список, если нет xml rpc для отправки) | NetConf rpc xml, отправленный устройству с транспортом netconf
Пример: ['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"> <interface-configuration xc:operation="merge"> <active>act</active> <interface-name>GigabitEthernet0/0/0/0</interface-name> <description>test-interface-0</description> <mtus><mtu> <owner>GigabitEthernet</owner> <mtu>512</mtu> </mtu></mtus> <ethernet xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-drivers-media-eth-cfg"> <speed>100</speed> <duplex>half</duplex> </ethernet> </interface-configuration> </interface-configurations></config>'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается Командой по сетям Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются Командой по сетям Ansible, см. в разделе здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье из базы знаний.
Автор
- Ganesh Nalawade (@ganeshrn)
- 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_interface_module.html