cisco.ios.ios_vlan – (устаревший, удалён после 2022-06-01) Управление VLAN на устройствах сети IOS

Примечание

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

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

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

Новое в версии 1.0.0: of cisco.ios

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

УСТАРЕВШИЙ

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список / элементы=словарь			Список определений VLAN.
	associated_interfaces список / элементы=строка		Это опция намерения и проверяет операционное состояние указанных VLAN `name` для интерфейсов. Если значение в `associated_interfaces` не совпадает с операционным состоянием интерфейсов VLAN на устройстве, произойдёт ошибка.
	delay целое число		Задержка, которую должен ожидать playbook, чтобы проверить значения параметров декларативного намерения.
	interfaces список / элементы=строка / обязательно		Список интерфейсов, которые должны быть ассоциированы с VLAN.
	name строка		Имя VLAN.
	state строка	Варианты: present absent active suspend	Состояние конфигурации VLAN.
	vlan_id строка / обязательно		ID VLAN. Диапазон 1-4094.
associated_interfaces список / элементы=строка			Это опция намерения и проверяет операционное состояние указанных VLAN `name` для интерфейсов. Если значение в `associated_interfaces` не совпадает с операционным состоянием интерфейсов VLAN на устройстве, произойдёт ошибка.
delay целое число		По умолчанию: 10	Задержка, которую должен ожидать playbook, чтобы проверить значения параметров декларативного намерения.
interfaces список / элементы=строка			Список интерфейсов, которые должны быть ассоциированы с VLAN.
name строка			Имя VLAN.
provider словарь			Устаревшее Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` Для получения дополнительной информации, см. руководство по параметрам платформы IOS. Объект словаря, содержащий данные подключения.
	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`
purge логическое		Варианты: нет ← да	Очистить VLAN, не определённые в параметре aggregate.
state строка		Варианты: present ← absent active suspend	Состояние конфигурации VLAN.
vlan_id целое число			ID VLAN. Диапазон 1-4094.

Примечания

Примечание

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

Примеры

- name: Create vlan
  cisco.ios.ios_vlan:
    vlan_id: 100
    name: test-vlan
    state: present

- name: Add interfaces to VLAN
  cisco.ios.ios_vlan:
    vlan_id: 100
    interfaces:
    - GigabitEthernet0/0
    - GigabitEthernet0/1

- name: Check if interfaces is assigned to VLAN
  cisco.ios.ios_vlan:
    vlan_id: 100
    associated_interfaces:
    - GigabitEthernet0/0
    - GigabitEthernet0/1

- name: Delete vlan
  cisco.ios.ios_vlan:
    vlan_id: 100
    state: absent

- name: Add vlan using aggregate
  cisco.ios.ios_vlan:
    aggregate:
    - {vlan_id: 100, name: test-vlan, interfaces: [GigabitEthernet0/1, GigabitEthernet0/2],
      delay: 15, state: suspend}
    - {vlan_id: 101, name: test-vlan, interfaces: GigabitEthernet0/3}

- name: Move interfaces to a different VLAN
  cisco.ios.ios_vlan:
    vlan_id: 102
    interfaces:
    - GigabitEthernet0/0
    - GigabitEthernet0/1

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

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

Ключ	Возвращённое	Описание
commands список / элементы=строка	всегда	Список команд конфигурации в режиме, который нужно отправить устройству Пример: ['vlan 100', 'name test-vlan']

Статус

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

Авторы

Trishna Guha (@trishnaguha)

© 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_vlan_module.html