| 1 |
[](https://docs.ansible.com/ansible/devel/collections/netapp/cloudmanager/index.html) |
| 2 |
 |
| 3 |
[](https://codecov.io/gh/ansible-collections/netapp.cloudmanager) |
| 4 |
[](https://discord.gg/NetApp) |
| 5 |
# Ansible Collection - netapp.cloudmanager |
| 6 |
|
| 7 |
Copyright (c) 2022 NetApp, Inc. All rights reserved. |
| 8 |
Specifications subject to change without notice. |
| 9 |
|
| 10 |
This collection requires python 3.5 or better. |
| 11 |
|
| 12 |
# Installation |
| 13 |
```bash |
| 14 |
ansible-galaxy collection install netapp.cloudmanager |
| 15 |
``` |
| 16 |
To use this collection, add the following to the top of your playbook: |
| 17 |
``` |
| 18 |
collections: |
| 19 |
- netapp.cloudmanager |
| 20 |
``` |
| 21 |
# Requirements |
| 22 |
- ansible version >= 2.9 |
| 23 |
- requests >= 2.20 |
| 24 |
- python version >= '3.5' |
| 25 |
|
| 26 |
# Module documentation |
| 27 |
https://docs.ansible.com/ansible/devel/collections/netapp/cloudmanager/ |
| 28 |
|
| 29 |
# Need help |
| 30 |
Join our [Discord](https://discord.gg/NetApp) and look for our #ansible channel. |
| 31 |
|
| 32 |
# Code of Conduct |
| 33 |
This collection follows the [Ansible project's Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html). |
| 34 |
|
| 35 |
# Documentation |
| 36 |
https://github.com/ansible-collections/netapp/wiki |
| 37 |
|
| 38 |
# Release Notes |
| 39 |
|
| 40 |
## 21.24.0 |
| 41 |
|
| 42 |
### Minor Changes |
| 43 |
- Requires Ansible 2.16 or higher. |
| 44 |
- updated pipleine. |
| 45 |
|
| 46 |
## 21.22.1 |
| 47 |
|
| 48 |
### Minor Changes |
| 49 |
- na_cloudmanager_cvo_azure - increase timeout for creating cvo to 90 mins. |
| 50 |
- na_cloudmanager_cvo_aws - increase timeout for creating cvo to 90 mins. |
| 51 |
- na_cloudmanager_cvo_gcp - increase timeout for creating cvo to 90 mins. |
| 52 |
- Requires Ansible 2.14 or higher |
| 53 |
|
| 54 |
## 21.22.0 |
| 55 |
- Add `svm_name` option in AWS, AZURE and GCP CVO for creation and update. |
| 56 |
|
| 57 |
## 21.21.0 |
| 58 |
|
| 59 |
### Minor Changes |
| 60 |
- na_cloudmanager_connector_azure - expose connector managed system identity principal_id tp perform role assignment. |
| 61 |
|
| 62 |
### New Options |
| 63 |
- Add `availability_zone_node1` and `availability_zone_node2` options in CVO Azure HA on the location configuration. |
| 64 |
- Add new `storage_type` value Premium_ZRS |
| 65 |
|
| 66 |
## 21.20.1 |
| 67 |
|
| 68 |
### Bug Fixes |
| 69 |
- new meta/execution-environment.yml is failing ansible-builder sanitize step. |
| 70 |
|
| 71 |
## 21.20.0 |
| 72 |
|
| 73 |
### New Options |
| 74 |
- Add `availability_zone` option in CVO Azure on the location configuration. |
| 75 |
- Add `cluster_key_pair_name` option in CVO AWS for SSH authentication key pair method. |
| 76 |
- Add `subnet_path` option in CVO GCP. |
| 77 |
|
| 78 |
### Bug Fixes |
| 79 |
- Fix the `machine_type` default value in the connector GCP. |
| 80 |
|
| 81 |
### Minor Changes |
| 82 |
- na_cloudmanager_volume - Support AWS FsxN working environment |
| 83 |
|
| 84 |
## 21.19.0 |
| 85 |
|
| 86 |
### Minor Changes |
| 87 |
- Support writing_speed_state modification for AWS, AZURE and GCP CVOs. |
| 88 |
|
| 89 |
## 21.18.0 |
| 90 |
- na_cloudmanager_connector_azure - support full subnet_id and vnet_id |
| 91 |
- Support ``writing_speed_state`` modification for AWS, AZURE and GCP CVOs. |
| 92 |
|
| 93 |
## 21.17.0 |
| 94 |
|
| 95 |
### Minor Changes |
| 96 |
- na_cloudmanager_aws_fsx - Import AWS FSX to CloudManager. |
| 97 |
- Support ``license_type`` modification for AWS, AZURE and GCP CVOs. |
| 98 |
|
| 99 |
### New Options |
| 100 |
- na_cloudmanager_connector_azure - Support user defined ``storage_account``. The storage account can be created automatically. When ``storage_account`` is not set, the name is constructed by appending 'sa' to the connector ``name``. |
| 101 |
- na_cloudmanager_aws_fsx - Import AWS FSX to CloudManager by adding new parameters ``import_file_system`` and ``file_system_id``. |
| 102 |
|
| 103 |
## 21.16.0 |
| 104 |
|
| 105 |
### Bug Fixes |
| 106 |
- na_cloudmanager_volume - Add check when volume is capacity tiered. |
| 107 |
- na_cloudmanager_connector_azure - Fix string formatting error when deleting the connector. |
| 108 |
|
| 109 |
### Minor Changes |
| 110 |
- na_cloudmanager_connector_gcp - when using the user application default credential authentication by running the command gcloud auth application-default login, ``gcp_service_account_path`` is not needed. |
| 111 |
|
| 112 |
## 21.15.0 |
| 113 |
|
| 114 |
### Minor Changes |
| 115 |
- Add the description of the client_id based on the cloudmanager UI. |
| 116 |
- Update ``license_type`` and ``capacity_package_name`` default values on capacity based license. |
| 117 |
|
| 118 |
## 21.14.0 |
| 119 |
|
| 120 |
### Minor Changes |
| 121 |
- na_cloudmanager_snapmirror - add AWS FSx to snapmirror. |
| 122 |
|
| 123 |
### Bug Fixes |
| 124 |
- CVO working environment clusterProperties is deprecated. Make changes accordingly. Add CVO update status check on `instance_type` change. |
| 125 |
|
| 126 |
## 21.13.0 |
| 127 |
|
| 128 |
### New Modules |
| 129 |
- na_cloudmanager_aws_fsx - NetApp AWS FSX |
| 130 |
|
| 131 |
### Minor Changes |
| 132 |
- na_cloudmanager_connector_aws - make the module idempotent for create and delete. |
| 133 |
- na_cloudmanager_connector_aws - automatically fetch client_id and instance_id for delete. |
| 134 |
- na_cloudmanager_connector_aws - report client_id if connector already exists. |
| 135 |
- na_cloudmanager_info - new subsets - account_info, agents_info, active_agents_info. |
| 136 |
- Add ONTAP image upgrade feature for AWS, AZURE and GCP CVOs. Add ``upgrade_ontap_version`` to indicate if upgrade ONTAP is needed. It only can be used when ``use_latest_version`` is false and ``ontap_version`` is a specific version. |
| 137 |
- Add instance_type update feature for AWS, AZURE and GCP CVOs. |
| 138 |
- na_cloudmanager_volume - Add ``tiering_policy`` and ``snapshot_policy_name`` modification, and report error if the properties cannot be changed. |
| 139 |
|
| 140 |
### Bug Fixes |
| 141 |
- na_cloudmanager_cvo_gcp - handle extra auto-gen GCP labels to fix `gcp_labels` update failure. |
| 142 |
- Add ``update_svm_password`` for ``svm_password`` update on AWS, AZURE and GCP CVOs. Update ``svm_password`` if ``update_svm_password`` is true. |
| 143 |
|
| 144 |
## 21.12.1 |
| 145 |
|
| 146 |
### Bug Fixes |
| 147 |
- na_cloudmanager_connector_aws - fix default ami not found in the region on resource file. |
| 148 |
- na_cloudmanager_snapmirror - report actual error rather than None with "Error getting destination info". |
| 149 |
|
| 150 |
## 21.12.0 |
| 151 |
|
| 152 |
### Minor Changes |
| 153 |
- Handle extra azure_tag on AZURE CVO and extra gcp_labels on GCP CVO HA on modification. gcp_labels modification on GCP CVO does not support remove labels. |
| 154 |
- PR1 - allow usage of Ansible module group defaults - for Ansible 2.12+. |
| 155 |
|
| 156 |
### Bug Fixes |
| 157 |
- na_cloudmanager_snapmirror - working environment get information api not working for onprem is fixed. |
| 158 |
- Fix cannot find working environment if `working_environment_name` is provided. |
| 159 |
|
| 160 |
## 21.11.0 |
| 161 |
|
| 162 |
## New Options |
| 163 |
- Adding new parameter `capacity_package_name` for all CVOs creation with capacity based license type capacity-paygo or ha-capacity-paygo for HA. |
| 164 |
|
| 165 |
### Minor Changes |
| 166 |
- na_cloudmanager_connector_gcp - make the module idempotent for create and delete. |
| 167 |
- na_cloudmanager_connector_gcp - automatically fetch client_id for delete. |
| 168 |
- na_cloudmanager_connector_gcp - report client_id if connector already exists. |
| 169 |
- all modules - better error reporting if ``refresh_token`` is not valid. |
| 170 |
|
| 171 |
### Bug Fixes |
| 172 |
- na_cloudmanager_connector_gcp - typeError when using proxy certificates. |
| 173 |
|
| 174 |
## 21.10.0 |
| 175 |
|
| 176 |
### Minor Changes |
| 177 |
- Adding support update on `svm_password`, `tier_level`, `aws_tag`, `azure_tag` and `gcp_labels` for all CVOs. Only these parameters will be modified on the existing CVOs. |
| 178 |
|
| 179 |
### Bug Fixes |
| 180 |
- na_cloudmanager_snapmirror - key error CloudProviderName for ONPREM operation. |
| 181 |
|
| 182 |
## New Options |
| 183 |
- Adding new parameter `ha_enable_https` for HA CVO to enable the HTTPS connection from CVO to storage accounts. This can impact write performance. The default is false. |
| 184 |
- Adding new parameters `kms_key_id` and `kms_key_arn` as AWS encryption parameters for AWS CVO encryption. |
| 185 |
- Adding new parameter `azure_encryption_parameters` for AZURE CVO encryption. |
| 186 |
- Adding new parameter `gcp_encryption_parameters` for GCP CVO encryption. |
| 187 |
|
| 188 |
## 21.9.0 |
| 189 |
|
| 190 |
### New Options |
| 191 |
- Adding selflink support on CVO GCP params: `subnet_id`, `vpc0_node_and_data_connectivity`, `vpc1_cluster_connectivity`, `vpc2_ha_connectivity`, `vpc3_data_replication`, `subnet0_node_and_data_connectivity`, `subnet1_cluster_connectivity`, `subnet2_ha_connectivity`, and `subnet3_data_replication`. |
| 192 |
- Adding pd-balanced support on ``gcp_volume_type`` CVO GCP and ``provider_volume_type`` for na_cloudmanager_snapmirror and na_cloudmanager_volume. |
| 193 |
|
| 194 |
### Bug Fixes |
| 195 |
- Change `virtual_machine_size` default value to Standard_DS3_v2. |
| 196 |
|
| 197 |
## 21.8.0 |
| 198 |
|
| 199 |
### New Options |
| 200 |
- Adding stage environment to all modules in cloudmanager. |
| 201 |
- Adding service account support on API operations in cloudmanager: `sa_client_id` and `sa_secret_key`. `refresh_token` will be ignored if service account information is provided. |
| 202 |
|
| 203 |
### Bug Fixes |
| 204 |
- Accept client_id end with or without 'clients'. |
| 205 |
|
| 206 |
## 21.7.0 |
| 207 |
|
| 208 |
### New Options |
| 209 |
- na_cloudmanager_cvo_aws: Support one new ebs_volume_type gp3. |
| 210 |
- Adding stage environemt to all modules in cloudmanager. |
| 211 |
- na_cloudmanager_volume: Add `aggregate_name` support on volume creation. |
| 212 |
- na_cloudmanager_cvo_aws: Support one new `ebs_volume_type` gp3. |
| 213 |
- na_cloudmanager_connector_azure: Add `subnet_name` as aliases of `subnet_id`, `vnet_name` as aliases of `vnet_id`. |
| 214 |
- na_cloudmanager_aggregate - Add ``provider_volume_type`` gp3 support. |
| 215 |
- na_cloudmanager_volume - Add ``provider_volume_type`` gp3 support. |
| 216 |
- na_cloudmanager_snapmirror - Add ``provider_volume_type`` gp3 support. |
| 217 |
|
| 218 |
### Bug Fixes |
| 219 |
- na_cloudmanager_aggregate: Improve error message. |
| 220 |
- na_cloudmanager_cvo_gcp: Apply `network_project_id` on vpc1_cluster_connectivity, vpc2_ha_connectivity, vpc3_data_replication, subnet1_cluster_connectivity, subnet2_ha_connectivity, subnet3_data_replication. |
| 221 |
- na_cloudmanager_connector_gcp: rename option `service_account_email` and `service_account_path` to `gcp_service_account_email` and `gcp_service_account_path` respectively. |
| 222 |
- na_cloudmanager_connector_azure: Fix KeyError client_id. |
| 223 |
- na_cloudmanager_nss_account: Improve error message. |
| 224 |
- na_cloudmanager_volume: Improve error message. |
| 225 |
|
| 226 |
## 21.6.0 |
| 227 |
|
| 228 |
### New Modules |
| 229 |
- na_cloudmanager_snapmirror: Create or Delete snapmirror on Cloud Manager. |
| 230 |
|
| 231 |
### Bug Fixes |
| 232 |
- na_cloudmanager_connector_gcp: Make client_id as optional. |
| 233 |
- na_cloudmanager_cvo_gcp: Change ``vpc_id`` from optional to required. |
| 234 |
|
| 235 |
## 21.5.1 |
| 236 |
|
| 237 |
### Bug fixes |
| 238 |
- na_cloudmanager_cifs_server: Fix incorrect API call when is_workgroup is true. |
| 239 |
- na_cloudmanager_connector_azure: Fix python error - msrest.exceptions.ValidationError. Parameter 'Deployment.properties' can not be None. |
| 240 |
- na_cloudmanager_connector_azure: Fix wrong example on the document and update account_id is required field on deletion. |
| 241 |
|
| 242 |
## 21.5.0 |
| 243 |
|
| 244 |
### New Options |
| 245 |
- na_cloudmanager_connector_aws: Return newly created Azure client ID in cloud manager, instance ID and account ID. New option `proxy_certificates`. |
| 246 |
- na_cloudmanager_cvo_aws: Return newly created AWS working_environment_id. |
| 247 |
- na_cloudmanager_cvo_azure: Return newly created AZURE working_environment_id. |
| 248 |
- na_cloudmanager_cvo_gcp: Return newly created GCP working_environment_id. |
| 249 |
|
| 250 |
## Bug Fixes |
| 251 |
- na_cloudmanager_cvo_aws: Fix incorrect placement of platformSerialNumber in the resulting json structure. |
| 252 |
|
| 253 |
## 21.4.0 |
| 254 |
|
| 255 |
### Module documentation changes |
| 256 |
- Remove the period at the end of the line on short_description. |
| 257 |
- Add period at the end of the names in examples. |
| 258 |
- Add notes mentioning support check_mode. |
| 259 |
|
| 260 |
### New Modules |
| 261 |
- na_cloudmanager_connector_azure: Create or delete Cloud Manager connector for Azure. |
| 262 |
- na_cloudmanager_cvo_azure: Create or delete Cloud Manager CVO for AZURE for both single and HA. |
| 263 |
- na_cloudmanager_info: Gather Cloud Manager subset information using REST APIs. Support for subsets `working_environments_info`, `aggregates_info`, `accounts_info`. |
| 264 |
- na_cloudmanager_connector_gcp: Create or delete Cloud Manager connector for GCP. |
| 265 |
- na_cloudmanager_cvo_gcp: Create or delete Cloud Manager CVO for GCP for both single and HA. |
| 266 |
|
| 267 |
## 21.3.0 |
| 268 |
|
| 269 |
### New Modules |
| 270 |
- na_cloudmanager_aggregate: Create or delete an aggregate on Cloud Volumes ONTAP, or add disks on an aggregate. |
| 271 |
- na_cloudmanager_cifs_server: Create or delete CIFS server for Cloud Volumes ONTAP. |
| 272 |
- na_cloudmanager_connector_aws: Create or delete Cloud Manager connector for AWS. |
| 273 |
- na_cloudmanager_cvo_aws: Create or delete Cloud Manager CVO for AWS for both single and HA. |
| 274 |
- na_cloudmanager_nss_account: Create or delete a nss account on Cloud Manager. |
| 275 |
- na_cloudmanager_volume: Create, modify or delete a volume on Cloud Volumes ONTAP. |