openstack.shared_file_system.v2.share

Share 类

Share 类继承自 Resource。

class openstack.shared_file_system.v2.share.Share(_synchronized=False, connection=None, **attrs)

基础资源

参数：

  • _synchronized (bool) – 这不打算直接使用。请参阅 new() 和 existing()。

  • connection (openstack.connection.Connection) – 对正在使用的 Connection 的引用。默认为 None，允许在单元测试中等情况下使用不带活动 Connection 的 Resource 对象。Resource 代码中对 self._connection 的使用应使用 None 检查进行保护。

resource_key = 'share'

资源的单数形式的键。

resources_key = 'shares'

资源的复数形式的键。

base_path = '/shares'

此资源的 URI 的基本部分。

allow_create = True

允许对此资源进行创建操作。

allow_fetch = True

允许对此资源进行获取操作。

allow_commit = True

允许对此资源进行更新操作。

allow_list = True

允许对此资源进行列表操作。

allow_head = False

允许对此资源进行 head 操作。

allow_delete = True

允许对此资源进行删除操作。

access_rules_status

属性 Share 实例的访问规则状态。有效值为 active、error 或 syncing。

availability_zone

可用区。

created_at

资源在服务数据库中创建的日期和时间戳。

description

资源的由用户定义的描述。

host

Share 主机名。

is_public

Share 的可见性级别。

is_creating_new_share_from_snapshot_supported

此 Share 是否支持可以克隆为新 Share 的快照。

is_mounting_snapshot_supported

Share 的快照是否可以直接挂载并独立控制访问权限。

is_reverting_to_snapshot_supported

Share 是否可以还原到其最新快照。

is_snapshot_supported

一个额外的规范，用于按 Share 是否支持快照进行过滤后端。

is_replicated

指示 Share 是否具有副本。

metadata

一个或多个元数据键值对，以字符串字典的形式。

progress

共享创建的进度。

project_id

拥有资源的项目的 ID。

replication_type

Share 复制类型。有效值为 none、readable、writable 和 dr。

share_group_id

此 Share 属于的 Share 组的 UUID。

share_network_id

Share 网络 ID。

share_protocol

共享文件系统的协议。有效值为 NFS、CIFS、GlusterFS、HDFS、CephFS、MAPRFS

share_server_id

共享服务器的 UUID。

share_type

Share 类型的 UUID。在次要版本中，此参数是 Share 类型名称，以字符串形式。

share_type_name

共享类型的名称。

size

Share 大小，以 GiB 为单位。

snapshot_id

用于创建 Share 的快照的 UUID。

source_share_group_snapshot_member_id

用于创建此 Share 的组快照实例的 ID。

status

Share 状态

task_state

对于 Share 迁移，迁移任务状态。

user_id

创建 Share 的用户的 ID。

display_name

用于更新名称的显示名称

display_description

用于更新描述的显示描述

extend_share(session, new_size, force=False)

扩展 Share 大小。

参数：

  • new_size (float) – Share 的新大小，以 GiB 为单位。

  • force (bool) – 是否使用强制，绕过调度器。需要管理员权限。默认为 False。

返回值:

操作的结果。

返回类型:

无

shrink_share(session, new_size)

缩小 Share 大小。

参数：

new_size (float) – Share 的新大小，以 GiB 为单位。

返回值:

无

revert_to_snapshot(session, snapshot_id)

将 Share 还原到给定的快照。

参数：

snapshot_id (str) – 要还原到的快照的 ID。

返回值:

无

manage(session, protocol, export_path, service_host, **params)

管理共享。

参数：

  • session – 用于发送请求的会话对象。

  • protocol (str) – 此 Share 的共享文件系统协议。

  • export_path (str) – 根据协议格式化的导出路径。

  • service_host (str) – 管理 Share 的服务主机。

  • params (kwargs) –

    可选参数。可用参数包括

    • name：资源的自定义名称。

    • share_type：用于创建资源的 Share 类型名称或 ID。

    • driver_options：一组键值对，以字符串字典的形式，描述驱动程序选项。

    • is_public：Share 的可见性级别。

    • description：资源的自定义描述。

    • share_server_id：Share 服务器的 UUID。

返回值:

管理的 Share。

unmanage(session)

取消管理共享。

参数：

session – 用于发送请求的会话对象。

返回值:

无