purity_fb.FileSystemSnapshotsApi

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

Method	HTTP request	Description
create_file_system_snapshots	POST /1.0/file-system-snapshots
list_file_system_snapshots	GET /1.0/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 __future__ import print_function
import time
import purity_fb
from purity_fb.rest import ApiException
from pprint import pprint

# Configure API key authorization: AuthTokenHeader
purity_fb.configuration.api_key['x-auth-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# purity_fb.configuration.api_key_prefix['x-auth-token'] = 'Bearer'

# create an instance of the API class
api_instance = purity_fb.FileSystemSnapshotsApi()
sources = ['sources_example'] # list[str] | a list of names of source file systems
suffix = purity_fb.SnapshotSuffix() # SnapshotSuffix | the suffix of the snapshot (optional)

try: 
    api_response = api_instance.create_file_system_snapshots(sources, suffix=suffix)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileSystemSnapshotsApi->create_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]

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") # 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_snapthosts()
        # 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]