netapp.cloudmanager.na_cloudmanager_info module – NetApp Cloud Manager info
Note
This module is part of the netapp.cloudmanager collection (version 21.24.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 netapp.cloudmanager 21.4.0
Synopsis
This module allows you to gather various information about cloudmanager using REST APIs.
Parameters
Parameter |
Comments |
---|---|
The connector ID of the Cloud Manager Connector. |
|
The environment for NetApp Cloud Manager API operations. Choices:
|
|
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. |
|
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 account_info agents_info active_agents_info Default: |
|
The refresh token for NetApp Cloud Manager API operations. |
|
The service account secret client ID for NetApp Cloud Manager API operations. |
|
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 |
Description |
---|---|
a dictionary of collected subsets each subset if in JSON format Returned: success Sample: |