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

Примечание

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

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

Для использования в книге задач укажите: cisco.ios.ios_vlan.

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

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

УСТАРЕВШЕЕ

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список / элементы=словарь			Список определений VLAN.
	associated_interfaces список / элементы=строка		Это параметр намерения, и он проверяет оперативное состояние для заданной vlan `name` для сопоставленных интерфейсов. Если значение в `associated_interfaces` не соответствует оперативному состоянию интерфейсов VLAN на устройстве, это приведет к ошибке.
	delay целое число		Задержка, которую задача должна ожидать для проверки значений параметров декларативного намерения.
	interfaces список / элементы=строка		Список интерфейсов, которые должны быть сопоставлены с VLAN.
	name строка		Имя VLAN.
	state строка	Варианты: present absent active suspend	Состояние конфигурации VLAN.
	vlan_id строка / обязательно		Идентификатор VLAN. Диапазон 1-4094.
associated_interfaces список / элементы=строка			Это параметр намерения, и он проверяет оперативное состояние для заданной vlan `name` для сопоставленных интерфейсов. Если значение в `associated_interfaces` не соответствует оперативному состоянию интерфейсов VLAN на устройстве, это приведет к ошибке.
delay целое число		По умолчанию: 10	Задержка, которую задача должна ожидать для проверки значений параметров декларативного намерения.
interfaces список / элементы=строка			Список интерфейсов, которые должны быть сопоставлены с VLAN.
name строка			Имя VLAN.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в руководстве по параметрам платформы IOS IOS Platform Options guide. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize ложь, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения `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 целое число			Идентификатор 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ios/ios_vlan_module.html