openstack.cloud.share_type_info module – Get OpenStack share type details

Note

This module is part of the openstack.cloud collection (version 2.5.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 openstack.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: openstack.cloud.share_type_info.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Get share type details in OpenStack Manila.
Get share type access details for private share types.
Uses Manila API microversion 2.50 to retrieve complete share type information including is_default field.
Safely falls back to basic information if microversion 2.50 is not supported by the backend.
Private share types can only be accessed by UUID.

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

python >= 3.6
openstacksdk >= 1.0.0

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, user_domain_name or 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.
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.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: `"admin"` `"internal"` `"public"` ← (default)
name string / required	Share type name or id. For private share types, the UUID must be used instead of name.
region_name string	Name of the region.
sdk_log_level string	Log level of the OpenStackSDK Choices: `"INFO"` ← (default) `"DEBUG"`
sdk_log_path string	Path to the logfile of the OpenStackSDK. If empty no log is written
timeout integer	How long should ansible wait for the requested resource. Default: `180`
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `true`. Choices: `false` `true`
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: Get share type details
  openstack.cloud.share_type_info:
    name: manila-generic-share

- name: Get share type details by id
  openstack.cloud.share_type_info:
    name: fbadfa6b-5f17-4c26-948e-73b94de57b42

Return Values

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

Key	Description
share_type dictionary	Dictionary describing share type Returned: On success
description string	share type description Available when Manila API microversion 2.50 is supported Falls back to empty string if microversion is not available Returned: success Sample: `"Default Manila share type"`
id string	share type uuid Returned: success Sample: `"59575cfc-3582-4efc-8eee-f47fcb25ea6b"`
is_default boolean	whether this is the default share type Retrieved from the API response when microversion 2.50 is supported Falls back to null if microversion is not available or field is not present Returned: success Sample: `true`
is_public boolean	whether the share type is public (true) or private (false) Returned: success Sample: `true`
name string	share type name Returned: success Sample: `"default"`
optional_extra_specs dictionary	Optional extra specifications for the share type Returned: success Sample: `{"create_share_from_snapshot_support": "True", "snapshot_support": "True"}`
required_extra_specs dictionary	Required extra specifications for the share type Returned: success Sample: `{"driver_handles_share_servers": "True"}`

Authors

OpenStack Ansible SIG

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/share_type_info_module.html