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

Примечание

Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в playbook, укажите: cisco.nxos.nxos_pim_interface.

Новое в версии 1.0.0: модуля cisco.nxos

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

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bfd строка		Варианты: 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 строка		Варианты: prefix routemap	Тип политики, назначенной для `jp_policy_in`.
jp_type_out строка		Варианты: prefix routemap	Тип политики, назначенной для `jp_policy_out`.
neighbor_policy строка			Настройка политики соседей для фильтрации смежностей.
neighbor_type строка		Варианты: prefix routemap	Тип политики, назначенной для neighbor_policy.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удален в версии после 2022-06-01. Дополнительная информация в руководстве NXOS Platform Options. Объект словаря, содержащий детали подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному каналу передачи. Значение host используется в качестве адреса назначения для канала передачи.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для каналов передачи cli или nxapi. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для построения подключения к удалённому устройству. Это значение применимо к каналам передачи cli или nxapi. Значение порта по умолчанию устанавливается для соответствующего общего порта канала передачи, если не указано в задаче. (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для канала передачи cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль возвращает ошибку. NX-API может медленно возвращать результат при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport строка	Варианты: cli ← nxapi	Настраивает канал передачи для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi.
	use_proxy логическое значение	Варианты: нет да ←	Если `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 ← absent 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.

Примеры

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

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

- name: Ensure join-prune policies exist
  cisco.nxos.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
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    bfd: disable

- name: Ensure defaults are in place
  cisco.nxos.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']

Авторы

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.10/collections/cisco/nxos/nxos_pim_interface_module.html