Spec-Zone.ru › Ansible 2.11

cisco.nxos.nxos_vlan – (deprecated, removed after 2022-06-01) Управляет ресурсами и атрибутами VLAN.

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в playbook, укажите: cisco.nxos.nxos_vlan.

Добавлено в версии 1.0.0: of cisco.nxos

  • УСТЕРЕЛО
  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТЕРЕЛО

Удалили в

основной версии после 2022-06-01

Почему

Выпущены обновленные модули с большей функциональностью

Альтернатива

nxos_vlans

Описание

  • Управляет конфигурацией VLAN на коммутаторах NX-OS.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
admin_state
строка
    Варианты:
  • вкл ←
  • выкл
Управление административным состоянием VLAN, эквивалентно команде shut/no shut в режиме конфигурации VLAN.
aggregate
список / элементы=словарь
Список определений VLAN.
admin_state
строка
    Варианты:
  • вкл
  • выкл
Управление административным состоянием VLAN, эквивалентно команде shut/no shut в режиме конфигурации VLAN.
associated_interfaces
список / элементы=строка
Это параметр намерения и проверяет операционное состояние заданной VLAN name для связанных интерфейсов. Если значение в associated_interfaces не соответствует операционному состоянию интерфейсов VLAN на устройстве, это приведет к ошибке.
delay
целое число
Время в секундах ожидания перед проверкой операционного состояния на удаленном устройстве. Это ожидание применимо для аргументов операционного состояния.
interfaces
список / элементы=строка
Список интерфейсов, которые должны быть связаны с VLAN или ключевое слово 'default'.
mapped_vni
строка
Идентификатор виртуальной сети (VNI), сопоставленный с VLAN. Допустимые значения — целое число и ключевое слово 'default'. Диапазон 4096-16773119.
mode
строка
    Варианты:
  • ce
  • fabricpath
Устанавливает режим VLAN на классический Ethernet или fabricpath. Этот параметр валиден для серий Nexus 5000 и 7000.
name
строка
Имя VLAN или ключевое слово 'default'.
state
строка
    Варианты:
  • present
  • absent
Управление состоянием ресурса.
vlan_id
целое число / обязательно
Единственный идентификатор VLAN.
vlan_range
строка
Диапазон VLAN, например, 2-10 или 2,5,10-15 и т. д.
vlan_state
строка
    Варианты:
  • active
  • suspend
Управление операционным состоянием VLAN
associated_interfaces
список / элементы=строка
Это параметр намерения и проверяет операционное состояние заданной VLAN name для связанных интерфейсов. Если значение в associated_interfaces не соответствует операционному состоянию интерфейсов VLAN на устройстве, это приведет к ошибке.
delay
целое число
По умолчанию:
10
Время в секундах ожидания перед проверкой операционного состояния на удаленном устройстве. Это ожидание применимо для аргументов операционного состояния.
interfaces
список / элементы=строка
Список интерфейсов, которые должны быть связаны с VLAN или ключевое слово 'default'.
mapped_vni
строка
Идентификатор виртуальной сети (VNI), сопоставленный с VLAN. Допустимые значения — целое число и ключевое слово 'default'. Диапазон 4096-16773119.
mode
строка
    Варианты:
  • ce ←
  • fabricpath
Устанавливает режим VLAN на классический Ethernet или fabricpath. Этот параметр валиден для серий Nexus 5000 и 7000.
name
строка
Имя VLAN или ключевое слово 'default'.
provider
словарь
Устаревший
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Начиная с Ansible 2.6, для NX-API рекомендуется использовать connection: httpapi.
Этот параметр будет удален в релизе после 2022-06-01.
Дополнительную информацию см. в руководстве NXOS Platform Options.
Объект словаря, содержащий данные подключения.
auth_pass
строка
Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
булево
    Варианты:
  • нет ←
  • да
Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
host
строка
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
целое число
Указывает порт для создания подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту для транспорта, если он не указан в задаче (cli=22, http=80, https=443).
ssh_keyfile
строка
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.).
transport
строка
    Варианты:
  • cli ←
  • nxapi
Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
use_proxy
булево
    Варианты:
  • нет
  • да ←
Если 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 запрещено и будет проигнорировано.
state
строка
    Варианты:
  • present ←
  • absent
Управление состоянием ресурса.
vlan_id
целое число
Единственный идентификатор VLAN.
vlan_range
строка
Диапазон VLAN, например, 2-10 или 2,5,10-15 и т. д.
vlan_state
string
    Choices:
  • active ←
  • suspend
Управление рабочим состоянием VLAN

Примечания

Примечание

  • Справочную информацию по использованию CLI и NX-API см. в руководстве NXOS Platform Options
  • Дополнительную информацию по использованию Ansible для управления сетевыми устройствами см. в руководстве Сетевое руководство Ansible
  • Дополнительную информацию по использованию Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.

Примеры

- name: Ensure a range of VLANs are not present on the switch
  cisco.nxos.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
  cisco.nxos.nxos_vlan:
    vlan_id: 50
    admin_state: down
    name: WEB

- name: Ensure VLAN is NOT on the device
  cisco.nxos.nxos_vlan:
    vlan_id: 50
    state: absent

- name: Add interfaces to VLAN and check intent (config + intent)
  cisco.nxos.nxos_vlan:
    vlan_id: 100
    interfaces:
    - Ethernet2/1
    - Ethernet2/5
    associated_interfaces:
    - Ethernet2/1
    - Ethernet2/5

- name: Check interfaces assigned to VLAN
  cisco.nxos.nxos_vlan:
    vlan_id: 100
    associated_interfaces:
    - Ethernet2/1
    - Ethernet2/5

- name: Create aggregate of vlans
  cisco.nxos.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)
  cisco.nxos.nxos_vlan:
    aggregate:
    - vlan_id: 1
    - vlan_id: 4001
    purge: yes

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:

Ключ Возвращаемое значение Описание
commands
list / elements=string
всегда
Набор строк команд для отправки на удалённое устройство

Пример:
['vlan 20', 'vlan 55', 'vn-segment 5000']


Статус

  • Этот модуль будет удалён в основной версии после 2022-06-01. [устаревший]
  • Дополнительную информацию см. в УСТАРЕВШИЙ.

Авторы

  • Jason Edelman (@jedelman8)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_vlan_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API