netapp.cloudmanager.na_cloudmanager_info 模块 – NetApp Cloud Manager 信息

注意

此模块是 netapp.cloudmanager 集合（版本 21.24.0）的一部分。

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

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

要在剧本中使用它，请指定： netapp.cloudmanager.na_cloudmanager_info。

netapp.cloudmanager 21.4.0 中的新功能

概要 

此模块允许您使用 REST API 收集有关 cloudmanager 的各种信息。

参数 

参数	注释
client_id 字符串 / 必需	Cloud Manager 连接器的连接器 ID。
environment 字符串在 netapp.cloudmanager 21.8.0 中添加	NetApp Cloud Manager API 操作的环境。选项 `"prod"` ←（默认） `"stage"`
feature_flags 字典在 netapp.cloudmanager 21.11.0 中添加	启用或禁用新功能。这可以用于启用实验性功能或禁用破坏向后兼容性的新功能。支持的键和值如有更改，恕不另行通知。未知的键将被忽略。
gather_subsets 列表 / 元素=字符串	当提供时，此参数会将收集的信息限制为给定的子集。此参数的可能值包括 working_environments_info aggregates_info accounts_info account_info agents_info active_agents_info 默认值： `["all"]`
refresh_token 字符串	NetApp Cloud Manager API 操作的刷新令牌。
sa_client_id 字符串	NetApp Cloud Manager API 操作的服务帐户密钥客户端 ID。
sa_secret_key 字符串	NetApp Cloud Manager API 操作的服务帐户密钥。

说明 

注意

支持 check_mode
前缀为 na_cloudmanager 的模块旨在管理 AWS/GCP/Azure 云中的 CloudManager 和 CVO 部署。
如果提供了 sa_client_id 和 sa_secret_key，则将在操作中使用服务帐户。refresh_token 将被忽略。

示例 

- name: Get all available subsets
  netapp.cloudmanager.na_cloudmanager_info:
    client_id: "{{ client_id }}"
    refresh_token: "{{ refresh_token }}"
    gather_subsets:
      - all

- name: Collect data for cloud manager with indicated subsets
  netapp.cloudmanager.na_cloudmanager_info:
    client_id: "{{ client_id }}"
    refresh_token: "{{ refresh_token }}"
    gather_subsets:
      - aggregates_info
      - working_environments_info

返回值 

常见的返回值记录在此处，以下是此模块独有的字段

键

描述

信息

字典

收集的子集的字典

每个子集都是 JSON 格式

返回： 成功

示例： {"info": {"working_environments_info": [{"azureVsaWorkingEnvironments": [], "gcpVsaWorkingEnvironments": [], "onPremWorkingEnvironments": [], "vsaWorkingEnvironments": [{"actionsRequired": null, "activeActions": null, "awsProperties": null, "capacityFeatures": null, "cbsProperties": null, "cloudProviderName": "Amazon", "cloudSyncProperties": null, "clusterProperties": null, "complianceProperties": null, "creatorUserEmail": "samlp|NetAppSAML|test_user", "cronJobSchedules": null, "encryptionProperties": null, "fpolicyProperties": null, "haProperties": null, "interClusterLifs": null, "isHA": false, "k8sProperties": null, "monitoringProperties": null, "name": "testAWS", "ontapClusterProperties": null, "publicId": "VsaWorkingEnvironment-3txYJOsX", "replicationProperties": null, "reservedSize": null, "saasProperties": null, "schedules": null, "snapshotPolicies": null, "status": null, "supportRegistrationInformation": [], "supportRegistrationProperties": null, "supportedFeatures": null, "svmName": "svm_testAWS", "svms": null, "tenantId": "Tenant-2345", "workingEnvironmentType": "VSA"}]}, null]}}

作者

NetApp Ansible 团队 (@carchi8py)