Spec-Zone.ru › Ansible 2.6

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

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

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

Обзор

  • Этот модуль предоставляет декларативное управление 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.
Объект словаря, содержащий сведения о подключении.
host
обязательно
Указывает имя или адрес хоста DNS для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
port Значение по умолчанию:
"0 (использовать общий порт)"
Указывает порт, который используется при построении подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию установлено на соответствующий общий порт транспорта, если он не задан в задаче (cli=22, http=80, https=443).
username
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME.
password
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для cli или nxapi транспорта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD.
authorize
bool

(добавлено в 2.5.3)
    Варианты:
  • нет ←
  • да
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, оно будет взято из переменной окружения ANSIBLE_NET_AUTHORIZE.
auth_pass
(добавлено в 2.5.3)
Значение по умолчанию:
"none"
Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это требуется. Если authorize — false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS.
timeout
(добавлено в 2.3)
Значение по умолчанию:
10
Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.).
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
transport
обязательно
Значение по умолчанию:
"cli"
Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
use_ssl
bool
    Варианты:
  • нет ←
  • да
Настраивает transport на использование SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется.
validate_certs
bool
    Варианты:
  • нет
  • да
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем, использующих самозаверяемые сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
use_proxy
bool

(добавлено в 2.5)
    Варианты:
  • нет
  • да ←
Если no, переменные среды http_proxy и https_proxy будут проигнорированы.
purge
bool

(добавлено в 2.5)
    Варианты:
  • нет ←
  • да
Очистка VRF, не определенных в параметре aggregate.
rd
(добавлено в 2.2)
VPN Route Distinguisher (RD). Допустимые значения — строка в одном из форматов идентификатора маршрута (ASN2:NN, ASN4:NN или IPV4:NN); ключевое слово 'auto' или 'default'.
state
    Варианты:
  • present ←
  • absent
Управление желаемым состоянием ресурса.
vni
(добавлено в 2.2)
Укажите идентификатор виртуальной сети. Допустимые значения — целое число или ключевое слово 'default'.

Примечания

Примечание

  • Проверено на NXOSv 7.3.(0)D1(1) на VIRL
  • Cisco NX-OS создает VRF по умолчанию самостоятельно. Поэтому нельзя использовать «default» в качестве имени vrf в этом модуле.
  • vrf имя должно быть короче 32 символов.
  • Имена VRF в NX-OS нечувствительны к регистру. Тем не менее, имя хранится так, как его ввел пользователь, и не будет изменено повторно, если VRF не удален и не создан заново. Например, vrf=NTC создаст VRF с именем NTC, но повторное его выполнение с vrf=ntc не вызовет изменения конфигурации.
  • Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
  • Дополнительную информацию об использовании 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 assigend 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 Team. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых командой Ansible Network Team, см. здесь.

Поддержка

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

Spec-Zone.ru

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