Модуль cisco.intersight.intersight_target_claim – Настройка запроса Target для Cisco Intersight

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
api_key_id строка / обязательно	Идентификатор открытого API ключа, связанный с закрытым ключом. Если не задан, используется значение переменной среды INTERSIGHT_API_KEY_ID.
api_private_key путь / обязательно	Имя файла (абсолютный путь) или строка данных закрытого ключа в формате PEM для аутентификации в API Intersight. Если используется строка, необходимо использовать Ansible vault для шифрования данных. Пример: ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– <ваши данные закрытого ключа> —–END EC PRIVATE KEY—–’ Если не задан, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.
api_uri строка	URI для доступа к API Intersight. Если не задан, используется значение переменной среды INTERSIGHT_API_URI. Значение по умолчанию: `"https://intersight.com/api/v1"`
claim_code строка	Код запроса, необходимый для регистрации нового Target Требуется, если state=present
...	...

Примеры

- 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_repsonse словарь	Вывод ответа 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_repsonse

словарь

Вывод ответа 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/intersight/intersight_target_claim_module.html