cterasdk.core.types module#
- class cterasdk.core.types.AccessControlEntry(account, role)#
Bases:
tuple
Tuple holding a Portal account and its respective permission
- account#
The Portal group or user account
- role#
The group or user role
- class cterasdk.core.types.AlertBuilder(name)#
Bases:
object
- build()#
Build the alert
- Returns:
Alert object
- Return type:
- content(content)#
Set alert log message content
- Parameters:
content (str) – Log content
- Returns:
Alert Builder
- Return type:
- description(description)#
Set alert description
- Parameters:
description (str) – Alert description
- Returns:
Alert Builder
- Return type:
- log(log)#
Set alert log class name
- Parameters:
log (str) – Log class name
- Returns:
Alert Builder
- Return type:
- min_severity(min_severity)#
Set alert log minimum severity
- Parameters:
min_severity (cterasdk.core.enum.Severity) – Minimum severity
- Returns:
Alert Builder
- Return type:
- static name(name)#
Create an Alert Builder
- Parameters:
name (str) – Alert name
- Returns:
Alert Builder
- Return type:
- origin_type(origin_type)#
Set alert origin type
- Parameters:
origin_type (cterasdk.core.enum.OriginType) – Log origin type
- Returns:
Alert Builder
- Return type:
- topic(topic)#
Set alert log topic
- Parameters:
topic (cterasdk.core.enum.LogTopic) – Log topic
- Returns:
Alert Builder
- Return type:
- class cterasdk.core.types.AmazonS3(bucket, access_key=None, secret_key=None, endpoint='s3.amazonaws.com', https=True, direct=True, verify_ssl=True)#
Bases:
HTTPBucket
- to_server_object()#
- class cterasdk.core.types.AzureBlob(bucket, access_key, secret_key, endpoint='core.windows.net', https=True, direct=True)#
Bases:
HTTPBucket
- to_server_object()#
- class cterasdk.core.types.BackgroundTask(task_id, name, start_time, end_time, elapsed_time, status, message, ref)#
Bases:
Task
- static from_server_object(server_object, ref)#
- class cterasdk.core.types.CloudFSFolderFindingHelper(name, owner)#
Bases:
tuple
Tuple holding the name and owner couple to search for folders
- name#
The name of the CloudFS folder
- owner#
The name of the owner of the CloudFS folder
- class cterasdk.core.types.ComplianceSettingsBuilder(enabled, mode, retain_for)#
Bases:
object
- build()#
- static compliance(amount, duration)#
- static default()#
- static enterprise(amount, duration)#
- grace_period(amount=30, duration='Minutes')#
- static none(amount, duration)#
- class cterasdk.core.types.DomainControllers(primary=None, secondary=None)#
Bases:
object
- property primary#
- property secondary#
- class cterasdk.core.types.ExtendedAttributesBuilder(enable, xattrs)#
Bases:
object
- add(xattr)#
- Parameters:
xattr (cterasdk.core.enum.ExtendedAttributes) – Extended attribute
- build()#
- static default()#
- static disabled()#
- class cterasdk.core.types.GenericS3(bucket, access_key, secret_key, endpoint, https=False, direct=False, verify_ssl=True)#
Bases:
S3Compatible
- class cterasdk.core.types.Google(bucket, access_key, secret_key, endpoint, https=False, direct=False, verify_ssl=True)#
Bases:
S3Compatible
- class cterasdk.core.types.GroupAccount(name, directory=None)#
Bases:
PortalAccount
- property account_type#
The Portal Account Type
- Return cterasdk.core.enum.PortalAccountType:
The Portal Account Type
- class cterasdk.core.types.HTTPBucket(bucket, driver, access_key, secret_key, endpoint, https, direct=False, verify_ssl=True)#
Bases:
Bucket
- property trust_all_certificates#
- class cterasdk.core.types.ICOS(bucket, access_key, secret_key, endpoint, https=False, direct=False, verify_ssl=True)#
Bases:
S3Compatible
- class cterasdk.core.types.NetAppStorageGRID(bucket, access_key, secret_key, endpoint, https=False, direct=False, tags=False, verify_ssl=True)#
Bases:
S3Compatible
- to_server_object()#
- class cterasdk.core.types.Nutanix(bucket, access_key, secret_key, endpoint, https=False, direct=False, verify_ssl=True)#
Bases:
S3Compatible
- class cterasdk.core.types.PlanCriteriaBuilder#
Bases:
object
- Type = 'PlanCriteria'#
- static billing_id()#
- static comment()#
- static company()#
- static first_name()#
- static last_name()#
- static role()#
- static user_groups()#
- static username()#
- class cterasdk.core.types.PlatformVersion(name, version)#
Bases:
tuple
Tuple holding the platform name and version
- name#
The name of the platform
- version#
The version identifier
- class cterasdk.core.types.PortalAccount(name, directory=None)#
Bases:
ABC
Base Class for Portal Account
- Variables:
name (str) – The user name
directory (str) – The fully-qualified name of the user directory, defaults to None
- property account_type#
The Portal Account Type
- Return cterasdk.core.enum.PortalAccountType:
The Portal Account Type
- static from_collaborator(collaborator)#
- property is_local#
Is the account local
- Return bool:
True if the account if local, otherwise False
- class cterasdk.core.types.RoleSettings(name, sudo, enable_remote_wipe, enable_sso, enable_seeding_export, enable_seeding_import, access_end_user_folders, update_settings, update_roles, update_account_emails, update_account_password, manage_cloud_drives, manage_plans, manage_users, manage_logs)#
Bases:
Object
Role Settings
- Variables:
name (str) – Role name
sudo (bool) – Super user
enable_remote_wipe (bool) – Allow Remote Wipe for Devices
enable_sso (bool) – Super user
enable_seeding_export (bool) – Allow Seeding Export
enable_seeding_import (bool) – Allow Seeding Import
access_end_user_folders (bool) – Access End User Folders
update_settings (bool) – Modify Virtual Portal Settings
update_roles (bool) – Modify Roles
update_account_emails (bool) – Modify User Email
update_account_password (bool) – Modify User Password
manage_cloud_drives (bool) – Manage Cloud Folders
manage_plans (bool) – Manage Plans
manage_logs (bool) – Manage Log Settings
- static from_server_object(server_object)#
- to_server_object()#
- class cterasdk.core.types.S3Compatible(bucket, driver, access_key, secret_key, endpoint, https, direct, verify_ssl)#
Bases:
HTTPBucket
- to_server_object()#
- class cterasdk.core.types.Scality(bucket, access_key, secret_key, endpoint, https=False, direct=False, verify_ssl=True)#
Bases:
S3Compatible
- class cterasdk.core.types.ScheduledTask(task_id, name, start_time)#
Bases:
Task
- static from_server_object(server_object)#
Bases:
object
Class Representing a Collboration Share Recipient
Share with a domain group
- Parameters:
group_account (GroupAccount) – A domain group account
Share with a domain user
- Parameters:
user_account (UserAccount) – A domain user account
Set share to expire after (days)
- Parameters:
days (int) – The number of days the share will remain accessible
Set the share expiration date
- Parameters:
expire_on (str) – The expiration date (%Y-%m-%d)
Share with an external user
- Parameters:
email (str) – The email address of the recipient
two_factor (bool) – Require two factor authentication over e-mail
Share with a local group
- Parameters:
group_account (GroupAccount) – A local group account
Share with a local user
- Parameters:
user_account (UserAccount) – A local user account
Deny access
Grant preview only access
Grant read only access
Grant read write access
- class cterasdk.core.types.TemplateCriteriaBuilder#
Bases:
object
- Type = 'DeviceCriteria'#
- static groups()#
- static hostname()#
- static name()#
- static os()#
- static owner()#
- static plan()#
- static type()#
- static version()#
- class cterasdk.core.types.TemplateScript(platform)#
Bases:
object
- after_backup(after_backup)#
Set the post backup script
- Parameters:
after_backup (str) – A string or path to the script file
- after_logon(after_logon)#
Set the post logon script
- Parameters:
after_logon (str) – A string or path to the script file
- before_backup(before_backup)#
Set the pre backup script
- Parameters:
before_backup (str) – A string or path to the script file
- static linux()#
Configure Windows Scripts
- static mac()#
Configure Windows Scripts
- property platform#
- to_server_object()#
- static windows()#
Configure Windows Scripts
- class cterasdk.core.types.UserAccount(name, directory=None)#
Bases:
PortalAccount
- property account_type#
The Portal Account Type
- Return cterasdk.core.enum.PortalAccountType:
The Portal Account Type
- class cterasdk.core.types.Wasabi(bucket, access_key, secret_key, endpoint, https=False, direct=False, verify_ssl=True)#
Bases:
S3Compatible