nxos_pim — Управляет конфигурацией экземпляра PIM.
Новая версия 2.2.
Описание
- Управляет конфигурацией экземпляра Протокола независимого мультивещания (PIM).
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| provider | По умолчанию: Нет | Устаревший Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации, пожалуйста, обратитесь к руководству NXOS Platform Options. Объект dict, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| authorize (добавлено в 2.5.3) |
| Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлено в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| auth_pass (добавлено в 2.5.3) | По умолчанию: нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равен false, этот аргумент ничего не делает. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя DNS-хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout (добавлено в 2.3) | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т.д.). | |
| use_ssl |
| Настраивает транспорт на использование SSL, если установлено в true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| password | По умолчанию: Нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | |
| validate_certs |
Нет | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем с использованием самозаверяемых сертификатов. Если аргумент транспорта не nxapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта будет по умолчанию соответствовать стандартному порту транспорта, если оно не предоставлено в задании. (cli=22, http=80, https=443). | |
| transport обязательно | Значение по умолчанию: cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| ssm_range обязательно | Настройка диапазонов групп для Source Specific Multicast (SSM). Допустимые значения — адреса мультикаста или ключевое слово none или ключевое слово default. none удаляет все диапазоны групп SSM. default установит ssm_range в значение по умолчанию — адрес мультикаста. Если вы задаёте адрес мультикаста, убедитесь, что он не совпадает с default, в противном случае используйте опцию default. | ||
Примечания
Примечание
- Дополнительная информация об использовании CLI и NX-API содержится в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
- name: Configure ssm_range
nxos_pim:
ssm_range: "224.0.0.0/8"
- name: Set to default
nxos_pim:
ssm_range: default
- name: Remove all ssm group ranges
nxos_pim:
ssm_range: none
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Команды, отправленные на устройство Пример: ['ip pim ssm range 224.0.0.0/8'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Поддержка
Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний
Автор
- 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.5/modules/nxos_pim_module.html
