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 NXOS Platform Options. Объект словаря с параметрами подключения. | ||
| auth_pass - добавлен в 2.5.3 | По умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize boolean добавлен в 2.5.3 |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| 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" | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем, использующих самозаверяющие сертификаты. Если транспорт не nxapi, это значение игнорируется. | |
| purge boolean добавлен в 2.5 |
| Удаляет VRF, не определённые в параметре aggregate. | |
| rd - добавлен в 2.2 | VPN Route Distinguisher (RD). Допустимые значения — строка в одном из форматов route-distinguisher (ASN2:NN, ASN4:NN или IPV4:NN); ключевое слово 'auto' или ключевое слово 'default'. | ||
| state - |
| Управляет желаемым состоянием ресурса. | |
| vni - добавлен в 2.2 | Укажите идентификатор виртуальной сети. Допустимые значения — целое число или ключевое слово 'default'. | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Cisco NX-OS создаёт по умолчанию VRF самостоятельно. Поэтому вам запрещено использовать vrf имя default в этом модуле.
-
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 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. [сеть]
Поддержка 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.7/modules/nxos_vrf_module.html