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

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

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

Обзор

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

Параметры

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

Примеры

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

- name: 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

- name: 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

- name: 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']

Статус

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

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти в этой статье Базы знаний 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.8/modules/nxos_pim_interface_module.html