cterasdk.core.types module

class cterasdk.core.types.ADDomainIDMapping(domain, start, end)

Bases: cterasdk.common.object.Object

Base Class for Directory Service ID Mapping

Variables

domain (str) – The domain flat name

Parameters
  • start (int) – The minimum id to use for mapping

  • end (int) – The maximum id to use for mapping

class cterasdk.core.types.AccessControlEntry(account, role)

Bases: tuple

Tuple holding a Portal account and its respective permission

property account

The Portal group or user account

property role

The group or user role

class cterasdk.core.types.AccessControlRule(group, role)

Bases: cterasdk.common.object.Object

class cterasdk.core.types.AmazonS3(bucket, access_key, secret_key, endpoint='s3.amazonaws.com', https=True, direct=True)

Bases: cterasdk.core.types.HTTPBucket

to_server_object()
class cterasdk.core.types.AzureBlob(bucket, access_key, secret_key, endpoint='core.windows.net', https=True, direct=True)

Bases: cterasdk.core.types.HTTPBucket

to_server_object()
class cterasdk.core.types.Bucket(bucket, driver)

Bases: object

to_server_object()
class cterasdk.core.types.CloudFSFolderFindingHelper(name, owner)

Bases: tuple

Tuple holding the name and owner couple to search for folders

property name

The name of the CloudFS folder

property owner

The name of the owner of the CloudFS folder

class cterasdk.core.types.DomainControllers(primary=None, secondary=None)

Bases: object

property primary
property secondary
class cterasdk.core.types.GenericS3(bucket, access_key, secret_key, endpoint, https=False, direct=False)

Bases: cterasdk.core.types.S3Compatible

class cterasdk.core.types.Google(bucket, access_key, secret_key, endpoint, https=False, direct=False)

Bases: cterasdk.core.types.S3Compatible

class cterasdk.core.types.GroupAccount(name, directory=None)

Bases: cterasdk.core.types.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)

Bases: cterasdk.core.types.Bucket

class cterasdk.core.types.ICOS(bucket, access_key, secret_key, endpoint, https=False, direct=False)

Bases: cterasdk.core.types.S3Compatible

class cterasdk.core.types.NetAppStorageGRID(bucket, access_key, secret_key, endpoint, https=False, direct=False, tags=False)

Bases: cterasdk.core.types.S3Compatible

to_server_object()
class cterasdk.core.types.Nutanix(bucket, access_key, secret_key, endpoint, https=False, direct=False)

Bases: cterasdk.core.types.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

property name

The name of the platform

property version

The version identifier

class cterasdk.core.types.PortalAccount(name, directory=None)

Bases: abc.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.S3Compatible(bucket, driver, access_key, secret_key, endpoint, https, direct)

Bases: cterasdk.core.types.HTTPBucket

to_server_object()
class cterasdk.core.types.Scality(bucket, access_key, secret_key, endpoint, https=False, direct=False)

Bases: cterasdk.core.types.S3Compatible

class cterasdk.core.types.ShareRecipient(account, account_type, two_factor=False)

Bases: object

Class Representing a Collboration Share Recipient

static domain_group(group_account)

Share with a domain group

Parameters

group_account (GroupAccount) – A domain group account

static domain_user(user_account)

Share with a domain user

Parameters

user_account (UserAccount) – A domain user account

expire_in(days)

Set share to expire after (days)

Parameters

days (int) – The number of days the share will remain accessible

expire_on(expiration_date)

Set the share expiration date

Parameters

expire_on (str) – The expiration date (%Y-%m-%d)

static external(email, two_factor=False)

Share with an external user

Parameters
  • email (str) – The email address of the recipient

  • two_factor (bool) – Require two factor authentication over e-mail

static local_group(group_account)

Share with a local group

Parameters

group_account (GroupAccount) – A local group account

static local_user(user_account)

Share with a local user

Parameters

user_account (UserAccount) – A local user account

no_access()

Deny access

preview_only()

Grant preview only access

read_only()

Grant read only access

read_write()

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: cterasdk.core.types.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)

Bases: cterasdk.core.types.S3Compatible