na_cloudmanager_info

orphan:

netapp.cloudmanager.na_cloudmanager_info -- NetApp Cloud Manager info

Note

This plugin is part of the netapp.cloudmanager collection (version 21.4.0).

To install it use: ansible-galaxy collection install netapp.cloudmanager.

To use it in a playbook, specify: netapp.cloudmanager.na_cloudmanager_info.

.. versionadded:: 21.4.0 of netapp.cloudmanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module allows you to gather various information about cloudmanager using REST APIs.

Parameters

Parameter	Choices/Defaults	Comments
client_id string / required		The client ID of the Cloud Manager Connector.
gather_subsets list / elements=string	Default: "all"	When supplied, this argument will restrict the information collected to a given subset. Possible values for this argument include working_environments_info aggregates_info accounts_info
refresh_token string / required		The refresh token for NetApp Cloud Manager API operations.

Notes

Note

Not support check_mode
The modules prefixed with cloudmanager_netapp are built to Manage AWS/GCP/Azure CLOUDMANAGER.

Examples

- 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

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key	Returned	Description
info dictionary	success	a dictionary of collected subsets each subset if in JSON format Sample: { "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 ] } }