Spec-Zone.ru › Ansible 2.5

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 По умолчанию:
None
Описание VRF или ключевое слово 'default'.
interfaces
(добавлено в 2.5)
Список интерфейсов для проверки правильности конфигурации VRF или ключевое слово 'default'.
name
обязательно
Имя VRF, подлежащее управлению.

псевдонимы: vrf
provider По умолчанию:
None
Устаревший
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр необходим только при использовании NX-API.
Для получения дополнительной информации см. руководство NXOS Platform Options.
Объект словаря, содержащий сведения о подключении.
username
Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации 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
(добавлено в 2.5)
По умолчанию:
no
Удалить VRF, не определенные в параметре aggregate.
rd
(добавлено в 2.2)
По умолчанию:
None
Различитель маршрута VPN (RD). Допустимые значения — строка в одном из форматов различителя маршрута (ASN2:NN, ASN4:NN или IPV4:NN); ключевое слово 'auto' или ключевое слово 'default'.
state
    Варианты:
  • present ←
  • absent
Управляет желаемым состоянием ресурса.
vni
(добавлено в 2.2)
По умолчанию:
None
Указывает идентификатор виртуальной сети. Допустимые значения — целое число или ключевое слово '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
list
всегда
Команды, отправленные устройству

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


Статус

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

Поддержка

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

Spec-Zone.ru

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