cisco.intersight.intersight_target_claim 模块 – Cisco Intersight 的目标声明配置

注意

此模块是 cisco.intersight 集合（版本 2.0.20）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.intersight。

要在 playbook 中使用它，请指定：cisco.intersight.intersight_target_claim。

概要

  • Cisco Intersight 的目标声明配置

  • 用于从 Cisco Intersight 声明或取消声明目标

  • 有关更多信息，请参阅 Cisco Intersight。

参数

参数

注释

api_key_id

字符串 / 必需

与私钥关联的公共 API 密钥 ID。

如果未设置，则使用 INTERSIGHT_API_KEY_ID 环境变量的值。

api_private_key

路径 / 必需

用于 Intersight API 身份验证的 PEM 格式私钥数据的文件名（绝对路径）或字符串。

如果使用字符串，则应使用 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

字符串

用于访问 Intersight API 的 URI。

如果未设置，则使用 INTERSIGHT_API_URI 环境变量的值。

默认值： "https://intersight.com/api/v1"

claim_code

字符串

注册新目标所需的声明代码

如果 state=present，则为必需

device_id

字符串 / 必需

目标设备的 ID（序列号）

包含多个目标 ID（例如 IMM）的目标可以格式化为 <target1_id>&<target2_id>

state

字符串

如果 present，将验证资源是否存在，如果需要将创建。

如果 absent，将验证资源是否不存在，如果需要将删除。

选择

  • "present" ←（默认）

  • "absent"

use_proxy

布尔值

如果为 no，即使在目标主机上的环境变量中定义了代理，也不会使用代理。

选择

  • false

  • true ←（默认）

validate_certs

布尔值

用于验证 api_uri TLS 证书的布尔控件

选择

  • 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_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)