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

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

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

Обзор

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

Параметры

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

Примечания

Примечание

Тестировалось на VyOS 1.1.8 (helium).
Этот модуль работает с подключением network_cli. См. параметры платформы VyOS OS.
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible

Примеры

- name: Create vlan
  vyos_vlan:
    vlan_id: 100
    name: vlan-100
    interfaces: eth1
    state: present

- name: Add interfaces to VLAN
  vyos_vlan:
    vlan_id: 100
    interfaces:
      - eth1
      - eth2

- name: Configure virtual interface address
  vyos_vlan:
    vlan_id: 100
    interfaces: eth1
    address: 172.26.100.37/24

- name: vlan interface config + intent
  vyos_vlan:
    vlan_id: 100
    interfaces: eth0
    associated_interfaces:
    - eth0

- name: vlan intent check
  vyos_vlan:
    vlan_id: 100
    associated_interfaces:
    - eth3
    - eth4

- name: Delete vlan
  vyos_vlan:
    vlan_id: 100
    interfaces: eth1
    state: absent

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

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

Ключ	Возвращено	Описание
commands список	всегда	Список команд конфигурации режима, которые должны быть отправлены на устройство Пример: ['set interfaces ethernet eth1 vif 100 description VLAN 100', 'set interfaces ethernet eth1 vif 100 address 172.26.100.37/24', 'delete interfaces ethernet eth1 vif 100']

Статус

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

Поддержка Red Hat

Дополнительную информацию о поддержке Red Hat этого модуля можно найти в этой статье базы знаний 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.9/modules/vyos_vlan_module.html