nxos_vlan — Управление ресурсами и атрибутами VLAN.
Новая версия 2.1.
Описание
- Управление конфигурациями VLAN на коммутаторах NX-OS.
Параметры
| Параметр | Обязательный | Значение по умолчанию | Возможные значения | Комментарии |
|---|---|---|---|---|
| admin_state |
нет | включено |
|
Управление административным состоянием VLAN, эквивалентно командам shut/no shut в режиме конфигурации VLAN. |
| auth_pass (добавлен в 2.4.4)
|
нет | нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не работает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. |
|
| authorize (добавлен в 2.4.4)
|
нет |
|
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. |
|
| host |
да | Указывает имя или адрес хоста DNS для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. |
||
| mapped_vni (добавлен в 2.2)
|
нет | Идентификатор Virtual Network Identifier (VNI), сопоставленный с VLAN. Допустимые значения — целое число и ключевое слово 'default'. |
||
| mode (добавлен в 2.4)
|
нет |
|
Устанавливает режим VLAN на классический Ethernet или fabricpath. |
|
| name |
нет | Имя VLAN. |
||
| password |
нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. |
||
| port |
нет | 0 (используется общий порт) | Указывает порт для подключения к удалённому устройству. Это значение применяется к транспорту cli или nxapi. Значение порта по умолчанию — соответствующий общий порт транспорта, если в задаче не указано другое. (cli=22, http=80, https=443). |
|
| provider |
нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта dict. Все ограничения (обязательность, допустимые значения и т.д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом dict. |
||
| ssh_keyfile |
нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. |
||
| state |
нет | наличие |
|
Управление состоянием ресурса. |
| timeout (добавлен в 2.3)
|
нет | 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль возвращает ошибку. NX-API может медленно возвращать результаты при длительных операциях (sh mac, sh bgp и т.д.). |
|
| transport |
да | cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. |
|
| use_ssl |
нет |
|
Настраивает транспорт transport для использования SSL, если значение равно true только при transport=nxapi, в противном случае это значение игнорируется. |
|
| username |
нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. |
||
| validate_certs |
нет |
|
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. Если аргумент transport не равен nxapi, это значение игнорируется. |
|
| vlan_id |
нет | Идентификатор VLAN. |
||
| vlan_range |
нет | Диапазон VLAN, например, 2-10 или 2,5,10-15 и т.д. |
||
| vlan_state |
нет | активно |
|
Управление операционным состоянием VLAN (эквивалентно команде state {active | suspend}). |
Примеры
- name: Ensure a range of VLANs are not present on the switch
nxos_vlan:
vlan_range: "2-10,20,50,55-60,100-150"
state: absent
transport: nxapi
- name: Ensure VLAN 50 exists with the name WEB and is in the shutdown state
nxos_vlan:
vlan_id: 50
admin_state: down
name: WEB
transport: nxapi
- name: Ensure VLAN is NOT on the device
nxos_vlan:
vlan_id: 50
state: absent
transport: nxapi
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| Имя | Описание | Возвращается | Тип | Пример |
|---|---|---|---|---|
| commands | Набор строк команд для отправки на удалённое устройство |
всегда | список | ['vlan 20', 'vlan 55', 'vn-segment 5000'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.
Для получения помощи в разработке модулей, если у вас есть такое желание, прочитайте Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_vlan_module.html
