The high-level interface for accessing the shared file systems service API is
available through the shared_file_system
member of a Connection
object. The shared_file_system
member will only
be added if the service is detected. share
is an alias of the
shared_file_system
member.
Interact with Availability Zones supported by the Shared File Systems service.
Retrieve shared file system availability zones
A generator of availability zone resources
Interact with Shares supported by the Shared File Systems service.
Lists all shares with details
query (kwargs) –
Optional query parameters to be sent to limit the shares being returned. Available parameters include:
status: Filters by a share status
share_server_id: The UUID of the share server.
metadata: One or more metadata key and value pairs as a url encoded dictionary of strings.
extra_specs: The extra specifications as a set of one or more key-value pairs.
share_type_id: The UUID of a share type to query resources by.
name: The user defined name of the resource to filter resources by.
snapshot_id: The UUID of the share’s base snapshot to filter the request based on.
host: The host name of the resource to query with.
share_network_id: The UUID of the share network to filter resources by.
project_id: The ID of the project that owns the resource.
is_public: A boolean query parameter that, when set to true, allows retrieving public resources that belong to all projects.
share_group_id: The UUID of a share group to filter resource.
export_location_id: The export location UUID that can be used to filter shares or share instances.
export_location_path: The export location path that can be used to filter shares or share instances.
name~: The name pattern that can be used to filter shares, share snapshots, share networks or share groups.
description~: The description pattern that can be used to filter shares, share snapshots, share networks or share groups.
with_count: Whether to show count in API response or not, default is False.
limit: The maximum number of shares to return.
offset: The offset to define start point of share or share group listing.
sort_key: The key to sort a list of shares.
sort_dir: The direction to sort a list of shares. A valid value is asc, or desc.
Details of shares resources
Find a single share
name_or_id – The name or ID of a share.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Share
or None
Lists details of a single share
share – The ID of the share to get
Details of the identified share
Deletes a single share
share – The ID of the share to delete
Result of the delete
None
Updates details of a single share.
share – The ID of the share to update
attrs (dict) – The attributes to update on the share
the updated share
Creates a share from attributes
Details of the new share
attrs (dict) – Attributes which will be used to create
a Shares
,
comprised of the properties on the Shares class. ‘size’ and ‘share’
are required to create a share.
the most recent one known to manila.
share_id – The ID of the share to revert
snapshot_id – The ID of the snapshot to revert to
Result of the revert
None
Manage a share.
protocol (str) – The shared file systems protocol of this share.
export_path (str) – The export path formatted according to the protocol.
service_host (str) – The manage-share service host.
params (kwargs) – Optional parameters to be sent. Available parameters include: * name: The user defined name of the resource. * share_type: The name or ID of the share type to be used to create the resource. * driver_options: A set of one or more key and value pairs, as a dictionary of strings, that describe driver options. * is_public: The level of visibility for the share. * description: The user defiend description of the resource. * share_server_id: The UUID of the share server.
The share that was managed.
Unmanage the share with the given share ID.
share_id – The ID of the share to unmanage.
None
Resizes a share, extending/shrinking the share as needed.
share_id – The ID of the share to resize
new_size – The new size of the share in GiBs. If new_size is the same as the current size, then nothing is done.
no_shrink (bool) – If set to True, the given share is not shrunk, even if shrinking the share is required to get the share to the given size. This could be useful for extending shares to a minimum size, while not shrinking shares to the given size. This defaults to False.
no_extend (bool) – If set to True, the given share is not extended, even if extending the share is required to get the share to the given size. This could be useful for shrinking shares to a maximum size, while not extending smaller shares to that maximum size. This defaults to False.
force (bool) – Whether or not force should be used, in the case where the share should be extended.
None
Interact with the storage pool statistics exposed by the Shared File Systems Service.
Lists all back-end storage pools with details
query (kwargs) –
Optional query parameters to be sent to limit the storage pools being returned. Available parameters include:
pool_name: The pool name for the back end.
host_name: The host name for the back end.
backend_name: The name of the back end.
capabilities: The capabilities for the storage back end.
share_type: The share type name or UUID.
A generator of manila storage pool resources
View and manipulate asynchronous user messages emitted by the Shared File Systems service.
List shared file system user messages
query (kwargs) –
Optional query parameters to be sent to limit the messages being returned. Available parameters include:
action_id: The ID of the action during which the message was created.
detail_id: The ID of the message detail.
limit: The maximum number of shares to return.
message_level: The message level.
offset: The offset to define start point of share or share group listing.
sort_key: The key to sort a list of messages.
sort_dir: The direction to sort a list of shares.
project_id: The ID of the project for which the message was created.
request_id: The ID of the request during which the message was created.
resource_id: The UUID of the resource for which the message was created.
resource_type: The type of the resource for which the message was created.
A generator of user message resources
List details of a single user message
message_id – The ID of the user message
Details of the identified user message
Deletes a single user message
message_id – The ID of the user message
Result of the “delete” on the user message
Get absolute limits of resources supported by the Shared File Systems service.
Lists all share limits.
query (kwargs) – Optional query parameters to be sent to limit the share limits being returned.
A generator of manila share limits resources
Interact with Share Snapshots supported by the Shared File Systems service.
Lists all share snapshots with details.
query (kwargs) –
Optional query parameters to be sent to limit the snapshots being returned. Available parameters include:
project_id: The ID of the user or service making the API request.
A generator of manila share snapshot resources
Lists details of a single share snapshot
snapshot_id – The ID of the snapshot to get
Details of the identified share snapshot
Creates a share snapshot from attributes
Details of the new share snapshot
Updates details of a single share.
snapshot_id – The ID of the snapshot to update
The attributes to update on the snapshot
the updated share snapshot
Deletes a single share snapshot
snapshot_id – The ID of the snapshot to delete
Result of the delete
None
Interact with Share Snapshot Instances supported by the Shared File Systems service.
Lists all share snapshot instances with details.
details (bool) – Whether to fetch detailed resource descriptions. Defaults to True.
query (kwargs) –
Optional query parameters to be sent to limit the share snapshot instance being returned. Available parameters include:
the request based on.
request.
A generator of share snapshot instance resources
ShareSnapshotInstance
Lists details of a single share snapshot instance
snapshot_instance_id – The ID of the snapshot instance to get
Details of the identified snapshot instance
ShareSnapshotInstance
Create and manipulate Share Networks with the Shared File Systems service.
Lists all share networks with details.
query (dict) –
Optional query parameters to be sent to limit the resources being returned. Available parameters include:
name~: The user defined name of the resource to filter resources by.
project_id: The ID of the user or service making the request.
description~: The description pattern that can be used to filter shares, share snapshots, share networks or share groups.
all_projects: (Admin only). Defines whether to list the requested resources for all projects.
Details of shares networks
ShareNetwork
Lists details of a single share network
share_network – The ID of the share network to get
Details of the identified share network
ShareNetwork
Deletes a single share network
share_network_id – The ID of the share network to delete
None
Updates details of a single share network.
share_network_id – The ID of the share network to update
The attributes to update on the share network
the updated share network
ShareNetwork
Creates a share network from attributes
Details of the new share network
attrs (dict) – Attributes which will be used to create
a ShareNetwork
,comprised of the properties
on the ShareNetwork class.
ShareNetwork
Administrators can list, show information for, explicitly set the state of, and force-delete share instances within the Shared File Systems Service.
Lists all share instances.
query (kwargs) – Optional query parameters to be sent to limit the share instances being returned. Available parameters include:
export_location_id: The export location UUID that can be used to filter share instances.
export_location_path: The export location path that can be used to filter share instances.
Details of share instances resources
ShareInstance
Shows details for a single share instance
share_instance_id – The UUID of the share instance to get
Details of the identified share instance
ShareInstance
Explicitly updates the state of a share instance.
share_instance_id – The UUID of the share instance to reset.
status – The share or share instance status to be set.
None
Force-deletes a share instance
share_instance – The ID of the share instance to delete
None
Create and manipulate Share Network Subnets with the Shared File Systems service.
Lists all share network subnets with details.
share_network_id – The id of the share network for which Share Network Subnets should be listed.
A generator of manila share network subnets
Lists details of a single share network subnet.
share_network_id – The id of the share network associated with the Share Network Subnet.
share_network_subnet_id – The id of the Share Network Subnet to retrieve.
Details of the identified share network subnet
Creates a share network subnet from attributes
share_network_id – The id of the share network wthin which the the Share Network Subnet should be created.
attrs (dict) – Attributes which will be used to create a share network subnet.
Details of the new share network subnet.
Deletes a share network subnet.
share_network_id – The id of the Share Network associated with the Share Network Subnet.
share_network_subnet – The id of the Share Network Subnet which should be deleted.
Result of the delete
None
Create, View, and Delete access rules for shares from the Shared File Systems service.
Lists the access rules on a share.
A generator of the share access rules.
ShareAccessRules
List details of an access rule.
access_id – The id of the access rule to get
Details of the identified access rule.
ShareAccessRules
Creates an access rule from attributes
Details of the new access rule
share_id – The ID of the share
attrs (dict) – Attributes which will be used to create
a ShareAccessRules
, comprised of the
properties on the ShareAccessRules class.
ShareAccessRules
Deletes an access rule
access_id – The id of the access rule to get
share_id – The ID of the share
requests.models.Response
HTTP response from internal
requests client
Interact with Share groups supported by the Shared File Systems service.
Lists all share groups.
query (kwargs) –
Optional query parameters to be sent to limit the share groups being returned. Available parameters include:
status: Filters by a share group status.
by.
to filter resources.
project_id: The project ID of the user or service.
share_server_id: The UUID of the share server.
the request based on.
host: The host name for the back end.
resources by.
share groups.
list the share group.
filtering share groups.
limit: The maximum number of share groups members to return.
group listing.
sort_key: The key to sort a list of shares.
sort_dir: The direction to sort a list of shares
share snapshots, share networks or share groups.
filter shares, share snapshots, share networks or share groups.
A generator of manila share group resources
ShareGroup
Lists details for a share group.
share – The ID of the share group to get
Details of the identified share group
ShareGroup
Finds a single share group
name_or_id – The name or ID of a share group.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
One ShareGroup
or None
Creates a share group from attributes
Details of the new share group
ShareGroup
Updates details of a single share group
share – The ID of the share group
Updated details of the identified share group
ShareGroup
Deletes a single share group
share – The ID of the share group
Result of the “delete” on share group
ShareGroup
Interact with Share Group Snapshots by the Shared File Systems service.
Lists all share group snapshots.
query (kwargs) –
Optional query parameters to be sent to limit the share group snapshots being returned. Available parameters include:
project_id: The ID of the project that owns the resource.
name: The user defined name of the resource to filter resources.
description: The user defined description text that can be used to filter resources.
status: Filters by a share status
share_group_id: The UUID of a share group to filter resource.
limit: The maximum number of share group snapshot members to return.
offset: The offset to define start point of share or share group listing.
sort_key: The key to sort a list of shares.
sort_dir: The direction to sort a list of shares. A valid value is asc, or desc.
Details of share group snapshots resources
ShareGroupSnapshot
Show share group snapshot details
group_snapshot_id – The ID of the group snapshot to get
Details of the group snapshot
ShareGroupSnapshot
Creates a point-in-time snapshot copy of a share group.
Details of the new snapshot
attrs (dict) – Attributes which will be used to create
a ShareGroupSnapshots
,
'share_group_id' – ID of the share group to have the snapshot taken.
ShareGroupSnapshot
Reset share group snapshot state.
group_snapshot_id – The ID of the share group snapshot to reset
status – The state of the share group snapshot to be set, A valid value is “creating”, “error”, “available”, “deleting”, “error_deleting”.
None
Updates a share group snapshot.
group_snapshot_id – The ID of the share group snapshot to update
attrs (dict) – The attributes to update on the share group snapshot
the updated share group snapshot
ShareGroupSnapshot
Deletes a share group snapshot.
group_snapshot_id – The ID of the share group snapshot to delete
None
List, Get, Create, Update, and Delete metadata for shares from the Shared File Systems service.
Lists all metadata for a share.
Retrieves a specific metadata item from a share by its key.
Creates share metadata as key-value pairs.
Updates metadata of given share.
Deletes a single metadata item on a share, idetified by its key.
share_id – The ID of the share
keys – The list of share metadata keys to be deleted
ignore_missing – Boolean indicating if missing keys should be ignored.
None
None
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.