cisco.nxos.nxos_pim_rp_address – Управляет конфигурацией экземпляра статического адреса RP PIM.
Примечание
Этот плагин является частью коллекции cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в playbook укажите: cisco.nxos.nxos_pim_rp_address.
Введено в версии 1.0.0: of cisco.nxos
Обзор
- Управляет конфигурацией экземпляра статического адреса точки сбора (RP) протокола независимого от маршрутизации многоадресной рассылки (PIM).
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bidir boolean |
| Диапазон групп обрабатывается в режиме двусторонней многоадресной рассылки PIM. | |
| group_list string | Диапазон групп для статического RP. Допустимые значения — многоадресные адреса. | ||
| prefix_list string | Политика списка префиксов для статического RP. Допустимые значения — имена политик списка префиксов. | ||
| provider dictionary | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удалён в релизе после 2022-06-01. Для получения дополнительной информации, пожалуйста, обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий детали соединения. | ||
| auth_pass string | Указывает пароль для использования при входе в привилегированный режим на удалённом устройстве. Если authorize равно false, этот параметр не имеет значения. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host string | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удалённому устройству. Этот параметр обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port integer | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если не указано в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т. д.). | ||
| transport string |
| Настраивает транспортное соединение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean |
| Если 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, это значение игнорируется. | |
| route_map string | Политика карты маршрутизации для статического RP. Допустимые значения — имена политик карты маршрутизации. | ||
| rp_address string / required | Настраивает адрес точки сбора (RP) протокола независимой многоадресной рассылки (PIM). Допустимые значения — одноадресные адреса. | ||
| state string |
| Указывает желаемое состояние ресурса. | |
Примечания
Примечание
- Тестировано на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentв настоящее время не поддерживается на всех платформах. - Для получения информации об использовании CLI и NX-API см. руководство NXOS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство по сети Ansible
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.
Примеры
- cisco.nxos.nxos_pim_rp_address:
rp_address: 10.1.1.20
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list / elements=string | всегда | Команды, отправленные устройству Пример: ['router bgp 65535', 'vrf test', 'router-id 192.0.2.1'] |
Авторы
- Gabriele Gerbino (@GGabriele)
© 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_rp_address_module.html