vyos_vlan — Управление VLAN на устройствах сети VyOS
Новая версия с 2.5.
Обзор
- Этот модуль предоставляет декларативное управление VLAN на устройствах сети VyOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address | Настройка адреса виртуального интерфейса. | ||
| aggregate | Список определений VLAN. | ||
| associated_interfaces (добавлено в 2.5) | Это параметр намерения и проверяет оперативное состояние для заданного vlan name для ассоциированных интерфейсов. Если значение в associated_interfaces не совпадает с оперативным состоянием VLAN на устройстве, это приведет к ошибке. | ||
| delay | Значение по умолчанию: 10 | Задержка, которую должен ожидать play для проверки значений параметров декларативного намерения. | |
| interfaces обязательно | Список интерфейсов, которые должны быть ассоциированы с VLAN. | ||
| name | Имя VLAN. | ||
| provider | Значение по умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. Руководство по сети. Объект dict, содержащий данные подключения. | |
| username | Настройка имени пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекает до завершения операции, модуль вернет ошибку. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт, используемый при построении соединения с удаленным устройством. | |
| purge | Значение по умолчанию: нет | Удаляет VLAN, не определенные в параметре aggregate. | |
| state |
| Состояние конфигурации VLAN. | |
| vlan_id обязательно | Идентификатор VLAN. Диапазон 0-4094. | ||
Примечания
Примечание
- Тестировалось на VYOS 1.1.7
- Для получения дополнительной информации об использовании 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'] |
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости интерфейса нет.
Поддержка
Для получения дополнительной информации о поддержке этого модуля 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.5/modules/vyos_vlan_module.html
