Spec-Zone.ru › Ansible 2.9

nxos_vrf – Управляет глобальной конфигурацией VRF

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Этот модуль предоставляет декларативное управление VRF на сетевых устройствах CISCO NXOS.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
admin_state
-
    Варианты:
  • up ←
  • down
Административное состояние VRF.
aggregate
-
добавлен в 2.5
Список определений VRF.
associated_interfaces
-
добавлен в 2.5
Это опция намерения и проверяет операционное состояние для заданного vrf name для связанных интерфейсов. Если значение в associated_interfaces не соответствует операционному состоянию интерфейсов vrf на устройстве, это приведет к ошибке.
delay
-
Значение по умолчанию:
10
Время в секундах ожидания проверки операционного состояния на удалённом устройстве. Это ожидание применимо к параметрам операционного состояния.
description
-
Описание VRF или ключевое слово 'default'.
interfaces
-
добавлен в 2.5
Список интерфейсов для проверки правильной конфигурации VRF или ключевое слово 'default'.
name
- / обязательно
Имя управляемого VRF.

псевдонимы: vrf
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
    Варианты:
  • no ←
  • yes
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE.
host
строка / обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве целевого адреса для транспорта.
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
строка / обязательно
    Варианты:
  • cli ←
  • nxapi
Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
use_proxy
логическое
добавлен в 2.5
    Варианты:
  • no
  • yes ←
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы.
use_ssl
логическое
    Варианты:
  • no ←
  • yes
Настраивает transport на использование SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется.
username
строка
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME.
validate_certs
логическое
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверяющие сертификаты. Если аргумент transport не является nxapi, это значение игнорируется.
purge
логическое
добавлен в 2.5
    Варианты:
  • no ←
  • yes
Удаляет VRF, не определённые в параметре aggregate.
rd
-
VPN Route Distinguisher (RD). Допустимые значения — строка в одном из форматов разделителя маршрутов (ASN2:NN, ASN4:NN или IPV4:NN); ключевое слово 'auto' или ключевое слово 'default'.
state
-
    Варианты:
  • present ←
  • absent
Управление желаемым состоянием ресурса.
vni
-
Укажите идентификатор виртуальной сети. Допустимые значения — целое число или ключевое слово 'default'.

Примечания

Примечание

  • Проверено на NXOSv 7.3.(0)D1(1) на VIRL
  • Cisco NX-OS создаёт VRF по умолчанию самостоятельно. Поэтому, в этом модуле недопустимо использовать default в качестве имени vrf.
  • vrf имя должно быть короче 32 символов.
  • В NX-OS имена VRF не чувствительны к регистру. Тем не менее, имя сохраняется так, как его ввёл пользователь, и не будет изменено, пока VRF не будет удалена и повторно создана. Например, vrf=ntc создаст VRF с именем NTC, но повторное выполнение с vrf=ntc не вызовет изменений в конфигурации.
  • Для получения информации об использовании CLI и NX-API см. Руководство по параметрам платформы NXOS
  • Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible
  • Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco на сайте.

Примеры

- name: Ensure ntc VRF exists on switch
  nxos_vrf:
    name: ntc
    description: testing
    state: present

- name: Aggregate definition of VRFs
  nxos_vrf:
    aggregate:
      - { name: test1, description: Testing, admin_state: down }
      - { name: test2, interfaces: Ethernet1/2 }

- name: Aggregate definitions of VRFs with Purge
  nxos_vrf:
    aggregate:
      - { name: ntc1, description: purge test1 }
      - { name: ntc2, description: purge test2 }
    state: present
    purge: yes

- name: Delete VRFs exist on switch
  nxos_vrf:
    aggregate:
      - { name: ntc1 }
      - { name: ntc2 }
    state: absent

- name: Assign interfaces to VRF declaratively
  nxos_vrf:
    name: test1
    interfaces:
      - Ethernet2/3
      - Ethernet2/5

- name: Check interfaces assigned to VRF
  nxos_vrf:
    name: test1
    associated_interfaces:
      - Ethernet2/3
      - Ethernet2/5

- name: Ensure VRF is tagged with interface Ethernet2/5 only (Removes from Ethernet2/3)
  nxos_vrf:
    name: test1
    interfaces:
      - Ethernet2/5

- name: Delete VRF
  nxos_vrf:
    name: ntc
    state: absent

Значения возврата

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

Ключ Возвращаемое значение Описание
commands
список
всегда
команды, отправленные на устройство

Пример:
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']


Статус

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

Поддержка Red Hat

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

Авторы

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)
  • Trishna Guha (@trishnaguha)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете изменить его, чтобы улучшить его.

© 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_vrf_module.html

Spec-Zone.ru

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