cisco.ios.ios_l2_interface – (устаревший, удален после 2022-06-01) Управление интерфейсом второго уровня на устройствах Cisco IOS.

Примечание

Этот плагин входит в состав коллекции cisco.ios (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install cisco.ios.

Чтобы использовать его в playbook, укажите: cisco.ios.ios_l2_interface.

Новый в версии 1.0.0: модуля cisco.ios

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

УСТАРЕВШИЙ

Удалён в: главной версии после 2022-06-01
Почему: Выпущены более новые и обновленные модули с большей функциональностью в Ansible 2.9
Альтернатива: ios_l2_interfaces

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_vlan строка			Настройка указанной VLAN в порту доступа. Если `mode=access`, используется в качестве идентификатора VLAN доступа.
aggregate список / элементы=словарь			Список определений интерфейсов второго уровня.
	access_vlan строка		Настройка указанной VLAN в порту доступа. Если `mode=access`, используется в качестве идентификатора VLAN доступа.
	mode строка	Варианты: access trunk	Режим, в котором должен быть настроен интерфейс.
	name строка / обязательно		Полное имя интерфейса без номера логического блока, например, GigabitEthernet0/1. Псевдонимы: интерфейс
	native_vlan строка		VLAN по умолчанию, который необходимо настроить в порту trunk. Если `mode=trunk`, используется в качестве идентификатора VLAN по умолчанию для trunk.
	state строка	Варианты: present absent unconfigured	Управление состоянием конфигурации интерфейса второго уровня.
	trunk_allowed_vlans строка		Список разрешенных VLAN в заданном порту trunk. Если `mode=trunk`, это единственные VLAN, которые будут настроены на trunk, например, "2-10,15".
	trunk_vlans строка		Список VLAN, которые необходимо настроить в порту trunk. Если `mode=trunk`, используется диапазон VLAN для добавления или удаления из trunk.
mode строка		Варианты: access trunk	Режим, в котором должен быть настроен интерфейс.
name строка			Полное имя интерфейса без номера логического блока, например, GigabitEthernet0/1. Псевдонимы: интерфейс
native_vlan строка			VLAN по умолчанию, который необходимо настроить в порту trunk. Если `mode=trunk`, используется в качестве идентификатора VLAN по умолчанию для trunk.
provider словарь			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в руководстве по платформе IOS IOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это требуется. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize булево	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для построения соединения с удаленным устройством.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	username строка		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`.
state строка		Варианты: present ← absent unconfigured	Управление состоянием конфигурации интерфейса второго уровня.
trunk_allowed_vlans строка			Список разрешенных VLAN в заданном порту trunk. Если `mode=trunk`, это единственные VLAN, которые будут настроены на trunk, например, "2-10,15".
trunk_vlans строка			Список VLAN, которые необходимо настроить в порту trunk. Если `mode=trunk`, используется диапазон VLAN для добавления или удаления из trunk.

Примечания

Примечание

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

Примеры

- name: Ensure GigabitEthernet0/5 is in its default l2 interface state
  ios.ios_l2_interface:
    name: GigabitEthernet0/5
    state: unconfigured
- name: Ensure GigabitEthernet0/5 is configured for access vlan 20
  ios.ios_l2_interface:
    name: GigabitEthernet0/5
    mode: access
    access_vlan: 20
- name: Ensure GigabitEthernet0/5 only has vlans 5-10 as trunk vlans
  ios.ios_l2_interface:
    name: GigabitEthernet0/5
    mode: trunk
    native_vlan: 10
    trunk_allowed_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.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.ios_l2_interface:
    name: GigabitEthernet0/5
    mode: trunk
    trunk_vlans: 51-4094
    state: absent

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

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

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

Статус

Этот модуль будет удален в основной версии после 2022-06-01. [устаревший]
Дополнительную информацию см. в разделе УСТАРЕВШИЙ.

Авторы

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.10/collections/cisco/ios/ios_l2_interface_module.html