- 4. Using the OpenStack SDK
- Service Proxies
- SFS Turbo API
SFS Turbo API¶
The Shared File System Turbo Class¶
The SFS Turbo high-level interface is available through the sfsturbo
member of a Connection
object. The
sfsturbo
member will only be added if the
otcextensions.sdk.register_otc_extensions(conn)
method is called.
Share Operations¶
- class otcextensions.sdk.sfsturbo.v1._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- shares(**query)
Return a generator of sfs turbo file systems
- Parameters:
query (dict) – Optional query parameters to be sent to limit the resources being returned.
- Returns:
A generator of share objects
- Return type:
- delete_share(share, ignore_missing=True)
Delete a sfs turbo file system
- Parameters:
share – share id or an instance of
Share
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the vpc route does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent route.
- Returns:
none
- get_share(share)
Get a sfs turbo file system by id
- find_share(name_or_id, ignore_missing=True)
Find a single sfs turbo file system by id
- Parameters:
name_or_id – The name or ID of a share
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the vpc does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent peering.
- Returns:
One
Share
- extend_capacity(share, new_size)
Extend the capacity of the file system
- Parameters:
share – The value can be the ID of a share or a
Share
instance.new_size – Specifies the new capacity (GB) of the shared file system.
- change_security_group(share, security_group_id)
Change the security group bound to an SFS Turbo file system.
- Parameters:
share – The value can be the ID of a share or a
Share
instance.security_group_id – Specifies the ID of the security group to be modified.