Модуль cisco.dnac.provision_intent – Модуль ресурсов для функций provisioning

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: cisco.dnac.provision_intent.

Новый в cisco.dnac 6.6.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Управление операциями, связанными с беспроводной и проводной установкой
API для повторной установки установленных устройств
API для удаления установленных устройств

Требования

Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.

dnacentersdk == 2.4.5
python >= 3.9

Параметры

Параметр	Комментарии
config список / элементы=словарь / обязательный	Список деталей управляемого устройства.
dynamic_interfaces список / элементы=словарь	Подробности интерфейсов контроллера
interface_gateway строка	IP-адрес, выделенный интерфейсу
interface_ip_address строка	IP-адрес, выделенный интерфейсу
interface_name строка	IP-адрес, выделенный интерфейсу
interface_netmask_in_c_i_d_r целое число	IP-адрес, выделенный интерфейсу
lag_or_port_number целое число	IP-адрес, выделенный интерфейсу
vlan_id целое число	IP-адрес, выделенный интерфейсу
managed_ap_locations список / элементы=строка	Расположение сайтов, выделенных для точек доступа.
management_ip_address строка / обязательный	IP-адрес управления.
site_name строка	Имя сайта, где необходимо добавить устройство.
config_verify логическое	Установите в значение True, чтобы проверить конфигурацию Cisco Catalyst Center после применения конфигурации playbook. Варианты: `false` ← (по умолчанию) `true`
dnac_api_task_timeout целое число	Определяет таймаут в секундах для вызовов API для получения деталей задачи. Если детали задачи не получены в течение этого периода, процесс завершится, и будет записано уведомление о таймауте. По умолчанию: `1200`
dnac_debug логическое	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательный	Имя хоста Cisco DNA Center.
dnac_log логическое	Флаг для включения/выключения ведения журнала выполнения playbook. Если True и dnac_log_file_path указан, - создаёт файл журнала в месте выполнения с указанным именем. Если True и dnac_log_file_path не указан, - создаёт файл журнала в месте выполнения с именем ‘dnac.log’. Если False, - ведение журнала отключено. Если файл журнала не существует, - он создаётся в режиме добавления или записи в зависимости от флага “dnac_log_append”. Если файл журнала существует, - он перезаписывается или дополняется в зависимости от флага “dnac_log_append”. Варианты: `false` ← (по умолчанию) `true`
dnac_log_append логическое	Определяет режим файла. Установите в значение True для режима «добавление». Установите в значение False для режима «запись». Варианты: `false` `true` ← (по умолчанию)
dnac_log_file_path строка	Управляет ведением журнала. Журналы записываются, если dnac_log равно True. Если путь не указан, - при ‘dnac_log_append’ = True, ‘dnac.log’ генерируется в текущем каталоге Ansible; журналы добавляются. - При ‘dnac_log_append’ = False, ‘dnac.log’ генерируется; журналы перезаписываются. Если путь указан, - при ‘dnac_log_append’ = True, файл открывается в режиме добавления. - При ‘dnac_log_append’ = False, файл открывается в режиме записи (w). - В сценариях с общими файлами, без режима добавления, содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала, установите append в False для первого модуля (чтобы перезаписать); для последующих модулей установите append в True. По умолчанию: `"dnac.log"`
dnac_log_level строка	Устанавливает порог уровня журнала. Сообщения с уровнем, равным или превышающим этот уровень, будут записаны в журнал. Уровни перечислены в порядке убывания важности [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL указывает серьезные ошибки, останавливающие программу. Отображаются только сообщения CRITICAL. ERROR указывает проблемы, препятствующие работе функции. Отображаются сообщения ERROR и CRITICAL. WARNING указывает потенциальные будущие проблемы. Отображаются сообщения WARNING, ERROR и CRITICAL. INFO отслеживает нормальную работу. Отображаются сообщения INFO, WARNING, ERROR и CRITICAL. DEBUG предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала. По умолчанию: `"WARNING"`

dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port string	Порт Cisco DNA Center. По умолчанию: `"443"`
dnac_task_poll_interval integer	Указывает интервал в секундах между последовательными вызовами API для получения подробностей о задаче. По умолчанию: `2`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки сертификата SSL. Выбор: `false` `true` ← (по умолчанию)
dnac_version string	Уведомляет SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: `"2.2.3.3"`
state string	Состояние DNAC после завершения модуля. Выбор: `"merged"` ← (по умолчанию) `"deleted"`
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, позволяющий включить проверку тел запросов по схеме JSON. Выбор: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: sites.Sites.get_site, devices.Devices.get_network_device_by_ip, task.Task.get_task_by_id, sda.Sda.get_provisioned_wired_device, sda.Sda.re_provision_wired_device, sda.Sda.provision_wired_device, wireless.Wireless.provision
Используемые пути: get /dna/intent/api/v1/site get /dna/intent/api/v1/network-device/ip-address/{ipAddress} get /dna/intent/api/v1/task/{taskId} get /dna/intent/api/v1/business/sda/provision-device put /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/wireless/provision
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

Примеры

- name: Create/Modify a new provision
  cisco.dnac.provision_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    state: merged
    config:
        - site_name: string
          management_ip_address: string
          managed_ap_locations: list
          dynamic_interfaces:
            - vlan_id: integer
              interface_name: string
              interface_ip_address: string
              interface_gateway: string
              interface_netmask_in_c_i_d_r: integer
              lag_or_port_number: integer

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Описание
response_1 словарь	Возвращается словарь с подробностями о подготовке. Возвращаемое значение: всегда Пример: `"{\n \"response\":\n {\n \"response\": String,\n \"version\": String\n },\n \"msg\": String\n}\n"`
response_2 список / элементы=строка	Список с ответом, возвращенным Cisco DNAC Python SDK. Возвращаемое значение: всегда Пример: `["{\n \"response\": []", "\n \"msg\": String\n}\n"]`
response_3 словарь	Словарь с существующими подробностями, возвращенными Cisco DNAC Python SDK. Возвращаемое значение: всегда Пример: `"{\n \"response\": String,\n \"msg\": String\n}\n"`

Авторы

Abinash Mishra (@abimishr)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/provision_intent_module.html