nxos_vlan – Управляет ресурсами и атрибутами VLAN
УСТЕРЕГЛО
| Удалено в Ansible: | |
|---|---|
| версия: 2.13 | |
| Почему: | Выпущены обновленные модули с большей функциональностью |
| Альтернатива: | nxos_vlans |
Синопсис
- Управляет конфигурациями 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 строка | Идентификатор Virtual Network Identifier (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. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка добавлено в 2.5.3 | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево добавлено в 2.5.3 |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка / требуется | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: "0 (использовать стандартный порт)" | Указывает порт для создания соединения с удалённым устройством. Это значение применимо к cli или nxapi. Если порт не указан в задаче, будет использован стандартный порт транспорта. (cli=22, http=80, https=443). | |
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Устанавливает таймаут в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport строка / требуется |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy булево добавлено в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl булево |
| Настраивает transport для использования SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это должно использоваться только на контролируемых локальных сайтах с самозаверяющими сертификатами. Если аргумент transport не nxapi, это значение игнорируется. | |
| purge булево |
| Удаляет VLAN, не определённые в параметре aggregate. Этот параметр также может быть использован без aggregate. Удаление VLAN 1 запрещено и будет проигнорировано параметром purge. | |
| state строка |
| Управление состоянием ресурса. | |
| vlan_id целое число | Идентификатор отдельной VLAN. | ||
| vlan_range строка | Диапазон VLAN, например, 2-10 или 2,5,10-15 и т.д. | ||
| vlan_state строка |
| Управление операционным состоянием VLAN. | |
Примечания
Примечание
- Сведения об использовании CLI и NX-API см. в руководстве по параметрам платформы NXOS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве по сети Ansible
- Дополнительную информацию об использовании 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 список | всегда | Набор строк команд для отправки на удаленное устройство Пример: ['vlan 20', 'vlan 55', 'vn-segment 5000'] |
Статус
- Этот модуль будет удален в версии 2.13. [устаревший]
- Дополнительную информацию см. в УСТАРЕВШИЙ.
Авторы
- 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.9/modules/nxos_vlan_module.html