iosxr_interface – Управление интерфейсом на устройствах Cisco IOS XR

Новая версия 2.4.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Этот модуль обеспечивает декларативное управление интерфейсами на сетевых устройствах Cisco IOS XR.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ncclient >= 0.5.3 при использовании netconf
lxml >= 4.1.1 при использовании netconf

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
active - Добавлен в 2.5		Варианты: active ← preconfigure	Указывает, находится ли интерфейс в `active` или `preconfigured` режиме. Предварительная настройка позволяет настроить модульные карты сервисов до их установки в маршрутизатор. При установке карт они мгновенно настраиваются. Активные карты — это карты, уже установленные в маршрутизатор.
aggregate -			Список определений интерфейсов. Объединяет несколько конфигураций интерфейсов, по одной на каждой строке.
delay -		Значение по умолчанию: 10	Время в секундах, которое требуется подождать перед проверкой операционного состояния на удалённом устройстве. Это ожидание применимо для операционного состояния, аргументы которого — state со значениями `up`/`down`, tx_rate и rx_rate.
description -			Описание настраиваемого интерфейса.
duplex -		Варианты: full half	Настройка режима дуплекса интерфейса. По умолчанию используется автоматическое согласование, если не указано иное.
enabled boolean		Варианты: no yes ←	Удаляет конфигурацию отключения, что снимает принудительное административное отключение интерфейса, позволяя ему перейти в состояние включения или выключения.
mtu -			Устанавливает значение MTU для интерфейса. Диапазон от 64 до 65535.
name - / обязательно			Имя интерфейса для настройки в формате `type + path`. Например, `GigabitEthernet0/0/0/0`
provider dictionary			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительная информация в руководстве по сети Руководство по сети. Объект словаря, содержащий детали соединения.
	host string / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
	password string		Указывает пароль для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port integer	Значение по умолчанию: 22	Указывает порт для подключения к удалённому устройству.
	ssh_keyfile path		Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку.
	username string		Указывает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
rx_rate -			Скорость приёма в битах в секунду (bps). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
speed -		Варианты: 10 100 1000	Настройка скорости интерфейса. По умолчанию используется автоматическое согласование, если не указано иное.
state -		Варианты: present ← absent up down	Состояние конфигурации интерфейса, `up` означает присутствие и операционное включение, а `down` означает присутствие и операционное `down` состояние
tx_rate -			Скорость передачи в битах в секунду (bps). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях

Примечания

Примечание

Тестировалось на IOS XRv 6.1.2
Предварительная настройка физических интерфейсов не поддерживается с транспортом netconf.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- 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 Network. [network]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний 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.8/modules/iosxr_interface_module.html