cisco.nxos.nxos_vrf – Управляет глобальной конфигурацией VRF.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_vrf.
Новое в версии 1.0.0: из cisco.nxos
Обзор
- Этот модуль обеспечивает декларативное управление VRF на сетевых устройствах CISCO NXOS.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_state строка |
| Административное состояние VRF. | |
| aggregate список / элементы=словарь | Список определений VRF. | ||
| admin_state строка |
| Административное состояние VRF. | |
| associated_interfaces список / элементы=строка | Это опция намерения и проверяет операционное состояние для заданного vrf name для связанных интерфейсов. Если значение в associated_interfaces не совпадает с операционным состоянием интерфейсов vrf на устройстве, это приведет к ошибке. | ||
| delay целое число | Время в секундах ожидания перед проверкой операционного состояния на удалённом устройстве. Это ожидание применимо к аргументам операционного состояния. | ||
| description строка | Описание VRF или ключевое слово 'default'. | ||
| interfaces список / элементы=строка | Список интерфейсов для проверки правильной конфигурации VRF или ключевое слово 'default'. | ||
| name строка | Имя VRF, подлежащее управлению. псевдонимы: vrf | ||
| rd строка | VPN Route Distinguisher (RD). Допустимые значения — строка в одном из форматов идентификатора маршрута (ASN2:NN, ASN4:NN или IPV4:NN); ключевое слово 'auto' или ключевое слово 'default'. | ||
| state строка |
| Управляет желаемым состоянием ресурса. | |
| vni строка | Укажите идентификатор виртуальной сети. Допустимые значения — целое число или ключевое слово 'default'. | ||
| associated_interfaces список / элементы=строка | Это опция намерения и проверяет операционное состояние для заданного vrf name для связанных интерфейсов. Если значение в associated_interfaces не совпадает с операционным состоянием интерфейсов vrf на устройстве, это приведет к ошибке. | ||
| delay целое число | Значение по умолчанию: 10 | Время в секундах ожидания перед проверкой операционного состояния на удалённом устройстве. Это ожидание применимо к аргументам операционного состояния. | |
| description строка | Описание VRF или ключевое слово 'default'. | ||
| interfaces список / элементы=строка | Список интерфейсов для проверки правильной конфигурации VRF или ключевое слово 'default'. | ||
| name строка | Имя VRF, подлежащее управлению. псевдонимы: vrf | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, для NX-API рекомендуется использовать connection: httpapi. Эта опция будет удалена в релизе после 2022-06-01. Для получения дополнительной информации обратитесь к руководству по платформам NXOS NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для использования, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не имеет действия. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт, используемый при создании подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует общему порту для соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно реагировать на длительные команды (sh mac, sh bgp и т.д.). | ||
| transport строка |
| Настраивает транспортное соединение, используемое при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое |
| Настраивает transport для использования SSL, если установлено yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверяющимися сертификатами. Если аргумент transport не является nxapi, это значение игнорируется. | |
| purge логическое |
| Удалить VRF, не определённые в параметре aggregate. | |
| rd строка | VPN Route Distinguisher (RD). Допустимые значения — строка в одном из форматов идентификатора маршрута (ASN2:NN, ASN4:NN или IPV4:NN); ключевое слово 'auto' или ключевое слово 'default'. | ||
| state строка |
| Управляет желаемым состоянием ресурса. | |
| vni строка | Укажите идентификатор виртуальной сети. Допустимые значения — целое число или ключевое слово 'default'. | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Cisco NX-OS создаёт по умолчанию VRF. Поэтому в этом модуле нельзя использовать имя vrf по умолчанию.
-
vrfимя должно быть короче 32 символов. - Имена VRF в NX-OS не чувствительны к регистру. Тем не менее, имя сохраняется так, как его ввёл пользователь, и не будет изменено, пока VRF не будет удалён и повторно создан. Например,
vrf=NTCсоздаст VRF с именем NTC, но повторное выполнение сvrf=ntcне вызовет изменений конфигурации. - Для получения информации об использовании CLI и NX-API см. Руководство по параметрам платформы NXOS
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco здесь.
Примеры
- name: Ensure ntc VRF exists on switch
cisco.nxos.nxos_vrf:
name: ntc
description: testing
state: present
- name: Aggregate definition of VRFs
cisco.nxos.nxos_vrf:
aggregate:
- {name: test1, description: Testing, admin_state: down}
- {name: test2, interfaces: Ethernet1/2}
- name: Aggregate definitions of VRFs with Purge
cisco.nxos.nxos_vrf:
aggregate:
- {name: ntc1, description: purge test1}
- {name: ntc2, description: purge test2}
state: present
purge: yes
- name: Delete VRFs exist on switch
cisco.nxos.nxos_vrf:
aggregate:
- {name: ntc1}
- {name: ntc2}
state: absent
- name: Assign interfaces to VRF declaratively
cisco.nxos.nxos_vrf:
name: test1
interfaces:
- Ethernet2/3
- Ethernet2/5
- name: Check interfaces assigned to VRF
cisco.nxos.nxos_vrf:
name: test1
associated_interfaces:
- Ethernet2/3
- Ethernet2/5
- name: Ensure VRF is tagged with interface Ethernet2/5 only (Removes from Ethernet2/3)
cisco.nxos.nxos_vrf:
name: test1
interfaces:
- Ethernet2/5
- name: Delete VRF
cisco.nxos.nxos_vrf:
name: ntc
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Команды, отправленные на устройство Пример: ['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2'] |
Авторы
- 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.10/collections/cisco/nxos/nxos_vrf_module.html