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 | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. Руководство по сети. Объект dict, содержащий сведения о подключении. | ||
| 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. | ||
| 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'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой 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/vyos_vlan_module.html
