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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
border boolean		Варианты: no ← yes	Настраивает интерфейс как границу домена PIM.
dr_prio -			Настраивает приоритет для выбора PIM DR на интерфейсе.
hello_auth_key -			Авторизация для hellos на этом интерфейсе.
hello_interval boolean		Варианты: no yes	Интервал 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	По умолчанию: "none"	Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот параметр ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлено в 2.5.3	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `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 yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl boolean	Варианты: no ← yes	Настраивает транспорт transport на использование SSL, если установлено в true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username -		Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Если параметр transport не равен nxapi, это значение игнорируется.
sparse boolean		Варианты: no ← yes	Включить/отключить режим 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.
Дополнительную информацию об использовании командной строки и NX-API см. в руководстве NXOS Platform Options.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.

Примеры

# 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']

Статус

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

Поддержка Red Hat

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

Авторы

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.7/modules/nxos_pim_interface_module.html