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

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

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

Описание

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

Параметры

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

Статус

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

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что его поддерживает Команда по сетевому обеспечению Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых Командой по сетевому обеспечению Ansible, см. здесь.

Поддержка

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