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

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

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

УСТЕРЕГШЕЕ

Удалено в Ansible:
	версия: 2.13
Почему:	Выпущены новые и обновленные модули с более широким функционалом в Ansible 2.9
Альтернатива:	iosxr_interfaces

Описание

Этот модуль предоставляет декларативное управление интерфейсами на сетевых устройствах 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 словарь			Устарело Начиная с 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 -			Скорость передачи в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в модулях сетевого управления

Примечания

Примечание

Этот модуль работает с подключениями network_cli и netconf. См. параметры платформы IOS-XR.
Проверено на IOS XRv 6.1.3.
Преконфигурация физических интерфейсов не поддерживается с транспортом 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>']

Статус

Этот модуль будет удален в версии 2.13. [устаревший]
Для получения дополнительной информации см. УСТАРЕВШЕЕ.

Авторы

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.9/modules/iosxr_interface_module.html