ibm.spectrum_virtualize.ibm_sv_manage_awss3_cloudaccount module – This module configures and manages Amazon Simple Storage Service (Amazon S3) cloud account on IBM Spectrum Virtualize family storage systems
Note
This module is part of the ibm.spectrum_virtualize collection (version 2.0.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 ibm.spectrum_virtualize
.
To use it in a playbook, specify: ibm.spectrum_virtualize.ibm_sv_manage_awss3_cloudaccount
.
New in ibm.spectrum_virtualize 1.11.0
Synopsis
Ansible interface to manage mkcloudaccountawss3, chcloudaccountawss3, and rmcloudaccount commands.
Parameters
Parameter |
Comments |
---|---|
Specifies the public part of the Amazon S3 access key credential of the AWS user that the system use to access the cloud storage. |
|
Specifies the prefix for the bucket object. Applies, when state=present, to create an Amazon S3 account. |
|
The hostname or management IP of the Spectrum Virtualize storage system. |
|
Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername. |
|
Specifies the download bandwidth limit in megabits per second (Mbps). The value must be a number 1-10240. |
|
Specifies whether to encrypt the data in the cloud account. By default, encryption is enabled if encryption is enabled on the cluster unless encrypt=no is specified. Valid when state=present to create an Amazon S3 account. Choices:
|
|
Specify to change the access key whether the new access key works or not. Valid when state=present to update an existing Amazon S3 account. Parameter is allowed only when accesskeyid and secretaccesskey are entered. Choices:
|
|
Specifies that the system’s data be imported. Valid when state=present to update an existing Amazon S3 account. |
|
Path of debug log file. |
|
Specifies the new or modified cloud account mode. Valid when state=present to update an existing Amazon S3 account. Choices:
|
|
Specifies the name of an Amazon S3 account. |
|
Specifies the old name of an Amazon S3 account. Valid when state=present, to rename the existing Amazon S3 account. |
|
REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Specifies a refresh of the system import candidates. If the account is in import mode, this parameter specifies a refresh of the data available for import. Choices:
|
|
Specifies the AWS region to use to access the cloud account and store data. |
|
Resets the usage history (to 0). Storage consumption that reflects the space that is consumed on the cloud account is cumulative, which means that it remains in the current day row (the 0th row). Valid when state=present to update an existing Amazon S3 account. Choices:
|
|
Specifies the secret access key of an Amazon S3 cloud account. |
|
Creates, updates ( Choices:
|
|
The authentication token to verify a user on the Spectrum Virtualize storage system. To generate a token, use the ibm.spectrum_virtualize.ibm_svc_auth module. |
|
Specifies the upload bandwidth limit in megabits per second (Mbps). The value must be a number 1-10240. |
|
REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Configure Amazon S3 account
ibm.spectrum_virtualize.ibm_sv_manage_awss3_cloudaccount:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
name: awss3
bucketprefix: "{{bucketprefix}}"
accesskeyid: "{{accesskeyid}}"
secretaccesskey: "{{secretaccesskey}}"
state: present
- name: Update Amazon S3 account configuration
ibm.spectrum_virtualize.ibm_sv_manage_awss3_cloudaccount:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
name: awss3
upbandwidthmbits: "{{upbandwidthmbits}}"
downbandwidthmbits: "{{downbandwidthmbits}}"
state: present
- name: Update Amazon S3 account mode to import
ibm.spectrum_virtualize.ibm_sv_manage_awss3_cloudaccount:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
name: awss3
mode: import
importsystem: 123456789
state: present
- name: Delete Amazon S3 account configuration
ibm.spectrum_virtualize.ibm_sv_manage_awss3_cloudaccount:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
name: awss3
state: absent