nxos_vlan — Управление ресурсами и атрибутами VLAN.
Новая в версии 2.1.
Описание
- Управление конфигурациями VLAN на коммутаторах NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_state |
| Управление административным состоянием VLAN, аналогично командам shut/no shut в режиме конфигурации VLAN. | |
| aggregate (добавлен в 2.5) | Список определений VLAN. | ||
| associated_interfaces (добавлен в 2.5) | Это опция намерения и проверяет рабочее состояние для заданной vlan name для ассоциированных интерфейсов. Если значение в associated_interfaces не совпадает с рабочим состоянием интерфейсов vlan на устройстве, это приведет к ошибке. | ||
| delay | Значение по умолчанию: 10 | Время в секундах ожидания проверки рабочего состояния на удаленном устройстве. Это ожидание применимо для аргументов рабочего состояния. | |
| interfaces (добавлен в 2.5) | Список интерфейсов, которые должны быть связаны с VLAN или ключевое слово 'default'. | ||
| mapped_vni (добавлен в 2.2) | Идентификатор виртуальной сети (VNI), который сопоставлен с VLAN. Допустимые значения — целые числа и ключевое слово 'default'. Диапазон 4096-16773119. | ||
| mode (добавлен в 2.4) |
| Установить режим VLAN на классический Ethernet или fabricpath. Это допустимая опция для Nexus 5000 и 7000 серии. | |
| name | Имя VLAN или ключевое слово 'default'. | ||
| provider | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Эта опция необходима только если используется NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя или адрес хоста DNS для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует соответствующему общему порту транспорта, если не указан в задании. (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для cli или nxapi транспортов. Если значение не указано в задании, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлен в 2.5.3) |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлен в 2.5.3) | Значение по умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize false, этот аргумент ничего не делает. Если значение не указано в задании, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлен в 2.3) | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | Значение по умолчанию: "cli" | Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport на использование SSL, если значение true, только если transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверенных сертификатов. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлен в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| purge bool |
| Удаляет VLAN, не определенные в параметре aggregate. Этот параметр также можно использовать без aggregate. | |
| state |
| Управление состоянием ресурса. | |
| vlan_id | Единственный идентификатор VLAN. | ||
| vlan_range | Диапазон VLAN, например, 2-10 или 2,5,10-15 и т. д. | ||
| vlan_state |
| Управление рабочим состоянием VLAN. | |
Примечания
Примечание
- Подробности использования CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- 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
- 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
- name: Ensure VLAN is NOT on the device
nxos_vlan:
vlan_id: 50
state: absent
- name: Add interfaces to VLAN and check intent (config + intent)
nxos_vlan:
vlan_id: 100
interfaces:
- Ethernet2/1
- Ethernet2/5
associated_interfaces:
- Ethernet2/1
- Ethernet2/5
- name: Check interfaces assigned to VLAN
nxos_vlan:
vlan_id: 100
associated_interfaces:
- Ethernet2/1
- Ethernet2/5
- name: Create aggregate of vlans
nxos_vlan:
aggregate:
- { vlan_id: 4000, mode: ce }
- { vlan_id: 4001, name: vlan-4001 }
- name: purge vlans - removes all other vlans except the ones mentioned in aggregate)
nxos_vlan:
aggregate:
- vlan_id: 1
- vlan_id: 4001
purge: yes
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list | всегда | Набор строк команд для отправки на удалённое устройство Пример: ['vlan 20', 'vlan 55', 'vn-segment 5000'] |
Состояние
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его обслуживает команда Ansible по сетям. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, обслуживаемых командой Ansible по сетям, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний
Автор
- Jason Edelman (@jedelman8)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/nxos_vlan_module.html