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	Указывает, активен ли интерфейс или находится в режиме предварительной настройки. Предварительная настройка позволяет настроить модульные карты сервисов до их установки в маршрутизатор. При установке карты они настраиваются мгновенно. Активные карты — это те, которые уже установлены.
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 -			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий данные подключения.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу транспорта. Значение host используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: 22	Указывает порт для создания подключения к удаленному устройству.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
	username -		Настройка имени пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
rx_rate -			Скорость приёма в битах в секунду (бит/с). Этот параметр предназначен только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
speed -		Варианты: 10 100 1000	Настройка скорости интерфейса. По умолчанию используется автоматическое согласование, если не указано иное.
state -		Варианты: present ← absent up down	Состояние конфигурации интерфейса, `up` означает присутствие и работоспособность, а `down` означает присутствие и `down` операционное состояние.
tx_rate -			Скорость передачи в битах в секунду (бит/с). Этот параметр предназначен только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях

Примечания

Примечание

Проверено на 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 Team. [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.7/modules/iosxr_interface_module.html