ios_l2_interface – Управление интерфейсом второго уровня на устройствах Cisco IOS.

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_vlan -			Настройка заданной VLAN на порту доступа. Если `mode=access`, используется в качестве идентификатора VLAN доступа.
aggregate -			Список определений интерфейсов второго уровня.
auth_pass -			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes` с `become_pass`. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
authorize boolean		Варианты: no ← да	Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes`. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
mode -		Варианты: access ← trunk	Режим конфигурации интерфейса.
name - / обязательно			Полное имя интерфейса без номера логического блока, например, GigabitEthernet0/1. псевдонимы: интерфейс
native_vlan -			Основная VLAN, настраиваемая на порту магистрали. Если `mode=trunk`, используется в качестве идентификатора основной VLAN магистрали.
provider -			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в руководстве IOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass -		Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: no ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	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`.
state -		Варианты: present ← absent unconfigured	Управление состоянием конфигурации интерфейса второго уровня.
trunk_allowed_vlans -			Список разрешённых VLAN на порту магистрали. Если `mode=trunk`, только эти VLAN будут настроены на магистрали, например, "2-10,15".
trunk_vlans -			Список VLAN, которые нужно настроить на порту магистрали. Если `mode=trunk`, используется диапазон VLAN для добавления или удаления из магистрали.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco .

Примеры

- name: Ensure GigabitEthernet0/5 is in its default l2 interface state
  ios_l2_interface:
    name: GigabitEthernet0/5
    state: unconfigured

- name: Ensure GigabitEthernet0/5 is configured for access vlan 20
  ios_l2_interface:
    name: GigabitEthernet0/5
    mode: access
    access_vlan: 20

- name: Ensure GigabitEthernet0/5 only has vlans 5-10 as trunk vlans
  ios_l2_interface:
    name: GigabitEthernet0/5
    mode: trunk
    native_vlan: 10
    trunk_vlans: 5-10

- name: Ensure GigabitEthernet0/5 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged)
  ios_l2_interface:
    name: GigabitEthernet0/5
    mode: trunk
    native_vlan: 10
    trunk_vlans: 2-50

- name: Ensure these VLANs are not being tagged on the trunk
  ios_l2_interface:
    name: GigabitEthernet0/5
    mode: trunk
    trunk_vlans: 51-4094
    state: absent

Возвращаемые значения

Общие значения возврата описаны в этом разделе, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое	Описание
commands список	всегда, кроме платформ, которые используют транспорт Netconf для управления устройством.	Список команд режима конфигурации для отправки на устройство Пример: ['interface GigabitEthernet0/5', 'switchport access vlan 20']

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти в этой статье из базы знаний Red Hat .

Авторы

Nathaniel Case (@qalthos)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ для улучшения.

© 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/ios_l2_interface_module.html