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

Примечания

Примечание

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

Примеры

- 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 Team. [сеть]

Поддержка Red Hat

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

Авторы

Nathaniel Case (@qalthos)

Подсказка

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

END_OF_DOCUMENT_MARKER

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