netapp.ontap.na_ontap_s3_services module – NetApp ONTAP S3 services
Note
This module is part of the netapp.ontap collection (version 22.13.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.ontap.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_s3_services.
New in netapp.ontap 21.20.0
Synopsis
Create, delete or modify S3 Service
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, netapp-lib 2018.11.13 or later (install using ‘pip install netapp-lib’), netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
A physical or virtual clustered Data ONTAP system, the modules support Data ONTAP 9.1 and onward, REST support requires ONTAP 9.6 or later.
Parameters
Parameter |
Comments |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
name of https certificate to use for the service |
|
comment about the service |
|
enable or disable the service 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. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
Specifies whether HTTP is enabled on the S3 server being created or modified Choices:
|
|
Specifies whether HTTPS is enabled on the S3 server being created or modified Choices:
|
|
path to SSL client key file. |
|
The name of the S3 service. |
|
Password for the specified user. |
|
Specifies the HTTP listener port for the S3 server Default: |
|
Specifies the HTTPS listener port for the S3 server Default: |
|
Whether the specified S3 bucket should exist or not. Choices:
|
|
This module only supports REST. always – will always use the REST API. A warning is issued if the module does not support REST. Default: |
|
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/. Two authentication methods are supported
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
Name of the vserver to use. |
Notes
Note
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Examples
- name: create or modify s3 service
na_ontap_s3_services:
state: present
name: carchi-test
vserver: ansibleSVM
comment: not enabled
enabled: False
certificate_name: ansibleSVM_16E1C1284D889609
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
use_rest: always
- name: create or modify s3 service with https
na_ontap_s3_services:
state: present
name: carchi-test
vserver: ansibleSVM
comment: not enabled
enabled: True
is_https_enabled: True
port: 80
certificate_name: ansibleSVM_16E1C1284D889609
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
use_rest: always
- name: delete s3 service
na_ontap_s3_services:
state: absent
name: carchi-test
vserver: ansibleSVM
certificate_name: ansibleSVM_16E1C1284D889609
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
use_rest: always
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Returns S3 service response. Returned: on creation or modification of S3 service Sample: |