W3cubDocs

/Ansible

netapp.cloudmanager.na_cloudmanager_info – NetApp Cloud Manager info

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in version 21.4.0: of netapp.cloudmanager

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.
environment
string
added in 21.8.0 of netapp.cloudmanager
    Choices:
  • prod ←
  • stage
The environment for NetApp Cloud Manager API operations.
feature_flags
dictionary
added in 21.11.0 of netapp.cloudmanager
Enable or disable a new feature.
This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility.
Supported keys and values are subject to change without notice. Unknown keys are ignored.
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
The refresh token for NetApp Cloud Manager API operations.
sa_client_id
string
The service account secret client ID for NetApp Cloud Manager API operations.
sa_secret_key
string
The service account secret key for NetApp Cloud Manager API operations.

Notes

Note

  • Support check_mode
  • The modules prefixed with na_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds.
  • If sa_client_id and sa_secret_key are provided, service account will be used in operations. refresh_token will be ignored.

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 here, 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 ] } }


Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/cloudmanager/na_cloudmanager_info_module.html