na_ontap_object_store – NetApp ONTAP manage object store config
New in version 2.9.
Synopsis
- Create or delete object store config on ONTAP.
Requirements
The below requirements are needed on the host that executes this module.
- A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
- Ansible 2.6
- Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
- Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
- To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
access_key
string
|
Access key ID for AWS_S3 and SGWS provider types.
|
|
container
string
|
Data bucket/container name used in S3 requests.
|
|
hostname
string /
required
|
The hostname or IP address of the ONTAP instance.
|
|
http_port
integer
|
Override the default port (80 or 443) with this port
|
|
https
boolean
|
|
Enable and disable https
|
name
string /
required
|
The name of the object store config to manage.
|
|
ontapi
integer
|
The ontap api version to use
|
|
password
string /
required
|
Password for the specified user.
aliases: pass |
|
provider_type
string
|
The name of the object store config provider.
|
|
secret_password
string
|
Secret access key for AWS_S3 and SGWS provider types.
|
|
server
string
|
Fully qualified domain name of the object store config.
|
|
state
string
|
|
Whether the specified object store config should exist or not.
|
use_rest
string
|
|
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
Always -- will always use the REST API
Never -- will always use the ZAPI
Auto -- will try to use the REST Api
|
username
string /
required
|
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation
https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.
aliases: user |
|
validate_certs
boolean
|
|
If set to
no , the SSL certificates will not be validated.
This should only set to
False used on personally controlled sites using self-signed certificates.
|
Notes
Note
- The modules prefixed with na\_ontap are built to support the ONTAP storage platform.
Examples
- name: object store Create na_ontap_object_store: state: present name: ansible provider_type: SGWS server: abc container: abc access_key: s3.amazonaws.com secret_password: abc hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: object store Create na_ontap_object_store: state: absent name: ansible hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}"
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/na_ontap_object_store_module.html