cisco.nxos.nxos_pim – Управление конфигурацией экземпляра PIM.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_pim.
Новое в версии 1.0.0: модуля cisco.nxos
Обзор
- Управление конфигурацией экземпляра протокола независимого многоадресного вещания (PIM).
Примечание
Для этого модуля существует соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bfd строка |
| Включает BFD на всех интерфейсах PIM. Зависимость: ''feature bfd'' | |
| provider словарь | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6 рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удалён в версии после 2022-06-01. Для получения дополнительной информации, пожалуйста, обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логический тип |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Если значение порта не указано в задаче, используется соответствующий стандартный порт для транспорта (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.). | ||
| transport строка |
| Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логический тип |
| Если 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
cisco.nxos.nxos_pim:
bfd: enable
ssm_range: 224.0.0.0/8
- name: Set to default
cisco.nxos.nxos_pim:
ssm_range: default
- name: Remove all ssm group ranges
cisco.nxos.nxos_pim:
ssm_range: none
Возвращаемые значения
Общие значения возвращаемых данных описаны в данном месте, а следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Команды, отправленные устройству Пример: ['ip pim bfd', 'ip pim ssm range 224.0.0.0/8'] |
Авторы
- 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.10/collections/cisco/nxos/nxos_pim_module.html
