Spec-Zone.ru › Ansible 2.5

nxos_vlan — Управляет ресурсами и атрибутами VLAN.

Новое в версии 2.1.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Поддержка
    • Автор

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
admin_state
    Варианты:
  • up ←
  • down
Управляет административным состоянием 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)
По умолчанию:
None
Идентификатор виртуальной сети (VNI), сопоставленный с VLAN. Допустимые значения — целое число и ключевое слово 'default'. Диапазон 4096-16773119.
mode
(добавлено в 2.4)
    Варианты:
  • ce ←
  • fabricpath
Устанавливает режим VLAN на классический Ethernet или fabricpath. Это допустимый вариант для серий Nexus 5000 и 7000.
name По умолчанию:
null - Имя VLAN или ключевое слово 'default'.
Имя VLAN.
provider По умолчанию:
None
Устаревший
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр требуется только при использовании NX-API.
Для получения дополнительной информации см. руководство NXOS Platform Options.
Объект словаря, содержащий данные подключения.
username
Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
authorize
(добавлено в 2.5.3)
    Варианты:
  • no ←
  • yes
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
use_proxy
(добавлено в 2.5)
    Варианты:
  • yes ←
  • no
Если no, переменные среды http_proxy и https_proxy будут игнорироваться.
auth_pass
(добавлено в 2.5.3)
По умолчанию:
none
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если требуется. Если authorize — false, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
host
обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
timeout
(добавлено в 2.3)
По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т.д.).
use_ssl
    Варианты:
  • yes
  • no ←
Настраивает transport для использования SSL, если установлено true только когда transport=nxapi, иначе это значение игнорируется.
password По умолчанию:
None
Указывает пароль для аутентификации соединения с удалённым устройством. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
validate_certs
    Варианты:
  • yes
  • no
По умолчанию:
None
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах с самозаверенными сертификатами. Если аргумент transport не nxapi, это значение игнорируется.
port По умолчанию:
0 (используется общий порт)
Указывает порт для построения соединения с удалённым устройством. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует общему порту транспорта, если он не предоставлен в задаче (cli=22, http=80, https=443).
transport
обязательно
По умолчанию:
cli
Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
purge
    Варианты:
  • no ←
  • yes
Очистить VLAN, не определённые в параметре aggregate. Этот параметр также может использоваться без aggregate.
state
    Варианты:
  • present ←
  • absent
Управляет состоянием ресурса.
vlan_id По умолчанию:
None
Единственный идентификатор VLAN.
vlan_range По умолчанию:
None
Диапазон VLAN, например, 2-10 или 2,5,10-15 и т.д.
vlan_state
    Варианты:
  • active ←
  • suspend
Управляет операционным состоянием VLAN. Эта функция устаревает в пользу параметра state.

Примечания

Примечание

  • Информация об использовании 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
список
всегда
Набор строк команд, которые нужно отправить удалённому устройству

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


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости.

Поддержка

Для получения дополнительной информации о поддержке этого модуля 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.5/modules/nxos_vlan_module.html

Spec-Zone.ru

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