nxos_pim – Управляет конфигурацией экземпляра PIM.
Новая версия 2.2.
Обзор
- Управляет конфигурацией экземпляра протокола независимого мультивещания (PIM).
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| provider - | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект dict, содержащий данные подключения. | ||
| auth_pass - добавлен в 2.5.3 | Значение по умолчанию: "none" | Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот параметр не имеет никакого эффекта. Если значение не указано в задаче, то будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize boolean добавлен в 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 - / обязательно | Значение по умолчанию: "cli" | Настраивает транспортное подключение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если значение true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, то будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на управляемых сайтах, использующих самозаверяющие сертификаты. Если параметр transport не равен nxapi, это значение игнорируется. | |
| ssm_range - / обязательно | Настроить диапазоны групп для мультивещания с учётом источника (SSM). Допустимые значения — multicast-адреса или ключевые слова none или default. none удаляет все диапазоны групп SSM. default установит ssm_range на значение по умолчанию multicast-адреса. Если вы задаёте multicast-адрес, убедитесь, что он не совпадает с 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 Team. [сеть]
Поддержка 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.7/modules/nxos_pim_module.html
