модуль cisco.intersight.intersight_target_claim — настройка регистрации целевого устройства в Cisco Intersight

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.intersight.

Чтобы использовать модуль в плейбуке, укажите: cisco.intersight.intersight_target_claim.

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

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

Настройка регистрации целевого устройства в Cisco Intersight
Используется для регистрации целевого устройства в Cisco Intersight или отмены его регистрации
Дополнительные сведения см. в Cisco Intersight.

Параметры

Параметр	Комментарии
api_key_id string / обязательный	Идентификатор открытого ключа API, связанного с закрытым ключом. Если параметр не задан, используется значение переменной среды INTERSIGHT_API_KEY_ID.
api_private_key path / обязательный	Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM, используемыми для аутентификации в API Intersight. Если используется строка, для шифрования ее данных следует использовать Ansible Vault. Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY----- <your private key data> -----END EC PRIVATE KEY-----’ Если параметр не задан, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.
api_uri string	URI для доступа к API Intersight. Если параметр не задан, используется значение переменной среды INTERSIGHT_API_URI. По умолчанию: `"https://intersight.com/api/v1"`
claim_code string	Код регистрации, необходимый для регистрации нового целевого устройства Обязателен, если state=present
device_id string / обязательный	Идентификатор устройства (серийный номер) целевого устройства Целевые устройства с несколькими идентификаторами (например, IMM) можно указать в формате <target1_id>&<target2_id>
state string	Если `present`, модуль проверит наличие ресурса и при необходимости создаст его. Если `absent`, модуль проверит отсутствие ресурса и при необходимости удалит его. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр, управляющий проверкой TLS-сертификата api_uri Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Claim new Target
  cisco.intersight.intersight_target_claim:
    device_id: "{{ device_id }}"
    claim_code: "{{ claim_code }}"
    state: present

- name: Delete a Target (unclaim)
  cisco.intersight.intersight_target_claim:
    device_id: "{{ device_id }}"
    state: absent

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

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

Ключ	Описание
api_response dictionary	Ответ API, возвращенный указанным ресурсом. Возвращается: всегда Пример: {"api_response": {"Account": {"ClassId": "mo.MoRef", "Moid": "8675309", "ObjectType": "iam.Account", "link": "https://www.intersight.com/api/v1/iam/Accounts/8675309"}, "AccountMoid": "8675309", "Ancestors": null, "ClassId": "asset.DeviceClaim", "CreateTime": "2021-05-10T17:32:13.522665238Z", "Device": {"ClassId": "mo.MoRef", "Moid": "9035768", "ObjectType": "asset.DeviceRegistration", "link": "https://www.intersight.com/api/v1/asset/DeviceRegistrations/9035768"}, "DisplayNames": {"short": ["FDO241604EM&FDO24161700"]}, "DomainGroupMoid": "5b4e48a96a636d6d346cd1c5", "ModTime": "2021-05-10T17:32:13.522665238Z", "Moid": "8675309", "ObjectType": "asset.DeviceClaim", "Owners": ["90357688675309"], "PermissionResources": null, "SecurityToken": "A95486674376E", "SerialNumber": "FDO86753091&FDO86753092", "SharedScope": "", "Tags": [], "trace_id": "NB3e883980a98adace8f7b9c2409cced1a"}}

Ключ

Описание

api_response

dictionary

Ответ API, возвращенный указанным ресурсом.

Возвращается: всегда

Пример: {"api_response": {"Account": {"ClassId": "mo.MoRef", "Moid": "8675309", "ObjectType": "iam.Account", "link": "https://www.intersight.com/api/v1/iam/Accounts/8675309"}, "AccountMoid": "8675309", "Ancestors": null, "ClassId": "asset.DeviceClaim", "CreateTime": "2021-05-10T17:32:13.522665238Z", "Device": {"ClassId": "mo.MoRef", "Moid": "9035768", "ObjectType": "asset.DeviceRegistration", "link": "https://www.intersight.com/api/v1/asset/DeviceRegistrations/9035768"}, "DisplayNames": {"short": ["FDO241604EM&FDO24161700"]}, "DomainGroupMoid": "5b4e48a96a636d6d346cd1c5", "ModTime": "2021-05-10T17:32:13.522665238Z", "Moid": "8675309", "ObjectType": "asset.DeviceClaim", "Owners": ["90357688675309"], "PermissionResources": null, "SecurityToken": "A95486674376E", "SerialNumber": "FDO86753091&FDO86753092", "SharedScope": "", "Tags": [], "trace_id": "NB3e883980a98adace8f7b9c2409cced1a"}}

Авторы

Brandon Beck (@techBeck03)
CiscoUcs (@CiscoUcs)

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

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