ios_vlan – Управление VLAN на устройствах сети IOS

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

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

Обзор

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

Параметры

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

Примечания

Примечание

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

Примеры

- name: Create vlan
  ios_vlan:
    vlan_id: 100
    name: test-vlan
    state: present

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

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

- name: Delete vlan
  ios_vlan:
    vlan_id: 100
    state: absent

- name: Add vlan using aggregate
  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
  ios_vlan:
    vlan_id: 102
    interfaces:
      - GigabitEthernet0/0
      - GigabitEthernet0/1

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

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

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

Статус

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

Поддержка Red Hat

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

Авторы

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.8/modules/ios_vlan_module.html