nxos_pim_interface – Управляет конфигурацией интерфейса PIM

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Управляет настройками конфигурации интерфейса PIM.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bfd строка добавлено в 2.9		Варианты: enable disable default	Включает BFD для PIM на уровне интерфейса. Это переопределяет переменную bfd, заданную на глобальном уровне PIM. Допустимые значения: 'enable', 'disable' или 'default'. Зависимость: 'feature bfd'
border логическое значение		Варианты: нет ← да	Настраивает интерфейс как границу домена PIM.
dr_prio строка			Настраивает приоритет для выбора PIM DR на интерфейсе.
hello_auth_key строка			Аутентификация для hellos на этом интерфейсе.
hello_interval целое число			Интервал hello в миллисекундах для этого интерфейса.
interface строка / обязательно			Полное имя интерфейса, например Ethernet1/33.
jp_policy_in строка			Политика для сообщений join-prune (входящие).
jp_policy_out строка			Политика для сообщений join-prune (исходящие).
jp_type_in строка		Варианты: префикс routemap	Тип политики, сопоставленной с `jp_policy_in`.
jp_type_out строка		Варианты: префикс routemap	Тип политики, сопоставленной с `jp_policy_out`.
neighbor_policy строка			Настраивает политику для соседей для фильтрации смежностей.
neighbor_type строка		Варианты: префикс routemap	Тип политики, сопоставленной с neighbor_policy.
provider словарь			Устаревшее Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка добавлено в 2.5.3		Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение добавлено в 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 целое число	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport строка / обязательно	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент 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 не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Если аргумент transport не nxapi, это значение игнорируется.
sparse логическое значение		Варианты: нет ← да	Включение/выключение sparse-режима на интерфейсе.
state строка		Варианты: present ← default	Управляет желаемым состоянием ресурса.

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) на VIRL
Когда state=default, поддерживаемые параметры будут сброшены до значения по умолчанию. К ним относятся dr_prio, hello_auth_key, hello_interval, jp_policy_out, jp_policy_in, jp_type_in, jp_type_out, border, neighbor_policy, neighbor_type.
Параметр hello_auth_key не является идемпотентным.
hello_auth_key поддерживает только пароли в открытом виде.
Когда state=absent, конфигурация интерфейса pim будет сброшена на значения по умолчанию, а pim-sm будет отключен на интерфейсе.
Для использования этого модуля PIM должен быть включён на устройстве.
Этот модуль предназначен для интерфейсов уровня 3.
Для получения информации об использовании CLI и NX-API см. Руководство по параметрам платформы NXOS
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.

Примеры

- name: Ensure PIM is not running on the interface
  nxos_pim_interface:
    interface: eth1/33
    state: absent

- name: Ensure the interface has pim-sm enabled with the appropriate priority and hello interval
  nxos_pim_interface:
    interface: eth1/33
    dr_prio: 10
    hello_interval: 40
    state: present

- name: Ensure join-prune policies exist
  nxos_pim_interface:
    interface: eth1/33
    jp_policy_in: JPIN
    jp_policy_out: JPOUT
    jp_type_in: routemap
    jp_type_out: routemap

- name: disable bfd on the interface
  nxos_pim_interface:
    interface: eth1/33
    bfd: disable

- name: Ensure defaults are in place
  nxos_pim_interface:
    interface: eth1/33
    state: default

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

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

Ключ	Возвращаемое значение	Описание
commands список	всегда	Команда, отправленная устройству Пример: ['interface eth1/33', 'ip pim neighbor-policy test', 'ip pim bfd-instance disable', 'ip pim neighbor-policy test']

Статус

Гарантированный обратный совместимый интерфейс этого модуля отсутствует. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

Jason Edelman (@jedelman8)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/nxos_pim_interface_module.html