VASTPY

此软件包是VMS（VAST管理系统）REST API的Python SDK。

在针对VMS API进行开发时，请使用本地可用的文档，地址为https://vms-host-name/docs。

安装

pip install vastpy

此软件包托管在PyPI上：https://pypi.ac.cn/project/vastpy/

SDK使用

初始化

from vastpy import VASTClient

client = VASTClient(user='user', password='********', address='vast-vms')

API很简单

client.<collection>.get()
client.<collection>.post()
client.<collection>[<object>].get()
client.<collection>[<object>].patch()
client.<collection>[<object>].delete()

访问集合

for view in client.views.get():
    print(view)

创建对象

policy, = client.viewpolicies.get(name='default')

view = client.views.post(path='/prod/pgsql', policy_id=policy['id'], create_dir=True)

修改/删除对象

view, = client.views.get(path='/prod/pgsql')

view = client.views[view['id']].patch(protocols=['NFS', 'SMB'])

client.views[view['id']].delete()

读取指标

client.monitors.ad_hoc_query.get(object_type='cluster',
                                 time_frame='5m',
				 prop_list=['ProtoMetrics,proto_name=ProtoCommon,iops',
				            'ProtoMetrics,proto_name=ProtoCommon,bw'])

CLI使用

凭据可以通过环境变量或参数传递

$ export VMS_USER=admin VMS_PASSWORD=******** VMS_ADDRESS=vast-file-server

$ vastpy-cli get snapshots fields=id,path
[
  {
    "path": "/dbs",
    "id": 12
  },
  {
    "path": "/datasets",
    "id": 43
  },
...

$ vastpy-cli --user=admin --password==******** --address=vast-file-server get snapshots fields=id,path

支持任何方法（get，post，patch，delete）

$ vastpy-cli post snapshots path=/projects/db name=db
{
  "id": 4707792,
  "name": "db_snapshot",
  "path": "/projects/db"
...

$ vastpy-cli post views path=/projects/db create_dir=true policy_id=1
{
  "id": 109,
  "guid": "551b5fc0-42a2-4b77-b385-d5bf6a6c1538",
  "name": "view-109",
  "title": "/projects/db",
...

$ vastpy-cli delete views/109

版本兼容性

此软件包与任何VAST版本兼容，因为它是无模式的。

Python对象被简单地转换为URL：client.collection[object].get() 被转换为 GET /api/collection/object。