Spec-Zone.ru › Ansible 2.10

cisco.nxos.nxos_vrf_interface – Управляет конфигурацией VRF, специфичной для интерфейса.

Примечание

Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать его в книге задач, укажите: cisco.nxos.nxos_vrf_interface.

Новое в версии 1.0.0: cisco.nxos

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Управляет конфигурацией VRF, специфичной для интерфейса.

Примечание

Данный модуль имеет соответствующий плагин действий.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
interface
строка / обязательно
Полное имя интерфейса для управления, например, Ethernet1/1.
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli.
Начиная с Ansible 2.6, рекомендуем использовать connection: httpapi для NX-API.
Этот параметр будет удален в релизе после 2022-06-01.
Для получения дополнительной информации, пожалуйста, обратитесь к руководству 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
строка
    Варианты:
  • cli ←
  • nxapi
Настраивает транспортное подключение для использования при подключении к удаленному устройству. Аргумент 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, это значение игнорируется.
state
строка
    Варианты:
  • present ←
  • absent
Управляет желаемым состоянием ресурса.
vrf
строка / обязательно
Имя управляемой VRF.

Примечания

Примечание

  • Проверено на NXOSv 7.3.(0)D1(1) на VIRL
  • VRF необходимо добавить глобально с помощью cisco.nxos.nxos_vrf перед добавлением VRF к интерфейсу.
  • Удаление VRF из интерфейса по-прежнему удалит все атрибуты L3, как и при удалении через CLI.
  • VRF не считывается с интерфейса до тех пор, пока не будет настроен IP-адрес на этом интерфейсе.
  • Для получения информации об использовании CLI и NX-API, обратитесь к руководству NXOS Platform Options
  • Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, обратитесь к руководству Ansible Network Guide
  • Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco, посетите страницу интеграции Cisco.

Примеры

- name: Ensure vrf ntc exists on Eth1/1
  cisco.nxos.nxos_vrf_interface:
    vrf: ntc
    interface: Ethernet1/1
    state: present

- name: Ensure ntc VRF does not exist on Eth1/1
  cisco.nxos.nxos_vrf_interface:
    vrf: ntc
    interface: Ethernet1/1
    state: absent

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

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

Ключ Возвращаемое значение Описание
commands
список / элементы=строка
всегда
Команды, отправленные устройству

Пример:
['interface loopback16', 'vrf member ntc']


Авторы

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

© 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_interface_module.html

Spec-Zone.ru

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