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

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

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

Описание

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

Параметры

параметр	обязателен	по умолчанию	значения	комментарии
auth_pass (добавлено в 2.4.4)	нет	нет		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
authorize (добавлено в 2.4.4)	нет		да нет	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
border	нет		истина ложь	Настраивает интерфейс как границу домена PIM.
hello_auth_key	нет			Аутентификация для hello на этом интерфейсе.
hello_interval	нет		истина ложь	Интервал hello в миллисекундах для этого интерфейса.
host	да			Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется как адрес назначения для протокола.
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.
password	нет			Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для протоколов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
port	нет	0 (использовать стандартный порт)		Указывает порт для подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту протокола, если он не указан в задаче. (cli=22, http=80, https=443).
provider	нет			Удобный метод, позволяющий передавать все аргументы nxos как объект словаря. Все ограничения (обязательность, варианты и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре.
sparse	нет	Истина	истина ложь	Включение/выключение разреженного режима на интерфейсе.
ssh_keyfile	нет			Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для протокола cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
state	нет	наличие	наличие значение по умолчанию	Управляет желаемым состоянием ресурса.
timeout (добавлено в 2.3)	нет	10		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.).
transport	да	cli		Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
use_ssl	нет		да нет	Настраивает transport для использования SSL, если установлено значение true только тогда, когда `transport=nxapi`, в противном случае это значение игнорируется.
username	нет			Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
validate_certs	нет		да нет	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с использованием самозаверенных сертификатов. Если аргумент transport не является nxapi, это значение игнорируется.

Примеры

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

Примечания

Примечание

Проверено на 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.

Статус

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

Информация о техническом обслуживании

Для получения дополнительной информации о поддержке данного модуля компанией Red Hat, обратитесь к knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.

Для помощи в разработке модулей, если вы так хотите, пожалуйста, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.

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