nxos_pim – Управляет конфигурацией экземпляра PIM
Обзор
- Управляет конфигурацией экземпляра Протокола независимого многоадресного вещания (PIM).
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bfd строка добавлено в 2.9 |
| Включает BFD на всех интерфейсах PIM. Зависимость: 'feature bfd' | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект dict, содержащий данные подключения. | ||
| 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 целое число | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результат при длительных командах (sh mac, sh bgp и т.д.). | |
| transport строка / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. Параметр transport поддерживает подключение к устройству по протоколу cli (ssh) или nxapi. | |
| use_proxy логический тип добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логический тип |
| Настраивает transport для использования SSL, если значение равно yes, только когда transport=nxapi, иначе это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi, в зависимости от используемого канала связи. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs логический тип |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Если параметр transport не является nxapi, это значение игнорируется. | |
| ssm_range - / обязательно | Настройте диапазоны групп для источникозависимого многоадресного вещания (SSM). Допустимые значения - многоадресные адреса или ключевые слова 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, enable bfd
nxos_pim:
bfd: enable
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 bfd', '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.9/modules/nxos_pim_module.html
