opentelekomcloud.cloud.sfsturbo_share module – Manage SFS Turbo file system.

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.2).

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 opentelekomcloud.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: opentelekomcloud.cloud.sfsturbo_share.

New in opentelekomcloud.cloud 0.15.0

Synopsis

• Manage SFS Turbo file system from the OTC.

Requirements

The below requirements are needed on the host that executes this module.

• openstacksdk

• openstacksdk >= 0.36.0

• otcextensions

• python >= 3.6

Parameters

Parameter	Comments
api_timeout integer	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.
auth dictionary	Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or 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.
auth_type string	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 auth parameter should be updated accordingly.
availability_zone string	Specifies the code of the AZ where the file system is located.
ca_cert aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
cloud any	Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
description string	Specifies the file system description. The length is 0-255 characters.
id string	Specifies the id of the SFS Turbo file system.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
metadata dictionary	Specifies the metadata information used to create the file system.
crypt_key_id string	Specifies the ID of a KMS professional key when an encrypted file system is created.
expand_type string	Specifies the extension type. The current valid value is bandwidth, indicating that an enhanced file system is created.
name string	Specifies the name of the SFS Turbo file system.
region_name string	Name of the region.
sdk_log_level string	Log level of the OpenStackSDK Choices: "ERROR" "WARN" ← (default) "INFO" "DEBUG"
sdk_log_path string	Path to the logfile of the OpenStackSDK. If empty no log is written
security_group_id string	Specifies the security group ID of a tenant in a region. Can be updated.
share_proto string	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.
share_type string	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. Choices: "STANDARD" "PERFORMANCE"
size integer	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.
state string	Whether resource should be present or absent. Choices: "present" ← (default) "absent"
subnet_id string	Specifies the network ID of the subnet of a tenant in a VPC.
timeout integer	Specifies the timeout. Default: 600
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: false true
vpc_id string	Specifies the VPC ID of a tenant in a region.
wait boolean	Should ansible wait until the requested resource is complete. Choices: false true ← (default)

Notes

Note

• The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

• Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

- 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

- name: Extend capacity sfs turbo share
  opentelekomcloud.cloud.sfsturbo_share:
    name: "test_share_1"
    size: 200
    security_group_id: "security_group_uuid"
  register: share

- name: Change security group
  opentelekomcloud.cloud.sfsturbo_share:
    name: "test_share_1"
    size: 200
    security_group_id: "security_group_uuid"
  register: share

- name: Delete sfs turbo share
  opentelekomcloud.cloud.sfsturbo_share:
    name: "test_share_1"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
share complex	Share object. Returned: On Success.
id string	Specifies the ID of the SFS Turbo file system. Returned: success
name string	Specifies the name of the SFS Turbo file system. Returned: success
status string	Specifies the status of the SFS Turbo file system. Returned: success

Authors

• Gubina Polina (@Polina-Gubina)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)

last updated: 2024-04-26 16:19