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 Platform Options. Указывает пароль, который необходимо использовать, если требуется вход в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
authorize bool		Варианты: нет ← да	Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes`. Для получения дополнительной информации, пожалуйста, обратитесь к руководству IOS Platform Options. Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
delay		По умолчанию: 10	Задержка, на которую должен подождать проигрыватель, чтобы проверить значения параметров декларативных намерений.
interfaces обязательно			Список интерфейсов, которые должны быть связаны с VLAN.
name			Имя VLAN.
provider			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации, пожалуйста, обратитесь к руководству IOS Platform Options. Объект словаря, содержащий данные подключения.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	port	По умолчанию: 22	Указывает порт, который необходимо использовать при установлении соединения с удаленным устройством.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	timeout	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	authorize bool	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	auth_pass		Указывает пароль, который необходимо использовать, если требуется вход в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
purge		По умолчанию: "нет"	Удаляет VLAN, не определенные в параметре aggregate.
state		Варианты: present ← absent active suspend	Состояние конфигурации VLAN.
vlan_id обязательно			ID VLAN. Диапазон 1-4094.

Примечания

Примечание

Тестировалось на IOS 15.2
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, см. Руководство по Ansible для работы с сетями
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco, см. страницу интеграции Cisco https://www.ansible.com/integrations/networks/cisco.

Примеры

- 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

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

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

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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что его поддерживает команда Ansible по работе с сетями. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых командой Ansible по работе с сетями, см. здесь.

Поддержка

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

Автор

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