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

Новая версия с 2.2.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Поддержка
- Автор

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
border		Варианты: true false Значение по умолчанию: no	Настраивает интерфейс как границу домена PIM.
dr_prio			Настраивает приоритет для выбора PIM DR на интерфейсе.
hello_auth_key		Значение по умолчанию: None	Аутентификация для hellos на этом интерфейсе.
hello_interval		Варианты: true false Значение по умолчанию: None	Интервал hello в миллисекундах для этого интерфейса.
interface обязательно			Полное имя интерфейса, например Ethernet1/33.
jp_policy_in		Значение по умолчанию: None	Политика для сообщений join-prune (входящие).
jp_policy_out обязательно		Значение по умолчанию: None	Политика для сообщений join-prune (исходящие).
jp_type_in		Варианты: prefix routemap Значение по умолчанию: None	Тип политики, сопоставленной с `jp_policy_in`.
jp_type_out		Варианты: prefix routemap Значение по умолчанию: None	Тип политики, сопоставленной с `jp_policy_out`.
neighbor_policy		Значение по умолчанию: None	Настраивает политику соседа для фильтрации смежностей.
neighbor_type		Варианты: prefix routemap Значение по умолчанию: None	Тип политики, сопоставленной с neighbor_policy.
provider		Значение по умолчанию: None	Устарело Начиная с Ansible 2.5, рекомендуем использовать `connection: network_cli`. Этот параметр нужен только при использовании NX-API. Подробнее см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	authorize (добавлено в 2.5.3)	Варианты: no ← yes	Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задании, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	use_proxy (добавлено в 2.5)	Варианты: yes ← no	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	auth_pass (добавлено в 2.5.3)	Значение по умолчанию: none	Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize — false, то этот параметр не работает. Если значение не указано в задании, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	host обязательно		Указывает имя DNS-хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
	timeout (добавлено в 2.3)	Значение по умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт, прежде чем операция будет завершена, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
	use_ssl	Варианты: yes no ←	Настраивает transport на использование SSL, если значение true только когда `transport=nxapi`, в противном случае это значение игнорируется.
	password	Значение по умолчанию: None	Указывает пароль для аутентификации подключения к удалённому устройству. Это распространённый параметр, используемый для транспортов cli или nxapi. Если значение не указано в задании, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	validate_certs	Варианты: yes no Значение по умолчанию: None	Если `no`, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых сайтах, использующих самозаверенные сертификаты. Если параметр transport не nxapi, это значение игнорируется.
	port	Значение по умолчанию: 0 (использование общего порта)	Указывает порт для подключения к удалённому устройству. Это значение применимо к cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту транспорта, если не указано в задании (cli=22, http=80, https=443).
	transport обязательно	Значение по умолчанию: cli	Настраивает транспортное подключение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi.
sparse		Варианты: true false Значение по умолчанию: no	Включение/выключение 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 Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

# ensure PIM is not running on the interface
- nxos_pim_interface:
    interface: eth1/33
    state: absent

# 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

# 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

# ensure defaults are in place
- nxos_pim_interface:
    interface: eth1/33
    state: default

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

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

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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Поддержка

Дополнительную информацию о поддержке этого модуля 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.5/modules/nxos_pim_interface_module.html