cisco.iosxr.iosxr_interface – (deprecated, removed after 2022-06-01) Управление интерфейсом на устройствах Cisco IOS XR сети
Примечание
Этот плагин входит в коллекцию cisco.iosxr (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install cisco.iosxr.
Для использования в playbook, укажите: cisco.iosxr.iosxr_interface.
В версии 1.0.0: of cisco.iosxr
УСТАРЕВШИЙ
- Удалили в
-
главной версии после 2022-06-01
- Почему
-
Выпущены более новые и обновлённые модули с дополнительной функциональностью в Ansible 2.9
- Альтернатива
-
iosxr_interfaces
Описание
- Этот модуль предоставляет декларативное управление интерфейсами на устройствах Cisco IOS XR сети.
Примечание
У этого модуля есть соответствующий плагин действия.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ncclient >= 0.5.3 при использовании netconf
- lxml >= 4.1.1 при использовании netconf
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| active строка |
| Указывает, active или preconfigured. Предварительная настройка позволяет настроить модульные карты сервисов до их установки в маршрутизатор. При установке карты настраиваются мгновенно. Активные карты — это уже установленные карты. | |
| aggregate список / элементы=словарь | Список определений интерфейсов | ||
| active строка |
| Указывает, active или preconfigured. Предварительная настройка позволяет настроить модульные карты сервисов до их установки в маршрутизатор. При установке карты настраиваются мгновенно. Активные карты — это уже установленные карты. | |
| delay целое число | Время в секундах ожидания проверки оперативного состояния на удалённом устройстве. Это ожидание применимо для аргументов оперативного состояния, которые являются state со значениями up/down, tx_rate и rx_rate. | ||
| description строка | Описание настраиваемого интерфейса. | ||
| duplex строка |
| Настройка режима дуплекса интерфейса. По умолчанию используется автоматическое согласование, если не настроено. | |
| enabled логическое |
| Удаляет конфигурацию отключения, которая снимает принудительное административное отключение интерфейса, позволяя ему перейти в состояние включения или выключения. | |
| mtu строка | Устанавливает значение MTU для интерфейса. Диапазон от 64 до 65535 | ||
| name строка | Имя интерфейса для настройки в формате type + path . Например, GigabitEthernet0/0/0/0
| ||
| rx_rate строка | Скорость приёма в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в сетевых модулях
| ||
| speed строка |
| Настройка скорости интерфейса. По умолчанию используется автоматическое согласование, если не настроено. | |
| state строка |
| Состояние конфигурации интерфейса, up означает присутствие и оперативное включение, а down означает присутствие и оперативное down
| |
| tx_rate строка | Скорость передачи в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в сетевых модулях
| ||
| delay целое число | Значение по умолчанию: 10 | Время в секундах ожидания проверки оперативного состояния на удалённом устройстве. Это ожидание применимо для аргументов оперативного состояния, которые являются state со значениями up/down, tx_rate и rx_rate. | |
| description строка | Описание настраиваемого интерфейса. | ||
| duplex строка |
| Настройка режима дуплекса интерфейса. По умолчанию используется автоматическое согласование, если не настроено. | |
| enabled логическое |
| Удаляет конфигурацию отключения, которая снимает принудительное административное отключение интерфейса, позволяя ему перейти в состояние включения или выключения. | |
| mtu строка | Устанавливает значение MTU для интерфейса. Диапазон от 64 до 65535 | ||
| name строка / обязательно | Имя интерфейса для настройки в формате type + path . Например, GigabitEthernet0/0/0/0
| ||
| provider словарь | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий сведения о подключении. | ||
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве целевого адреса для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт, используемый при создании подключения к удалённому устройству. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Указывает тип транспорта подключения. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| rx_rate строка | Скорость приёма в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в сетевых модулях
| ||
| speed строка |
| Настройка скорости интерфейса. По умолчанию используется автоматическое согласование, если не настроено. | |
| state строка |
| Состояние конфигурации интерфейса, up означает присутствие и оперативное включение, а down означает присутствие и оперативное down
| |
| tx_rate строка | Скорость передачи в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в сетевых модулях
| ||
Примечания
Примечание
- Этот модуль работает с подключениями
network_cliиnetconf. См. параметры платформы IOS-XR. - Проверено на IOS XRv 6.1.3.
- Предварительная настройка физических интерфейсов не поддерживается с транспортом
netconf. - Для получения дополнительной информации о использовании Ansible для управления сетевыми устройствами, см. Руководство по сети Ansible
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco, см. страницу интеграции Cisco на сайте.
Примеры
- name: configure interface
cisco.iosxr.iosxr_interface:
name: GigabitEthernet0/0/0/2
description: test-interface
speed: 100
duplex: half
mtu: 512
- name: remove interface
cisco.iosxr.iosxr_interface:
name: GigabitEthernet0/0/0/2
state: absent
- name: make interface up
cisco.iosxr.iosxr_interface:
name: GigabitEthernet0/0/0/2
enabled: true
- name: make interface down
cisco.iosxr.iosxr_interface:
name: GigabitEthernet0/0/0/2
enabled: false
- name: Create interface using aggregate
cisco.iosxr.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
cisco.iosxr.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
cisco.iosxr.iosxr_interface:
aggregate:
- name: GigabitEthernet0/0/0/3
- name: GigabitEthernet0/0/0/2
state: absent
- name: Check intent arguments
cisco.iosxr.iosxr_interface:
name: GigabitEthernet0/0/0/5
state: up
delay: 20
- name: Config + intent
cisco.iosxr.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 список / элементы=строка | всегда (пустой список, если нет 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>'] |
Статус
- Этот модуль будет удалён в основной версии после 2022-06-01. [устаревший]
- Для получения дополнительной информации см. УСТАРЕВШЕЕ.
Авторы
- Ganesh Nalawade (@ganeshrn)
- Kedar Kekan (@kedarX)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/iosxr/iosxr_interface_module.html