Skip to content

FileSystemSnapshots1dot1Api.md

Latest commit

 

History

History
218 lines (154 loc) · 7.66 KB

FileSystemSnapshots1dot1Api.md

File metadata and controls

218 lines (154 loc) · 7.66 KB

purity_fb.FileSystemSnapshots1dot1Api

All URIs are relative to https://purity_fb_server/api

Method HTTP request Description
create_file_system_snapshots POST /1.1/file-system-snapshots
delete_file_system_snapshots DELETE /1.1/file-system-snapshots
list_file_system_snapshots GET /1.1/file-system-snapshots
update_file_system_snapshots PATCH /1.1/file-system-snapshots

create_file_system_snapshots

FileSystemSnapshotResponse create_file_system_snapshots(sources, suffix=suffix)

Create snapshots for the specified source file systems

Example

from purity_fb import PurityFb, SnapshotSuffix, rest

fb = PurityFb("10.255.9.28", version=1.1) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # create a snapshot for the file system named myfs
        res = fb.file_system_snapshots.create_file_system_snapshots(sources=["myfs"])
        print(filesystem_snap_response)
        # create a snapshot with suffix mysnap for the file system named myfs
        res = fb.file_system_snapshots.create_file_system_snapshots(sources=["myfs"], suffix=SnapshotSuffix("mysnap"))
        print(filesystem_snap_response)
    except rest.ApiException as e:
        print("Exception when creating file system snapshots: %s\n" % e)

Parameters

Name Type Description Notes
sources list[str] a list of names of source file systems
suffix SnapshotSuffix the suffix of the snapshot [optional]

Return type

FileSystemSnapshotResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

delete_file_system_snapshots

delete_file_system_snapshots(name)

Delete a file system snapshot by name

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=1.2) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # delete a file system snapshot named myfs.mysnap
        fb.file_system_snapshots.delete_file_system_snapshots(name="myfs.mysnap")
    except rest.ApiException as e:
        print("Exception when deleting file system snapshots: %s\n" % e)

Parameters

Name Type Description Notes
name str name of the file system snapshot to be deleted

Return type

void (empty response body)

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

list_file_system_snapshots

FileSystemSnapshotResponse list_file_system_snapshots(filter=filter, sort=sort, start=start, limit=limit, token=token, total=total, total_only=total_only, names_or_sources=names_or_sources)

List file system snapshots

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=1.1) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # list all file system snapshots
        fb.file_system_snapshots.list_file_system_snapshots()
        # list with page size 5, and sort by source file system name
        res = fb.file_system_snapshots.list_file_system_snapshots(limit=5, sort="source")
        # list all remaining file system snapshots
        res = fb.file_system_snapshots.list_file_system_snapshots(token=res.pagination_info.continuation_token)
        # list with filter
        res = fb.file_system_snapshots.list_file_system_snapshots(filter='source=\'myfs*\' and contains(suffix, \'1\')')
    except rest.ApiException as e:
        print("Exception when listing file system snapshots: %s\n" % e)

Parameters

Name Type Description Notes
filter str The filter to be used for query. [optional]
sort str The way to order the results. [optional]
start int start [optional]
limit int limit, should be >= 0 [optional]
token str token [optional]
total bool return a total object in addition to the other results [optional] [default to false]
total_only bool return only the total object [optional] [default to false]
names_or_sources list[str] a list of names of snapshots or source file systems [optional]

Return type

FileSystemSnapshotResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

update_file_system_snapshots

FileSystemSnapshotResponse update_file_system_snapshots(name, attributes)

Update an existing file system snapshot

Example

from purity_fb import PurityFb, FileSystemSnapshot, rest

fb = PurityFb("10.255.9.28", version=1.2) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    # create a local file system snapshot object with destroyed field being true
    new_attr = FileSystemSnapshot(destroyed=True)
    try:
        # destroying the file system snapshot myfs.snap
        res = fb.file_system_snapshots.update_file_system_snapshots(name="myfs.snap", attributes=new_attr)
        print(res)
    except rest.ApiException as e:
        print("Exception when updating file system snapshot: %s\n" % e)

Parameters

Name Type Description Notes
name str the name of the file system snapshot to be updated
attributes FileSystemSnapshot the new attributes, only modifiable fields could be used.

Return type

FileSystemSnapshotResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]