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