Spec-Zone.ru › Ansible 2.7

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

Примечания

Примечание

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

Примеры

- 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']


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается командой Ansible Network Ansible Network Team. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля Red Hat см. в статье из базы знаний Red Hat Red Hat Knowledge Base article.

Авторы

  • 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.7/modules/nxos_vlan_module.html

Spec-Zone.ru

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