ibm.storage_virtualize.ibm_sv_manage_awss3_cloudaccount (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage mkcloudaccountawss3, chcloudaccountawss3, and rmcloudaccount commands.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure Amazon S3 account
  ibm.storage_virtualize.ibm_sv_manage_awss3_cloudaccount:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    name: awss3
    bucketprefix: "{{bucketprefix}}"
    accesskeyid: "{{accesskeyid}}"
    secretaccesskey: "{{secretaccesskey}}"
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update Amazon S3 account configuration
  ibm.storage_virtualize.ibm_sv_manage_awss3_cloudaccount:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    name: awss3
    upbandwidthmbits: "{{upbandwidthmbits}}"
    downbandwidthmbits: "{{downbandwidthmbits}}"
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update Amazon S3 account mode to import
  ibm.storage_virtualize.ibm_sv_manage_awss3_cloudaccount:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    name: awss3
    mode: import
    importsystem: 123456789
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete Amazon S3 account configuration
  ibm.storage_virtualize.ibm_sv_manage_awss3_cloudaccount:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    name: awss3
    state: absent

Inputs

    
mode:
    choices:
    - import
    - normal
    description:
    - Specifies the new or modified cloud account mode.
    - Valid when I(state=present) to update an existing Amazon S3 account.
    type: str

name:
    description:
    - Specifies the name of an Amazon S3 account.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Creates, updates (C(present)), or deletes (C(absent)) an Amazon S3 account.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the M(ibm.storage_virtualize.ibm_svc_auth) module.
    type: str

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

region:
    description:
    - Specifies the AWS region to use to access the cloud account and store data.
    type: str

encrypt:
    choices:
    - 'yes'
    - 'no'
    description:
    - Specifies whether to encrypt the data in the cloud account.
    - By default, encryption is enabled if encryption is enabled on the cluster unless
      I(encrypt=no) is specified.
    - Valid when I(state=present) to create an Amazon S3 account.
    type: str

refresh:
    description:
    - 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.
    type: bool

log_path:
    description:
    - Path of debug log file.
    type: str

old_name:
    description:
    - Specifies the old name of an Amazon S3 account.
    - Valid when I(state=present), to rename the existing Amazon S3 account.
    type: str

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

accesskeyid:
    description:
    - Specifies the public part of the Amazon S3 access key credential of the AWS user
      that the system use to access the cloud storage.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

bucketprefix:
    description:
    - Specifies the prefix for the bucket object.
    - Applies, when I(state=present), to create an Amazon S3 account.
    type: str

importsystem:
    description:
    - Specifies that the system's data be imported.
    - Valid when I(state=present) to update an existing Amazon S3 account.
    type: str

ignorefailures:
    description:
    - Specify to change the access key whether the new access key works or not.
    - Valid when I(state=present) to update an existing Amazon S3 account.
    - Parameter is allowed only when I(accesskeyid) and I(secretaccesskey) are entered.
    type: bool

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool

secretaccesskey:
    description:
    - Specifies the secret access key of an Amazon S3 cloud account.
    type: str

upbandwidthmbits:
    description:
    - Specifies the upload bandwidth limit in megabits per second (Mbps).
    - The value must be a number 1-10240.
    type: str

resetusagehistory:
    description:
    - 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 I(state=present) to update an existing Amazon S3 account.
    type: bool

downbandwidthmbits:
    description:
    - Specifies the download bandwidth limit in megabits per second (Mbps).
    - The value must be a number 1-10240.
    type: str