cisco.dnac.device_credential_intent модуль — Модуль ресурсов для глобальных учетных данных устройств и назначения учетных данных сайтам.

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.dnac.device_credential_intent.

Добавлена в cisco.dnac 6.7.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Управление операциями с глобальными учетными данными устройств и назначением учетных данных сайтам.
API для создания глобальных учетных данных устройств.
API для обновления глобальных учетных данных устройств.
API для удаления глобальных учетных данных устройств.
API для назначения учетных данных устройства сайту.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.9

Параметры

Параметр	Комментарии
config list / elements=dictionary / required	Список подробностей глобальных учетных данных устройства и имен сайтов.
assign_credentials_to_site dictionary	Назначить учетные данные устройства сайту.
cli_credential dictionary	Учетные данные CLI.
description string	Описание учетных данных CLI.
id string	Идентификатор учетных данных CLI. Используйте (Описание, Имя пользователя) или Идентификатор.
username string	Имя пользователя учетных данных CLI.
https_read dictionary	Учетные данные для чтения HTTP(S)
description string	Описание учетных данных для чтения HTTP(S).
id string	Идентификатор учетных данных для чтения HTTP(S). Используйте (Описание, Имя пользователя) или Идентификатор.
username string	Имя пользователя учетных данных для чтения HTTP(S).
https_write dictionary	Учетные данные для записи HTTP(S)
description string	Описание учетных данных для записи HTTP(S).
id string	Идентификатор учетных данных для записи HTTP(S). Используйте (Описание, Имя пользователя) или Идентификатор.
username string	Имя пользователя учетных данных для записи HTTP(S).
site_name list / elements=string	Имя сайта для назначения учетных данных.
snmp_v2c_read dictionary	Учетные данные для чтения SNMPv2c
description string	Описание учетных данных для чтения SNMPv2c.
id string	Идентификатор учетных данных для чтения SNMPv2c. Используйте Описание или Идентификатор.
snmp_v2c_write dictionary	Учетные данные для записи SNMPv2c
description string	Описание учетных данных для записи SNMPv2c.
id string	Идентификатор учетных данных для записи SNMPv2c. Используйте Описание или Идентификатор.
snmp_v3 dictionary	Учетные данные snmp_v3
description string	Описание учетных данных snmp_v3.
id string	Идентификатор учетных данных snmp_v3. Используйте Описание или Идентификатор.
global_credential_details dictionary	Управляет глобальными учетными данными устройства

cli_credential list / elements=dictionary	cliCredential глобальных учетных данных V2.
description string	Описание. Обязательно для создания учетных данных.
enable_password string	Пароль активации учетных данных cli_credential. Пароль не может содержать пробелы или угловые скобки (< >)
id string	Идентификатор учетных данных. Используйте это для обновления учетных данных устройства.
old_description string	Старое описание. Используйте это для обновления описания/имени пользователя.
old_username string	Старое имя пользователя. Используйте это для обновления описания/имени пользователя.
password string	Пароль учетных данных cli_credential. Обязательно для создания/обновления учетных данных. Пароль не может содержать пробелы или угловые скобки (< >).
username string	Имя пользователя учетных данных cli_credential. Имя пользователя не может содержать пробелы или угловые скобки (< >).
https_read list / elements=dictionary	httpsRead глобальных учетных данных V2.
id string	Идентификатор учетных данных. Используйте это для обновления учетных данных устройства.
name string	Имя. Обязательно для создания учетных данных.
old_description string	Старое описание. Используйте это для обновления описания/имени пользователя.
old_username string	Старое имя пользователя. Используйте это для обновления описания/имени пользователя.
password string	Пароль учетных данных https_read. Обязательно для создания/обновления учетных данных. Пароль не может содержать пробелы или угловые скобки (< >).
port integer	Порт. Порт по умолчанию — 443.
username string	Имя пользователя учетных данных https_read. Имя пользователя не может содержать пробелы или угловые скобки (< >).
https_write list / elements=dictionary	httpsWrite глобальных учетных данных V2.
id string	Идентификатор учетных данных. Используйте это для обновления учетных данных устройства.
name string	Имя. Обязательно для создания учетных данных.
old_description string	Старое описание. Используйте это для обновления описания/имени пользователя.
old_username string	Старое имя пользователя. Используйте это для обновления описания/имени пользователя.
password string	Пароль учетных данных https_write. Обязательно для создания/обновления учетных данных. Пароль не может содержать пробелы или угловые скобки (< >).
port integer	Порт. Порт по умолчанию — 443.
username string	Имя пользователя учетных данных https_write. Имя пользователя не может содержать пробелы или угловые скобки (< >).

