cterasdk.core.cloudfs module#
- class cterasdk.core.cloudfs.Backups(core)#
Bases:
BaseCommand
Backup Folder APIs
- add(name, group, owner, xattr=True)#
Create a new Backup Folder
- Parameters:
name (str) – Name of the backup folder
group (str) – Folder Group to assign this folder to
owner (cterasdk.core.types.UserAccount) – User account, the owner of the backup folder
xattr (bool,optional) – Backup extended attributes, defaults to True
- all(include=None, list_filter='NonDeleted', user=None)#
List Backup folders.
- Parameters:
include (str,optional) – List of fields to retrieve, defaults to [‘name’, ‘group’, ‘owner’]
list_filter (cterasdk.core.enum.ListFilter) – Filter the list of Backup folders, defaults to non-deleted folders
user (cterasdk.core.types.UserAccount) – Filter by backup folder owner
- Returns:
Iterator for all Backup folders
- default = ['name', 'group', 'owner']#
- delete(name)#
Delete a Backup Folder
- Parameters:
name (str) – Name of the Backup Folder to delete
- modify(current_name, new_name=None, new_owner=None, new_group=None, xattr=None)#
Modify a Backup Folder
- Parameters:
current_name (str) – Current folder name
owner (cterasdk.core.types.UserAccount) – User account, the owner of the folder
new_name (str,optional) – New folder name
new_owner (cterasdk.core.types.UserAccount,optional) – User account, the new owner of the folder
new_group (str,optional) – Folder Group to assign this folder to
xattr (bool,optional) – Backup extended attributes
- class cterasdk.core.cloudfs.CloudDrives(core)#
Bases:
BaseCommand
Cloud Drive Folder APIs
- add(name, group, owner, winacls=True, description=None, quota=None, compliance_settings=None, xattrs=None)#
Create a new Cloud Drive Folder (Cloud Volume)
- Parameters:
name (str) – Name of the new folder
group (str) – Folder Group to assign this folder to
owner (cterasdk.core.types.UserAccount) – User account, the owner of the new folder
winacls (bool,optional) – Use Windows ACLs, defaults to True
description (str,optional) – Cloud drive folder description
quota (str,optional) – Cloud drive folder quota in GB
compliance_settings (cterasdk.common.object.Object,optional) – Compliance settings, defaults to disabled. Use
cterasdk.core.types.ComplianceSettingsBuilder()
to build the compliance settings objectxattrs (cterasdk.common.object.Object,optional) – Extended attributes, defaults to MacOS. Use
cterasdk.core.types.ExtendedAttributesBuilder()
to build the extended attributes object
- all(include=None, list_filter='NonDeleted', user=None)#
List Cloud Drive folders.
- Parameters:
include (str,optional) – List of fields to retrieve, defaults to [‘name’, ‘group’, ‘owner’]
list_filter (cterasdk.core.enum.ListFilter) – Filter the list of Cloud Drive folders, defaults to non-deleted folders
user (cterasdk.core.types.UserAccount) – User account of the cloud folder owner
- Returns:
Iterator for all Cloud Drive folders
- default = ['name', 'group', 'owner']#
- delete(name, owner, *, permanently=False)#
Delete a Cloud Drive Folder
- Parameters:
name (str) – Name of the Cloud Drive Folder to delete
owner (cterasdk.core.types.UserAccount) – User account, the owner of the Cloud Drive Folder to delete
permanently (bool,optional) – Delete permanently
- find(name, owner, include=None)#
Find a Cloud Drive Folder
- Parameters:
name (str) – Name of the Cloud Drive Folder to find
owner (cterasdk.core.types.UserAccount) – Cloud drive folder owner
include (list[str]) – List of metadata fields to include in the response
- Returns:
A Cloud Drive Folder
- modify(current_name, owner, new_name=None, new_owner=None, new_group=None, description=None, winacls=None, quota=None, compliance_settings=None, xattrs=None)#
Modify a Cloud Drive Folder (Cloud Volume)
- Parameters:
current_name (str) – Current folder name
owner (cterasdk.core.types.UserAccount) – User account, the owner of the folder
new_name (str,optional) – New folder name
new_owner (cterasdk.core.types.UserAccount,optional) – User account, the new owner of the folder
new_group (str,optional) – Folder Group to assign this folder to
description (str,optional) – Folder description
winacls (bool,optional) – Enable or disable Windows ACLs
quota (str,optional) – Folder quota in GB
compliance_settings (cterasdk.common.object.Object,optional) – Compliance settings. Use
cterasdk.core.types.ComplianceSettingsBuilder()
to build the compliance settings objectxattrs (cterasdk.common.object.Object,optional) – Extended attributes. Use
cterasdk.core.types.ExtendedAttributesBuilder()
to build the extended attributes object
- recover(name, owner)#
Recover a deleted a Cloud Drive Folder
- Parameters:
name (str) – Name of the Cloud Drive Folder to un-delete
owner (cterasdk.core.types.UserAccount) – User account, the owner of the Cloud Drive Folder to delete
- setfacl(paths, acl, recursive=False)#
Changing the file or Folder ACLs
- Parameters:
paths (list(str)) – List of folder paths
acl (str) – Access control list (ACL) represented as an SDDL String
recursive (bool,optional) – Apply changes recursively to subfolders and files
- setoacl(paths, owner_sid, recursive=False)#
Changing the File or Folder Owner SID or ACLs
- Parameters:
paths (list(str)) – List of folder paths
owner_sid (str) – Owner SID (Security Descriptor)
recursive (bool,optional) – Apply changes recursively to subfolders and files
- class cterasdk.core.cloudfs.CloudFS(portal)#
Bases:
BaseCommand
CloudFS APIs
- Variables:
groups (cterasdk.core.cloudfs.FolderGroups) – Object holding Folder Groups APIs
drives (cterasdk.core.cloudfs.CloudDrives) – Object holding Cloud Drive Folders APIs
backups (cterasdk.core.cloudfs.Backups) – Object holding Backup Folders APIs
zones (cterasdk.core.cloudfs.Zones) – Object holding Zones APIs
exports (cterasdk.core.cloudfs.Exports) – Object holding Bucket Exports APIs
- class cterasdk.core.cloudfs.Exports(core)#
Bases:
BaseCommand
S3 Exports APIs
- add(name, drive_name, drive_owner, description=None)#
Add Bucket
- Parameters:
name (str) – Bucket name
drive_name (str) – Cloud Drive Folder name
drive_owner (str) – Cloud Drive Folder owner
description (str,optional) – Bucket description
- all()#
List Buckets
- delete(name)#
Remove Bucket
- Parameters:
name (str) – Bucket name
- get(name)#
Get Buckets
- Parameters:
name (str) – Bucket name
- get_endpoint(name)#
Get Endpoint
- Parameters:
name (str) – Bucket name
- Returns:
Bucket endpoint
- Return type:
str
- modify(name, description)#
Modify Bucket
- Parameters:
name (str) – Bucket name
description (str) – Bucket description
- class cterasdk.core.cloudfs.FolderGroups(core)#
Bases:
BaseCommand
Folder Groups APIs
- add(name, user=None, deduplication_method_type=None, storage_class=None)#
Create a Folder Group
- Parameters:
name (str) – Name of the new folder group
user (cterasdk.core.types.UserAccount) – User account, the user directory and name of the new folder group owner (default to None)
deduplication_method_type (cterasdk.core.enum.DeduplicationMethodType) – Deduplication-Method
storage_class (str,optional) – Storage class, defaults to the Default storage class
- all(include=None, user=None)#
List folder groups
- Parameters:
include (str,optional) – List of fields to retrieve, defaults to [‘name’, ‘owner’]
user (cterasdk.core.types.UserAccount) – User account of the folder group owner
- Returns:
Iterator for all folder groups
- default = ['name', 'owner']#
- delete(name)#
Remove a Folder Group
- Parameters:
name (str) – Name of the folder group to remove
- get(name, include=None)#
Get folder group
- Parameters:
name (str) – Name of the Folder Group to find
include (str,optional) – List of fields to retrieve, defaults to [‘name’, ‘owner’]
- modify(current_name, new_name)#
Modify a folder group
- Parameters:
current_name (str) – Current folder group name
new_name (str) – New folder group name
- class cterasdk.core.cloudfs.Zones(core)#
Bases:
BaseCommand
Portal Zones APIs
- add(name, policy_type='selectedFolders', description=None)#
Add a new zone
- Parameters:
name (str) – The name of the new zone
policy_type (cterasdk.core.enum.PolicyType,optional) – Policy type of the new zone, defaults to cterasdk.core.enum.PolicyType.SELECT
description (str,optional) – The description of the new zone
- add_devices(name, device_names)#
Add devices to a zone
- Parameters:
name (str) – The name of the zone to add devices to
device_names (list[str]) – The names of the devices to add to the zone
- add_folders(name, folder_finding_helpers)#
Add the folders to the zone
- Parameters:
name (str) – The name of the zone
folder_finding_helpers (list[cterasdk.core.types.CloudFSFolderFindingHelper]) – List of folder names and owners
- all(filters=None)#
List Zones :param list[],optional filters: List of additional filters, defaults to None
- Returns:
Iterator for all Zones
- Return type:
cterasdk.lib.iterator.Iterator
- delete(name)#
Delete a zone
- Parameters:
name (str) – The name of the zone to delete
- get(name)#
Get zone by name
- Parameters:
name (str) – The name of the zone to get
- Returns:
The requested zone
- name_attr = 'name'#
- search(name)#
Search for Zones by name :param str name: Search query
- Returns:
Iterator for all matching Zones
- Return type:
cterasdk.lib.iterator.Iterator