community.network.cnos_vlan – Управление VLAN на устройствах сети CNOS
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network
Для использования в книге задач, укажите: community.network.cnos_vlan
Обзор
- Этот модуль обеспечивает декларативное управление VLAN на сетевых устройствах Lenovo CNOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate строка | Список определений VLAN. | ||
| associated_interfaces строка | Это параметр намерения и проверяет операционное состояние для заданного vlan name для связанных интерфейсов. Если значение в associated_interfaces не совпадает с операционным состоянием интерфейсов vlan на устройстве, произойдёт ошибка. | ||
| delay строка | По умолчанию: 10 | Задержка, которую должна выждать задача для проверки значений параметров декларативного намерения. | |
| interfaces строка / обязательно | Список интерфейсов, которые должны быть связаны с VLAN. | ||
| name строка | Имя VLAN. | ||
| provider строка | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Для получения дополнительной информации, пожалуйста, обратитесь к руководству CNOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| 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 строка |
| Состояние конфигурации VLAN. | |
| vlan_id строка / обязательно | Идентификатор VLAN. Диапазон 1-4094. | ||
Примечания
Примечание
- Проверено на CNOS 10.8.1
Примеры
- name: Create vlan
community.network.cnos_vlan:
vlan_id: 100
name: test-vlan
state: present
- name: Add interfaces to VLAN
community.network.cnos_vlan:
vlan_id: 100
interfaces:
- Ethernet1/33
- Ethernet1/44
- name: Check if interfaces is assigned to VLAN
community.network.cnos_vlan:
vlan_id: 100
associated_interfaces:
- Ethernet1/33
- Ethernet1/44
- name: Delete vlan
community.network.cnos_vlan:
vlan_id: 100
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Список команд конфигурации в режиме конфигурации для отправки на устройство Пример: ['vlan 100', 'name test-vlan'] |
Авторы
- Anil Kumar Mureleedharan(@amuraleedhar)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/cnos_vlan_module.html