Модуль cisco.dnac.global_credential_v2 – Модуль ресурса для глобальных учетных данных V2

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.dnac.global_credential_v2.

Новая версия в cisco.dnac 3.1.0

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

Описание

Управление операциями создания, обновления и удаления ресурса «Глобальные учетные данные V2».
API для создания новых глобальных учетных данных. Одновременно можно передать несколько учетных данных различных типов. Для получения дополнительной информации см. образец тела запроса.
Удаление глобальной учетной записи. Должен быть передан только идентификатор (id) учетной записи.
API для обновления учетных данных устройства. Одновременно можно передать несколько учетных данных, но только одну учетную запись заданного типа. Для получения дополнительной информации см. образец тела запроса.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
cliCredential словарь	cliCredential модуля Global Credential V2.
description строка	Описание учетных данных CLI.
enablePassword строка	Пароль включения CLI.
id строка	Идентификатор учетных данных CLI в формате UUID.
password строка	Пароль CLI.
username строка	Имя пользователя CLI.
dnac_debug булево	Флаг для включения отладки Cisco DNA Center SDK. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username алиасы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify булево	Флаг для включения или отключения проверки сертификатов SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
httpsRead словарь	httpsRead модуля Global Credential V2.
description строка	Описание учетных данных для чтения HTTP(S).
id строка	Идентификатор учетных данных для чтения HTTP(S) в формате UUID.
password строка	Пароль для чтения HTTP(S).
port целое число	Порт HTTP(S).
username строка	Имя пользователя для чтения HTTP(S).
httpsWrite словарь	httpsWrite модуля Global Credential V2.
description строка	Описание учетных данных для записи HTTP(S).
id строка	Идентификатор учетных данных для записи HTTP(S) в формате UUID.
password строка	Пароль для записи HTTP(S).
port целое число	Порт HTTP(S).
username строка	Имя пользователя для записи HTTP(S).
id строка	Параметр пути id. Идентификатор Global Credential.

snmpV2cRead dictionary	snmpV2cRead модуля Global Credential V2.
description string	Описание сообщества Snmp RO.
id string	Идентификатор учетных данных чтения SNMP в формате UUID.
readCommunity string	Сообщество Snmp RO.
snmpV2cWrite dictionary	snmpV2cWrite модуля Global Credential V2.
description string	Описание сообщества Snmp RW.
id string	Идентификатор учетных данных записи SNMP в формате UUID.
writeCommunity string	Сообщество Snmp RW.
snmpV3 dictionary	snmpV3 модуля Global Credential V2.
authPassword string	Пароль аутентификации для SNMP V3.
authType string	Протокол аутентификации SNMP. SHA’ или ‘MD5’.
description string	Описание учетных данных SNMP V3.
id string	Идентификатор учетных данных SNMP V3 в формате UUID.
privacyPassword string	Пароль конфиденциальности для SNMP.
privacyType string	Протокол конфиденциальности SNMP. ‘AES128’,’AES192’,’AES256’.
snmpMode string	Режим SNMP. ‘AUTHPRIV’ или ‘AUTHNOPRIV’ или ‘NOAUTHNOPRIV’.
username string	Имя пользователя SNMP V3.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, позволяющий выполнять проверку соответствия тел запросов JSON-схеме. Выбор: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: discovery.Discovery.create_global_credentials_v2, discovery.Discovery.delete_global_credential_v2, discovery.Discovery.update_global_credentials_v2,
Используемые пути: post /dna/intent/api/v2/global-credential, delete /dna/intent/api/v2/global-credential/{id}, put /dna/intent/api/v2/global-credential,
Не поддерживает 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.

Примеры

- name: Update all
  cisco.dnac.global_credential_v2:
    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
    cliCredential:
      description: string
      enablePassword: string
      id: string
      password: string
      username: string
    httpsRead:
      description: string
      id: string
      password: string
      port: 0
      username: string
    httpsWrite:
      description: string
      id: string
      password: string
      port: 0
      username: string
    snmpV2cRead:
      description: string
      id: string
      readCommunity: string
    snmpV2cWrite:
      description: string
      id: string
      writeCommunity: string
    snmpV3:
      authPassword: string
      authType: string
      description: string
      id: string
      privacyPassword: string
      privacyType: string
      snmpMode: string
      username: string

- name: Create
  cisco.dnac.global_credential_v2:
    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
    cliCredential:
    - description: string
      enablePassword: string
      password: string
      username: string
    httpsRead:
    - description: string
      password: string
      port: 0
      username: string
    httpsWrite:
    - description: string
      password: string
      port: 0
      username: string
    snmpV2cRead:
    - description: string
      readCommunity: string
    snmpV2cWrite:
    - description: string
      writeCommunity: string
    snmpV3:
    - authPassword: string
      authType: string
      description: string
      privacyPassword: string
      privacyType: string
      snmpMode: string
      username: string

- name: Delete by id
  cisco.dnac.global_credential_v2:
    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: absent
    id: string

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

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

Ключ	Описание
dnac_response dictionary	Словарь или список с ответом, возвращенным 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/global_credential_v2_module.html