nxos_vrf – Управляет глобальной конфигурацией VRF
Новая в версии 2.1.
Описание
- Этот модуль обеспечивает декларативное управление VRF на устройствах сети CISCO NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_state - |
| Административное состояние 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 равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое добавлено в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды 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 целое число добавлено в 2.3 | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернет ошибку. NX-API может медленно отвечать при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport строка / обязательно |
| Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент транспорта поддерживает подключение к устройству по протоколу cli (ssh) или nxapi. | |
| use_proxy логическое добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| use_ssl логическое |
| Настраивает transport для использования SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого типа транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых сайтах с использованием самозаверяемых сертификатов. Если аргумент транспорта не nxapi, это значение игнорируется. | |
| purge логическое добавлено в 2.5 |
| Удалить VRF, не определенные в параметре aggregate. | |
| rd - добавлено в 2.2 | VPN Route Distinguisher (RD). Допустимые значения — строка в одном из форматов идентификатора маршрутизации (ASN2:NN, ASN4:NN или IPV4:NN); ключевое слово 'auto' или ключевое слово 'default'. | ||
| state - |
| Управляет желаемым состоянием ресурса. | |
| 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
- Дополнительную информацию об использовании 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 по сетям. [сеть]
Поддержка 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.8/modules/nxos_vrf_module.html