opentelekomcloud.cloud.sfsturbo_share (0.14.2) — module

Manage SFS Turbo file system.

| "added in version" 0.15.0 of opentelekomcloud.cloud"

Authors: Gubina Polina (@Polina-Gubina)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Manage SFS Turbo file system from the OTC.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create sfs turbo share
  opentelekomcloud.cloud.sfsturbo_share:
    name: "test_share_1"
    share_proto: "NFS"
    share_type: "STANDARD"
    size: 100
    availability_zone: 'eu-de-01'
    vpc_id: "vpc_uuid"
    subnet_id: "subnet_uuid"
    security_group_id: "security_group_uuid"
  register: share
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Extend capacity sfs turbo share
  opentelekomcloud.cloud.sfsturbo_share:
    name: "test_share_1"
    size: 200
    security_group_id: "security_group_uuid"
  register: share
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Change security group
  opentelekomcloud.cloud.sfsturbo_share:
    name: "test_share_1"
    size: 200
    security_group_id: "security_group_uuid"
  register: share
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete sfs turbo share
  opentelekomcloud.cloud.sfsturbo_share:
    name: "test_share_1"
    state: absent

Inputs

    
id:
    description:
    - Specifies the id of the SFS Turbo file system.
    type: str

auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
      param will need to contain whatever parameters that auth plugin requires. This parameter
      is not needed if a named cloud is provided or OpenStack OS_* environment variables
      are present.
    type: dict

name:
    description:
    - Specifies the name of the SFS Turbo file system.
    type: str

size:
    description:
    - For a common file system, the value of capacity ranges from 500 to 32768 (in the
      unit of GB). For an enhanced file system where the expand_type field is specified
      for metadata, the capacity ranges from 10240 to 327680.
    - Can be extended, but it is possible only to set size bigger than current one.
    type: int

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether resource should be present or absent.
    type: str

vpc_id:
    description:
    - Specifies the VPC ID of a tenant in a region.
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 600
    description:
    - Specifies the timeout.
    type: int

metadata:
    description:
    - Specifies the metadata information used to create the file system.
    suboptions:
      crypt_key_id:
        description:
        - Specifies the ID of a KMS professional key when an encrypted file system is
          created.
        type: str
      expand_type:
        description:
        - Specifies the extension type. The current valid value is bandwidth, indicating
          that an enhanced file system is created.
        type: str
    type: dict

auth_type:
    description:
    - Name of the auth plugin to use. If the cloud uses something other than password
      authentication, the name of the plugin should be indicated here and the contents
      of the I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

subnet_id:
    description:
    - Specifies the network ID of the subnet of a tenant in a VPC.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

share_type:
    choices:
    - STANDARD
    - PERFORMANCE
    description:
    - Specifies the file system type.  Standard file system, corresponding to the media
      of SAS disks. Performance file system, corresponding to the media of SSD disks.
    type: str

api_timeout:
    description:
    - How long should the socket layer wait before timing out for API calls. If this is
      omitted, nothing will be passed to the requests library.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

description:
    description:
    - Specifies the file system description. The length is 0-255 characters.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

share_proto:
    description:
    - Specifies the protocol of the file system. The valid value is NFS. Network File
      System (NFS) is a distributed file system protocol that allows different computers
      and operating systems to share data over a network.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

availability_zone:
    description:
    - Specifies the code of the AZ where the file system is located.
    type: str

security_group_id:
    description:
    - Specifies the security group ID of a tenant in a region. Can be updated.
    type: str

Outputs

share:
  contains:
    id:
      description: Specifies the ID of the SFS Turbo file system.
      type: str
    name:
      description: Specifies the name of the SFS Turbo file system.
      type: str
    status:
      description: Specifies the status of the SFS Turbo file system.
      type: str
  description: Share object.
  returned: On Success.
  type: complex