nxos_pim — Управление конфигурацией экземпляра PIM.
Новая версия 2.2.
Описание
- Управление конфигурацией экземпляра протокола независимого мультивещания (PIM).
Параметры
| параметр | обязательный | значение по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| auth_pass (добавлен в 2.4.4)
| нет | отсутствует | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize имеет значение false, этот аргумент не действует. Если значение не указано в задании, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задании, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию будет соответствовать стандартному порту транспорта, если не указано другое значение в задании (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, который позволяет передавать все аргументы nxos как объект словаря. Все ограничения (обязательность, допустимые значения и т. д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| ssm_range | да | Настройка диапазонов групп для протокола Source Specific Multicast (SSM). Допустимые значения — адреса мультивещания или ключевое слово 'none'. | ||
| 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, это значение игнорируется. |
Примеры
- nxos_pim:
ssm_range: "232.0.0.0/8"
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| commands | команды, отправленные устройству | всегда | список | ['ip pim ssm range 232.0.0.0/8'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией 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_module.html
