Модуль cisco.dnac.http_read_credential – Ресурсный модуль для учетных данных HTTP для чтения

Примечание

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

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

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

Для использования в playbook, укажите: cisco.dnac.http_read_credential.

Новое в cisco.dnac 3.1.0

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

Краткое описание

Управление операциями создания и обновления ресурса Http Read Credential.
Добавление учетных данных HTTP для чтения.
Обновление глобальных учетных данных HTTP для чтения.

Примечание

Этот модуль имеет соответствующий плагин действия.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
comments string	Комментарии для идентификации учетных данных HTTP(S) для чтения.
credentialType string	Тип учетных данных для идентификации приложения, использующего учетные данные HTTP(S) для чтения.
description string	Описание для учетных данных HTTP(S) для чтения.
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки SSL-сертификата. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Информирует SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
id string	Идентификатор учетных данных HTTP(S) для чтения в формате UUID.
instanceTenantId string	Устарело.
instanceUuid string	Устарело.
password string	Пароль HTTP(S) для чтения.
port integer	Порт HTTP(S). Допустимый порт должен находиться в диапазоне от 1 до 65535.
secure boolean	Флаг для HTTPS чтения. Варианты: `false` `true`
username string	Имя пользователя HTTP(S) для чтения.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки текстов запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: discovery.Discovery.create_http_read_credentials, discovery.Discovery.update_http_read_credential,
Используемые пути: post /dna/intent/api/v1/global-credential/http-read, put /dna/intent/api/v1/global-credential/http-read,
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по Discovery CreateHTTPReadCredentials: Полное описание API CreateHTTPReadCredentials.
Документация Cisco DNA Center по Discovery UpdateHTTPReadCredential: Полное описание API UpdateHTTPReadCredential.

Примеры

- name: Create
  cisco.dnac.http_read_credential:
    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}}"
    state: present
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    password: string
    port: 0
    secure: true
    username: string

- name: Update all
  cisco.dnac.http_read_credential:
    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}}"
    state: present
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    password: string
    port: 0
    secure: true
    username: string

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

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

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

Авторы

Rafael Campos (@racampos)

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

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