snmp_v2c_read list / elements=dictionary	Глобальные учетные данные V2 snmpV2cRead.
description string	Описание. Обязательно для создания учетных данных.
id string	Идентификатор учетных данных. Используйте это для обновления учетных данных устройства.
old_description string	Старое описание. Используйте это для обновления описания.
read_community string	snmp_v2c_read Сообщество чтения. Пароль не может содержать пробелы или угловые скобки (< >).
snmp_v2c_write list / elements=dictionary	Глобальные учетные данные V2 snmpV2cWrite.
description string	Описание. Обязательно для создания учетных данных.
id string	Идентификатор учетных данных. Используйте это для обновления учетных данных устройства.
old_description string	Старое описание. Используйте это для обновления описания.
write_community string	snmp_v2c_write Сообщество записи. Пароль не может содержать пробелы или угловые скобки (< >).
snmp_v3 list / elements=dictionary	Глобальные учетные данные V2 snmpV3.
auth_password string	snmp_v3 Пароль аутентификации. Пароль должен содержать минимум 8 символов. Пароль не может содержать пробелы или угловые скобки (< >).
auth_type string	Тип аутентификации. [“SHA”, “MD5”].
description string	Описание snmp_v3. Должно отличаться от других учетных данных snmp_v3.
id string	Идентификатор учетных данных. Используйте это для обновления учетных данных устройства.
old_description string	Старое описание. Используйте это для обновления описания.
privacy_password string	snmp_v3 Пароль конфиденциальности. Пароль должен содержать минимум 8 символов. Пароль не может содержать пробелы или угловые скобки (< >).
privacy_type string	Тип конфиденциальности. [“AES128”, “AES192”, “AES256”].
snmp_mode string	Режим SNMP. [“AUTHPRIV”, “AUTHNOPRIV”, “NOAUTHNOPRIV”].
username string	Имя пользователя учетных данных snmp_v3. Имя пользователя не может содержать пробелы или угловые скобки (< >).
config_verify boolean	Установите значение True, чтобы проверить Cisco DNA Center после применения конфигурации playbook. Варианты: `false` ← (default) `true`
dnac_api_task_timeout integer	Определяет время ожидания в секундах для вызовов API для получения сведений о задаче. Если сведения о задаче не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о времени ожидания. Значение по умолчанию: `1200`

dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_log boolean	Флаг для включения/выключения ведения журнала выполнения playbook. Если значение true и указан путь dnac_log_file_path, - создается файл журнала в месте выполнения с указанным именем. Если значение true и путь dnac_log_file_path не указан, - создается файл журнала в месте выполнения с именем «dnac.log». Если значение false, - ведение журнала отключено. Если файл журнала не существует, - он создается в режиме добавления или записи в зависимости от флага «dnac_log_append». Если файл журнала существует, - он перезаписывается или к нему добавляется информация в зависимости от флага «dnac_log_append». Варианты: `false` ← (default) `true`
dnac_log_append boolean	Определяет режим файла. Установите значение True для режима «добавления». Установите значение False для режима «записи». Варианты: `false` `true` ← (default)
dnac_log_file_path string	Регулирует ведение журнала. Журналы записываются, если 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 string	Устанавливает порог для уровня журнала. Сообщения с уровнем, равным или выше этого, будут регистрироваться. Уровни перечислены в порядке серьезности [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` ← (default)
dnac_version string	Информирует SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: `"2.2.3.3"`
state string	Состояние Cisco DNA Center после завершения работы модуля. Варианты: `"merged"` ← (default) `"deleted"`
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты: `false` `true` ← (default)

Примечания

Примечание

Используемые методы SDK: discovery.Discovery.create_global_credentials_v2, discovery.Discovery.delete_global_credential_v2, discovery.Discovery.update_global_credentials_v2, network_settings.NetworkSettings.assign_device_credential_to_site_v2,
Используемые пути: post /dna/intent/api/v2/global-credential, delete /dna/intent/api/v2/global-credential/{id}, put /dna/intent/api/v2/global-credential, post /dna/intent/api/v2/credential-to-site/{siteId},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный диспетчер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center по Discovery CreateGlobalCredentialsV2: Полное описание API CreateGlobalCredentialsV2.
Документация Cisco DNA Center по Discovery DeleteGlobalCredentialV2: Полное описание API DeleteGlobalCredentialV2.
Документация Cisco DNA Center по Discovery UpdateGlobalCredentialsV2: Полное описание API UpdateGlobalCredentialsV2.
Документация Cisco DNA Center по Network Settings AssignDeviceCredentialToSiteV2: Полное описание API AssignDeviceCredentialToSiteV2.

Примеры

---
  - name: Create Credentials and assign it to a site.
    cisco.dnac.device_credential_intent:
    dnac_host: "{{ dnac_host }}"
    dnac_port: "{{ dnac_port }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - global_credential_details:
        cli_credential:
        - description: string
          username: string
          password: string
          enable_password: string
        snmp_v2c_read:
        - description: string
          read_community: string
        snmp_v2c_write:
        - description: string
          write_community: string
        snmp_v3:
        - auth_password: string
          auth_type: SHA
          snmp_mode: AUTHPRIV
          privacy_password: string
          privacy_type: AES128
          username: string
          description: string
        https_read:
        - description: string
          username: string
          password: string
          port: 443
        https_write:
        - description: string
          username: string
          password: string
          port: 443
      assign_credentials_to_site:
        cli_credential:
          id: string
        snmp_v2c_read:
          id: string
        snmp_v2c_write:
          id: string
        snmp_v3:
          id: string
        https_read:
          id: string
        https_write:
           id: string
        site_name:
        - string

  - name: Create Multiple Credentials.
    cisco.dnac.device_credential_intent:
    dnac_host: "{{ dnac_host }}"
    dnac_port: "{{ dnac_port }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - global_credential_details:
        cli_credential:
        - description: string
          username: string
          password: string
          enable_password: string
        - description: string
          username: string
          password: string
          enable_password: string
        snmp_v2c_read:
        - description: string
          read_community: string
        - description: string
          read_community: string
        snmp_v2c_write:
        - description: string
          write_community: string
        - description: string
          write_community: string
        snmp_v3:
        - auth_password: string
          auth_type: SHA
          snmp_mode: AUTHPRIV
          privacy_password: string
          privacy_type: AES128
          username: string
          description: string
        - auth_password: string
          auth_type: SHA
          snmp_mode: AUTHPRIV
          privacy_password: string
          privacy_type: AES128
          username: string
          description: string
        https_read:
        - description: string
          username: string
          password: string
          port: 443
        - description: string
          username: string
          password: string
          port: 443
        https_write:
        - description: string
          username: string
          password: string
          port: 443
        - description: string
          username: string
          password: string
          port: 443

  - name: Update global device credentials using id
    cisco.dnac.device_credential_intent:
    dnac_host: "{{ dnac_host }}"
    dnac_port: "{{ dnac_port }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - global_credential_details:
        cli_credential:
        - description: string
          username: string
          password: string
          enable_password: string
          id: string
        snmp_v2c_read:
        - description: string
          read_community: string
          id: string
        snmp_v2c_write:
        - description: string
          write_community: string
          id: string
        snmp_v3:
        - auth_password: string
          auth_type: SHA
          snmp_mode: AUTHPRIV
          privacy_password: string
          privacy_type: AES128
          username: string
          description: string
          id: string
        https_read:
        - description: string
          username: string
          password: string
          port: 443
          id: string
        https_write:
        - description: string
          username: string
          password: string
          port: 443
          id: string

  - name: Update multiple global device credentials using id
    cisco.dnac.device_credential_intent:
    dnac_host: "{{ dnac_host }}"
    dnac_port: "{{ dnac_port }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - global_credential_details:
        cli_credential:
        - description: string
          username: string
          password: string
          enable_password: string
          id: string
        - description: string
          username: string
          password: string
          enable_password: string
          id: string
        snmp_v2c_read:
        - description: string
          read_community: string
          id: string
        - description: string
          read_community: string
          id: string
        snmp_v2c_write:
        - description: string
          write_community: string
          id: string
        - description: string
          write_community: string
          id: string
        snmp_v3:
        - auth_password: string
          auth_type: SHA
          snmp_mode: AUTHPRIV
          privacy_password: string
          privacy_type: AES128
          username: string
          description: string
          id: string
        - auth_password: string
          auth_type: SHA
          snmp_mode: AUTHPRIV
          privacy_password: string
          privacy_type: AES128
          username: string
          description: string
          id: string
        https_read:
        - description: string
          username: string
          password: string
          port: 443
          id: string
        - description: string
          username: string
          password: string
          port: 443
          id: string
        https_write:
        - description: string
          username: string
          password: string
          port: 443
          id: string
        - description: string
          username: string
          password: string
          port: 443
          id: string

  - name: Update global device credential name/description using old name and description.
    cisco.dnac.device_credential_intent:
    dnac_host: "{{ dnac_host }}"
    dnac_port: "{{ dnac_port }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - global_credential_details:
        cli_credential:
        - description: string
          username: string
          password: string
          enable_password: string
          old_description: string
          old_username: string
        snmp_v2c_read:
        - description: string
          read_community: string
          old_description: string
        snmp_v2c_write:
        - description: string
          write_community: string
          old_description: string
        snmp_v3:
        - auth_password: string
          auth_type: string
          snmp_mode: string
          privacy_password: string
          privacy_type: string
          username: string
          description: string
        https_read:
        - description: string
          username: string
          password: string
          port: string
          old_description: string
          old_username: string
        https_write:
        - description: string
          username: string
          password: string
          port: string
          old_description: string
          old_username: string

  - name: Assign Credentials to sites using old description and username.
    cisco.dnac.device_credential_intent:
    dnac_host: "{{ dnac_host }}"
    dnac_port: "{{ dnac_port }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - assign_credentials_to_site:
        cli_credential:
          description: string
          username: string
        snmp_v2c_read:
          description: string
        snmp_v2c_write:
          description: string
        snmp_v3:
          description: string
        https_read:
          description: string
          username: string
        https_write:
          description: string
          username: string
        site_name:
        - string
        - string

Значения возврата

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

Ключ	Описание
dnac_response1 словарь	Словарь или список, содержащий ответ, возвращённый Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`
dnac_response2 словарь	Словарь или список, содержащий ответ, возвращённый Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Авторы

Muthu Rakesh (@MUTHU-RAKESH-27) Madhan Sankaranarayanan (@madhansansel)

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

© 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/device_credential_intent_module.html