Debian Codegraph @

ansible_collections/netapp/storagegrid/README.md

raw
1 ![example workflow](https://github.com/ansible-collections/netapp.storagegrid/actions/workflows/main.yml/badge.svg)
2 [![codecov](https://codecov.io/gh/ansible-collections/netapp.storagegrid/branch/main/graph/badge.svg?token=weBYkksxSi)](https://codecov.io/gh/ansible-collections/netapp.storagegrid)
3 [![Discord](https://img.shields.io/discord/855068651522490400)](https://discord.gg/NetApp)
4
5
6 =============================================================
7
8 netapp.storagegrid
9
10 NetApp StorageGRID Collection
11
12 Copyright (c) 2025 NetApp, Inc. All rights reserved.
13 Specifications subject to change without notice.
14
15 =============================================================
16
17 # Installation
18
19 ```bash
20 ansible-galaxy collection install netapp.storagegrid
21 ```
22 To use this collection add the following to the top of your playbook.
23 ```
24 collections:
25 - netapp.storagegrid
26 ```
27
28 # Requirements
29 - ansible-core >= 2.17
30
31 # Usage
32
33 All StorageGRID modules in this collection require an `auth_token` parameter for authentication.
34 You can obtain an `auth_token` by running the `na_sg_grid_login` module as the first task in your playbook and registering its output. The token can be accessed as `auth.na_sa_token`(assuming you register the result as `auth`).
35
36 If you are performing a Tenant operation, ensure that the `tenant_id` parameter is also specified in the task and set to the Tenant Account ID. For example, `"tenant_id": "01234567890123456789"`
37
38 ```yaml
39 - name: Get Tenant Authorization token
40 netapp.storagegrid.na_sg_grid_login:
41 hostname: https://sgadmin.example.com
42 username: admin
43 password: admin123
44 tenant_id: 01234567890123456789
45 validate_certs: false
46 register: auth
47 ```
48
49 Subsequent tasks can leverage the registered auth token.
50
51 ```yaml
52 - name: Create a StorageGRID Tenant Account
53 netapp.storagegrid.na_sg_grid_account:
54 api_url: "https://sgadmin.example.com"
55 auth_token: "{{ auth.na_sa_token }}"
56 validate_certs: false
57 state: present
58 name: AnsibleTenant
59 protocol: s3
60 management: true
61 use_own_identity_source: true
62 allow_platform_services: true
63 password: "mytenantrootpassword"
64 quota_size: 10
65 ```
66
67 # Module documentation
68
69 [https://docs.ansible.com/ansible/latest/collections/netapp/storagegrid](https://docs.ansible.com/ansible/latest/collections/netapp/storagegrid/index.html)
70
71 # Versioning
72
73 [Releasing, Versioning and Deprecation](https://github.com/ansible-collections/netapp/issues/93)
74
75 # Need help
76
77 Join our [Discord](https://discord.gg/NetApp) and look for our #ansible channel.
78
79 # Code of Conduct
80
81 This collection follows the [Ansible project's Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).
82
83 # Release Notes
84
85 ## 21.16.0
86
87 ### New Modules
88 - na_sg_grid_recovery_package - downloading recovery package.
89 - na_sg_grid_firewall - configure firewall settings on StorageGRID.
90 - na_sg_grid_metrics - grab metrics on StorageGRID.
91 - na_sg_pge_info - gather information from a StorageGRID node Pre-Grid Environment (PGE).
92 - na_sg_grid_login - generate authentication token to login into grid/tenant account on StorageGRID.
93 - na_sg_grid_untrusted_client_network - manage untrusted client network on StorageGRID.
94 - na_sg_grid_ssh_security - configure ssh security setting, requires storageGRID 12.0 or later.
95 - na_sg_org_cloud_mirror_replication - set the replication configuration for an S3 bucket on StorageGRID.
96
97 ### Minor Changes
98 - na_sg_org_container - Enhanced the bucket policy.
99 - na_sg_grid_gateway - new option `closed_on_untrusted_client_network`. Requires StorageGRID 11.8 or later.
100 - na_sg_grid_gateway - parameter `default_service_type` allows option for `management`. Requires StorageGRID 11.8 or later.
101 - na_sg_grid_info - added new endpoints in grid info module.
102 - na_sg_org_info - added new endpoints in org info module.
103 - na_sg_grid_audit_destination - new option `access_logs_send`, `access_logs_facility`, and `access_logs_severity` added to manage access log settings for syslog server.
104 - all modules - add support for failure responses to include additional error details for easier troubleshooting.
105 - na_sg_grid_group - new option `manage_alerts` and `storage_admin` added to management policy.
106 - na_sg_org_container - user input for `capacity_limit` option changed from bytes to GB.
107 - na_sg_org_bucket - user input for `capacity_limit` option changed from bytes to GB.
108 - na_sg_grid_alert_receiver - new option `smtp_username` and `smtp_password` added in place of `username` and `password`.
109 - na_sg_org_group - new options `s3_console` to control S3 console access and `view_all_containers` to view settings for all buckets added, requires StorageGRID version 11.8 or later.
110
111 ### Bug Fixes
112 - na_sg_org_user_s3_key - fixed for incorrect handling of the `unique_user_name`.
113 - na_sg_grid_ha_group - correct documentation section in the module for better understanding.
114 - na_sg_grid_regions - correct documentation section in the module for better understanding.
115 - na_sg_grid_info - Fix issue where the module incorrectly reported tasks as changed.
116 - na_sg_org_info - Fix issue where the module incorrectly reported tasks as changed.
117 - na_sg_grid_alert_receiver - correct example section in the module for better understanding.
118 - na_sg_grid_autosupport - fix issue with setting up `destinations` option in the module.
119 - na_sg_grid_autosupport - add support to handle error response from the API.
120 - na_sg_grid_domain_name - fixed issue where additional domain names was not detected as changed.
121 - na_sg_grid_identity_federation - fix issue with check mode response.
122 - na_sg_org_identity_federation - fix issue with check mode response.
123 - na_sg_grid_group - fix issue where `activate_features` parameter was deprecated but still present in code.
124 - na_sg_grid_group - fix typo in parameter mapping for `alarm_acknowledgement` option.
125
126 ## 21.15.0
127
128 ### New Modules
129 - na_sg_grid_proxy_settings - configure proxy settings on StorageGRID.
130 - na_sg_grid_domain_name - configure endpoint domain names on StorageGRID.
131 - na_sg_grid_vlan_interface - configure VLAN interfaces on StorageGRID.
132 - na_sg_grid_audit_destination - configure audit log destinations on StorageGRID.
133 - na_sg_grid_autosupport - configure autosupport settings on StorageGRID.
134 - na_sg_grid_snmp - configure SNMP agent for monitoring on StorageGRID.
135 - na_sg_org_bucket - duplicate of `na_sg_org_container` module to manage bucket.
136 - na_sg_grid_tenant - duplicate of `na_sg_grid_account` module to manage tenant account.
137 - na_sg_grid_hotfix - apply hotfix on StorageGRID.
138 - na_sg_grid_alert_receiver - configure alert receiver on StorageGRID.
139
140 ### Minor Changes
141 - na_sg_org_container - new option `capacity_limit` added for bucket, requires storageGRID 11.9 or later.
142 - na_sg_grid_ha_group - added check mode support in the module.
143 - na_sg_org_container - Enhanced the Consistency setting.
144
145 ### Bug Fixes
146 - na_sg_org_user - fix where existing users with no groups attached were not getting any groups added.
147
148 ## 21.14.0
149
150 ### New Modules
151 - na_sg_grid_ilm_policy - Added new module for ILM policy management.
152 - na_sg_grid_ilm_policy_tag - Added new module for ILM policy tag management.
153 - na_sg_grid_ilm_rule - Added new module for ILM rule management.
154 - na_sg_grid_ilm_pool - Added new module for ILM pool management.
155 - na_sg_grid_ec_profile - Added new module for Erasure coding profile management.
156
157 ### Minor Changes
158 - na_sg_grid_info - LB endpoints and HA group in info module.
159 - na_sg_grid_account - new option `allow_compliance_mode` and `max_retention_days` added for tenant account, requires storageGRID 11.9 or later.
160 - na_sg_grid_group - new option `read_only` added for grid groups.
161 - na_sg_org_group - new option `read_only` added for tenant groups.
162 - na_sg_grid_gateway - new option `enable_tenant_manager`, `enable_grid_manager` and `node_type` added to support management interfaces.
163
164
165 ## 21.13.0
166
167
168 ### Minor Changes
169 - updated pipleine.
170
171 ## 21.12.0
172
173 ### Minor Changes
174 - na_sg_grid_account - New option ``description`` for setting additional identifying information for the tenant account.
175 - na_sg_grid_account - New option ``allow_select_object_content`` for enabling use of the S3 SelectObjectContent API.
176
177 ### Bug Fixes
178 - Removed fetch limit in API request and implemented pagination.
179
180 ## 21.11.1
181
182 ### Bug Fixes
183 - na_sg_org_container - fix versioning not enabled on initial bucket creation.
184
185 ## 21.11.0
186
187 ### Minor Changes
188 - na_sg_org_container - supports versioning configuration for S3 buckets available in StorageGRID 11.6+.
189
190 ### New Modules
191 - na_sg_grid_client_certificate - Manage Client Certificates on StorageGRID.
192
193 ## 21.10.0
194
195 ### Minor Changes
196 - na_sg_grid_gateway - supports specifying HA Groups by name or UUID.
197
198 ### Bug Fixes
199 - na_sg_org_group - fixed behaviour where update to ``s3_policy`` is ignored if ``management_policy`` is set.
200
201 ### New Modules
202 - na_sg_grid_ha_group - Manage high availability (HA) group configuration on StorageGRID.
203 - na_sg_grid_traffic_classes - Manage Traffic Classification Policy configuration on StorageGRID.
204
205 ## 21.9.0
206
207 ### Minor Changes
208 - na_sg_grid_gateway - supports load balancer endpoint binding available in StorageGRID 11.5+.
209 - na_sg_org_container - supports creation of S3 Object Lock buckets available in StorageGRID 11.5+.
210
211 ### Bug Fixes
212 - na_sg_grid_gateway - existing endpoints matched by ``name`` and ``port``.
213 - na_sg_grid_account - minor documentation fix.
214
215 ## 21.8.0
216
217 ### Minor Changes
218 - all modules - enable usage of Ansible module group defaults - for Ansible 2.12+.
219
220 ## 21.7.0
221
222 ### New Modules
223
224 - na_sg_grid_gateway: Manage Load balancer (gateway) endpoints
225
226 ### Minor Changes
227 - Updated documentation - added RETURN block for each module
228
229 ## 21.6.0
230
231 ### New Modules
232
233 - na_sg_grid_certificate: Manage the Storage API and Grid Management certificates on StorageGRID.
234 - na_sg_grid_identity_federation: Manage Grid identity federation.
235 - na_sg_org_identity_federation: Manage Tenant identity federation.
236
237 ### Minor Changes
238 - na_sg_org_container - supports deletion of buckets when `state` is set to `absent`.
239
240 ### Bug Fixes
241 - na_sg_org_container - fix issue with applying compliance settings on buckets.
242
243 ## 20.11.0
244
245 ### New Modules
246
247 - na_sg_grid_info: Gather StorageGRID Grig subset information
248 - na_sg_org_info: Gather StorageGRID Org subset information
249
250 ### Minor Changes
251
252 - na_sg_grid_account: new option `root_access_account` for granting initial root access permissions for the tenant to an existing federated group
253
254 ## 20.10.0
255
256 ### Breaking Changes
257
258 This version introduces a breaking change. All modules have been renamed from `nac_sg_*` to `na_sg_*`. Playbooks and Roles must be updated to match.
259
260 ### Bug Fixes
261
262 - na_sg_grid_account: fixed documentation issue.
263 - na_sg_grid_account: added `no_log` flag to password fields
264 - na_sg_grid_group: fixed group name parsing
265 - na_sg_org_group: fixed group name parsing
266
267 ### New Options
268
269 - na_sg_grid_account: new option `update_password` for managing Tenant Account root password changes
270 - na_sg_org_user: new option `password` and `update_password` for setting or updating Tenant User passwords
271 - na_sg_grid_user: new option `password` and `update_password` for setting or updating Grid Admin User passwords
272
273 ## 20.6.1
274
275 ### Minor Changes
276 - Fixed documentation issue in README.md
277
278 ### Bug Fixes
279 - nac_sg_org_container: fixed documentation issue.
280
281 ## 20.6.0
282
283 Initial release of NetApp StorageGRID Ansible modules
284
285 ### New Modules
286
287 - nac_sg_grid_account: create/modify/delete Tenant account
288 - nac_sg_grid_dns: set Grid DNS servers
289 - nac_sg_grid_group: create/modify/delete Grid admin group
290 - nac_sg_grid_ntp: set Grid NTP servers
291 - nac_sg_grid_regions: set Grid Regions
292 - nac_sg_grid_user: create/modify/delete Grid admin user
293 - nac_sg_org_container: create S3 bucket
294 - nac_sg_org_group: create/modify/delete Tenant group
295 - nac_sg_org_user: create/modify/delete Tenant user
296 - nac_sg_org_user_s3_key: create/delete S3 key
297
298 ## License
299 GNU General Public License v3.0
300 See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.