Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

Для использования в playbook укажите: cisco.nxos.nxos_vrf_interface.

Новое в версии 1.0.0: of 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_vrf_interface_module.html

Spec-Zone.ru

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