Spec-Zone.ru › Ansible 2.4

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

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

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Описание

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

Параметры

параметр обязателен значение по умолчанию варианты комментарии
admin_state
нет up
  • up
  • down
Административное состояние VRF.
auth_pass
(добавлен в 2.4.4)
нет none
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не действует. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
(добавлен в 2.4.4)
нет
  • yes
  • no
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
description
нет
Описание VRF.
host
да
Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
password
нет
Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
нет 0 (использовать стандартный порт)
Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту используемого транспорта, если не указано в задаче. (cli=22, http=80, https=443).
provider
нет
Удобный метод, позволяющий передавать все аргументы nxos в виде объекта dict. Все ограничения (обязательность, варианты и т. д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре.
route_distinguisher
(добавлен в 2.2)
нет
Дискриминатор VPN маршрутов (RD). Допустимые значения — строка в одном из форматов дискриминатора маршрутов (ASN2:NN, ASN4:NN или IPV4:NN), ключевое слово 'auto' или ключевое слово 'default'.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
state
нет present
  • present
  • absent
Управляет желаемым состоянием ресурса.
timeout
(добавлен в 2.3)
нет 10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.).
transport
да cli
Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
use_ssl
нет
  • yes
  • no
Настраивает транспорт transport на использование SSL, если значение true и transport=nxapi, иначе это значение игнорируется.
username
нет
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа по CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
validate_certs
нет
  • yes
  • no
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах, использующих самозаверяемые сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
vni
(добавлен в 2.2)
нет
Указывает идентификатор виртуальной сети. Допустимые значения — целое число или ключевое слово 'default'.
vrf
да
Имя VRF для управления.

Примеры

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

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

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

имя описание возвращается тип пример
commands
команды, отправленные устройству
всегда список ['vrf context ntc', 'shutdown']

Примечания

Примечание

  • Проверено на 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 не приведёт к изменению конфигурации.

Статус

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

Информация о техническом обслуживании

Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти по этой ссылке knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если вы заинтересованы, обратитесь к Информации сообщества и способах участия, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_vrf_module.html

Spec-Zone.ru

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