cterasdk.core.enum module

Contents

cterasdk.core.enum module#

class cterasdk.core.enum.AntivirusType#

Bases: object

Antivirus Type

Variables:
  • McAfeeWG (str) – McAfee Web Gateway

  • Symantec (str) – Symantec Protection Engine

  • ESET (str) – ESET Gateway Security

  • Sophos (str) – Sophos AV

  • McAfeeVSES (str) – McAfee VirusScan Enterprise for Storage

  • TrendMicro (str) – Trend Micro InterScan

ESET = 'Eset'#
McAfeeVSES = 'McAfeeVSES'#
McAfeeWG = 'McAfee'#
Sophos = 'Sophos'#
Symantec = 'Symantec'#
TrendMicro = 'TrendMicro'#
class cterasdk.core.enum.BucketType#

Bases: object

Bucket Type

Variables:
  • Azure (str) – Azure

  • Scality (str) – Scality

  • AWS (str) – Amazon Web Services S3

  • ICOS (str) – IBM Cloud Object Storage

  • GenericS3 (str) – Generic S3

  • Nutanix (str) – Nutanix S3

  • Wasabi (str) – Wasabi S3

  • Google (str) – Google S3

  • NetAppStorageGRID (str) – NetApp StorageGRID WebScale (S3)

AWS = 'S3'#
Azure = 'Azure'#
GenericS3 = 'GenericS3'#
Google = 'GoogleS3'#
ICOS = 'CleverSafeS3'#
NetAppStorageGRID = 'NTAP'#
Nutanix = 'Nutanix'#
Scality = 'ScalityS3'#
Wasabi = 'WasabiS3'#
class cterasdk.core.enum.CollaboratorType#

Bases: object

Collaborator Type

Variables:
  • LU (str) – Local User

  • DU (str) – Domain User

  • LG (str) – Local Group

  • DG (str) – Domain Group

  • EXT (str) – External

DG = 'adGroup'#
DU = 'adUser'#
EXT = 'external'#
LG = 'localGroup'#
LU = 'localUser'#
class cterasdk.core.enum.Context#

Bases: object

Portal connection context

Variables:
  • admin (str) – Global admin context

  • ServicesPortal (str) – Services Portal context

ServicesPortal = 'ServicesPortal'#
admin = 'admin'#
class cterasdk.core.enum.DeduplicationMethodType#

Bases: object

Folder Group Deduplication Method Type

Variables:
  • AverageBlockSize (str) – AverageBlockSize

  • FixedBlockSize (str) – FixedBlockSize

AverageBlockSize = 'AverageBlockSize'#
FixedBlockSize = 'FixedBlockSize'#
class cterasdk.core.enum.DeviceType#

Bases: object

Device type

Variables:
  • CloudPlug (str) – Cloud Plug device

  • C200 (str) – C200 device

  • C400 (str) – C400 device

  • C800 (str) – C800 device

  • C800P (str) – C800P device

  • vGateway (str) – vGateway device

  • ServerAgent (str) – Server Agent device

  • WorkstationAgent (str) – Workstation Agent Agent device

  • Gateways (list[str]) – List of all the Gateway DeviceTypes

  • Agents (list[str]) – List of all the Agents DeviceTypes

Agents = ['Server Agent', 'Workstation Agent']#
C200 = 'C200'#
C400 = 'C400'#
C800 = 'C800'#
C800P = 'C800P'#
CloudPlug = 'CloudPlug'#
Gateways = ['CloudPlug', 'C200', 'C400', 'C800', 'C800P', 'vGateway']#
ServerAgent = 'Server Agent'#
WorkstationAgent = 'Workstation Agent'#
vGateway = 'vGateway'#
class cterasdk.core.enum.DirectorySearchEntityType#

Bases: object

Directory Search Entity Type

Variables:
  • User (str) – User

  • Group (str) – Group

Group = 'group'#
User = 'user'#
class cterasdk.core.enum.DirectoryServiceFetchMode#

Bases: object

Directory Service Fetch Mode

Variables:
  • Eager (str) – Eager

  • Lazy (str) – Lazy

Eager = 'Eager'#
Lazy = 'Lazy'#
class cterasdk.core.enum.DirectoryServiceType#

Bases: object

Directory Service Type

Variables:
  • Microsoft (str) – Active Directory

  • LDAP (str) – LDAP

  • Apple (str) – Apple Open Directory

Apple = 'AppleOpenDirectory'#
LDAP = 'LDAP'#
Microsoft = 'ActiveDirectory'#
class cterasdk.core.enum.Duration#

Bases: object

Variables:
  • Minutes (str) – Minutes

  • Hours (str) – Hours

  • Days (str) – Days

  • Months (str) – Months

  • Years (str) – Years

Days = 'Days'#
Hours = 'Hours'#
Minutes = 'Minutes'#
Months = 'Months'#
Years = 'Years'#
class cterasdk.core.enum.EnvironmentVariables#

Bases: object

Environment Variables.

Some environment variables are applicable across platforms (i.e. Windows, Linux), while others are limited to a designated platform

Variables:
  • ALLUSERSPROFILE (str) – All users profile

  • WINDIR (str) – Windows directory

  • TEMP (str) – Temp directory

  • SYSTEMDRIVE (str) – System drive

  • PROGRAMFILES (str) – Program files

  • APPDATA (str) – Application data

  • USERPROFILE (str) – Current user profile

  • PRIMARYUSER (str) – Primary user

  • USERS (str) – Users directory (CTERA Edge Filer)

  • AGENTS (str) – Agents directory (CTERA Edge Filer)

  • SYNCS (str) – Syncs directory (CTERA Edge Filer)

  • PROJECTS (str) – Projects directory (CTERA Edge Filer)

AGENTS = '$AGENTS'#
ALLUSERSPROFILE = '$ALLUSERSPROFILE'#
APPDATA = '$APPDATA'#
PRIMARYUSER = '$PRIMARYUSER'#
PROGRAMFILES = '$PROGRAMFILES'#
PROJECTS = '$PROJECTS'#
SYNCS = '$SYNCS'#
SYSTEMDRIVE = '$SYSTEMDRIVE'#
TEMP = '$TEMP'#
USERPROFILE = '$USERPROFILE'#
USERS = '$USERS'#
WINDIR = '$WINDIR'#
class cterasdk.core.enum.FileAccessMode#

Bases: object

Share Access Mode

Variables:
  • RW (str) – Read Write

  • RO (str) – Read Only

  • PO (str) – Preview Only

  • NA (str) – None

NA = 'None'#
PO = 'PreviewOnly'#
RO = 'ReadOnly'#
RW = 'ReadWrite'#
class cterasdk.core.enum.ICAPServices#

Bases: object

ICAP Services

Variables:
  • Antivirus (str) – Antivirus

  • DLP (str) – Data Loss Prevention

Antivirus = 'Antivirus'#
DLP = 'DLP'#
class cterasdk.core.enum.IPProtocol#

Bases: object

IP Protocol

Variables:
  • TCP (str) – TCP Protocol

  • UDP (str) – UDP Protocol

TCP = 'TCP'#
UDP = 'UDP'#
class cterasdk.core.enum.ListFilter#

Bases: object

Cloud Drive Folder List Filter

Variables:
  • All (str) – All

  • Deleted (str) – Deleted

  • NonDeleted (str) – NonDeleted

All = 'All'#
Deleted = 'Deleted'#
NonDeleted = 'NonDeleted'#
class cterasdk.core.enum.LocationType#

Bases: object

Location Type

Variables:
  • Azure (str) – Azure Blob Storage

  • S3 (str) – Amazon Web Services S3

  • S3Compatible (str) – S3 Compatible

  • NetAppStorageGRID (str) – NetApp StorageGRID WebScale (S3)

Azure = 'AzureLocation'#
NetAppStorageGRID = 'NetAppLocation'#
S3 = 'S3Location'#
S3Compatible = 'S3Compatible'#
class cterasdk.core.enum.LogTopic#

Bases: object

Portal Log Topic

Variables:
  • System (str) – System log topic

  • CloudBackup (str) – Cloud Backup log topic

  • CloudSync (str) – Cloud Sync log topic

  • Access (str) – Access log topic

  • Audit (str) – Audit log topic

Access = 'access'#
Audit = 'audit'#
CloudBackup = 'backup'#
CloudSync = 'cloudsync'#
System = 'system'#
class cterasdk.core.enum.Mode#

Bases: object

Enum for operational mode

Variables:
  • Enabled (str) – Operational mode enabled

  • Disabled (str) – Operational mode diabled

Disabled = 'disabled'#
Enabled = 'enabled'#
class cterasdk.core.enum.OriginType#

Bases: object

Log Origin Type

Variables:
  • Portal (str) – Portal originated logs

  • Device (str) – Device originated logs

Device = 'Device'#
Portal = 'Portal'#
class cterasdk.core.enum.PlanCriteria#

Bases: object

Subscription Plan Auto Assignment Rule Builder Criterias

Variables:
  • Username (str) – Username

  • Groups (str) – User groups

  • Role (str) – User role

  • First (str) – User first name

  • Last (str) – User last name

  • Company (str) – User company

  • BillingId (str) – User billing id

  • Comment (str) – User comment

BillingId = 'billingId'#
Comment = 'comment'#
Company = 'company'#
First = 'firstName'#
Groups = 'userGroups'#
Last = 'lastName'#
Role = 'role'#
Username = 'username'#
class cterasdk.core.enum.PlanItem#

Bases: object

Portal plan item

Variables:
  • EV4 (str) – EV4

  • EV8 (str) – EV8

  • EV16 (str) – EV16

  • EV32 (str) – EV32

  • EV64 (str) – EV64

  • EV128 (str) – EV128

  • WA (str) – Workstation Agent

  • SA (str) – Server Agent

  • Share (str) – Cloud Drive

  • Connect (str) – Cloud Drive Connect

Connect = 'Connect'#
EV128 = 'EV128'#
EV16 = 'EV16'#
EV32 = 'EV32'#
EV4 = 'EV4'#
EV64 = 'EV64'#
EV8 = 'EV8'#
SA = 'SA'#
Share = 'Share'#
Storage = 'Storage'#
WA = 'WA'#
class cterasdk.core.enum.PlanRetention#

Bases: object

Portal plan retention policy

Variables:
  • All (str) – All versions

  • Hourly (str) – Hourly versions

  • Daily (str) – Daily versions

  • Weekly (str) – Weekly versions

  • Monthly (str) – Monthly versions

  • Quarterly (str) – Quarterly versions

  • Yearly (str) – Yearly versions

  • Deleted (str) – Recycle bin

All = 'retainAll'#
Daily = 'daily'#
Deleted = 'retainDeleted'#
Hourly = 'hourly'#
Monthly = 'monthly'#
Quarterly = 'quarterly'#
Weekly = 'weekly'#
Yearly = 'yearly'#
class cterasdk.core.enum.Platform#

Bases: object

CTERA Edge Platform Type.

Variables:
  • C200_Orion (str) – All users profile

  • C200_ARM (str) – Windows directory

  • C200_Kirkwood (str) – Temp directory

  • C400_C800 (str) – System drive

  • Edge_6 (str) – CTERA 6.0 Edge Filer

  • Edge_7 (str) – CTERA 7.0 Edge Filer

  • Windows (str) – Windows Agent (Drive App)

  • Linux (str) – Linux Agent (Drive App)

  • OSX (str) – Mac Agent (Drive App)

C200_ARM = 'ARM'#
C200_Kirkwood = 'Kirkwood'#
C200_Orion = 'Orion'#
C400_C800 = 'X86'#
Edge_6 = 'VBox'#
Edge_7 = 'Genesis'#
Linux = 'LinuxX86'#
OSX = 'OSxX86'#
Windows = 'WindowsX86'#
class cterasdk.core.enum.PolicyType#

Bases: object

Zone Policy Type

Variables:
  • ALL (str) – All folders

  • SELECT (str) – Selected Folders

  • NONE (str) – No Folders

ALL = 'allFolders'#
NONE = 'noFolders'#
SELECT = 'selectedFolders'#
class cterasdk.core.enum.PortalAccountType#

Bases: object

Portal Account Type

Variables:
  • User (str) – User account type

  • Group (str) – Group account type

Group = 'group'#
User = 'user'#
class cterasdk.core.enum.PortalType#

Bases: object

Portal Type

Variables:
  • Team (str) – Team Portal

  • Reseller (str) – Reseller Portal

Reseller = 'reseller'#
Team = 'team'#
class cterasdk.core.enum.ProtectionLevel#

Bases: object

External Share Protection Level

Variables:
  • publicLink (str) – No authentication

  • email (str) – 2FA via email

Email = 'email'#
Public = 'publicLink'#
class cterasdk.core.enum.RetentionMode#

Bases: object

Write Once Read Many Retention Mode

Variables:
  • Enterprise (str) – Enterprise

  • Compliance (str) – Compliance

  • Delete (str) – Delete

Compliance = 'Compliance'#
Delete = 'None'#
Enterprise = 'Enterprise'#
class cterasdk.core.enum.Role#

Bases: object

Portal User Role

Variables:
  • Disabled (str) – Disabled user role

  • EndUser (str) – EndUser user role

  • ReadWriteAdmin (str) – ReadWriteAdmin user role

  • ReadOnlyAdmin (str) – ReadOnlyAdmin user role

  • Support (str) – Support user role

Disabled = 'Disabled'#
EndUser = 'EndUser'#
ReadOnlyAdmin = 'ReadOnlyAdmin'#
ReadWriteAdmin = 'ReadWriteAdmin'#
Support = 'Support'#
class cterasdk.core.enum.RoleResolver#

Bases: object

Role Settings Resolver

Variables:
  • ReadWriteAdmin (str) – ReadWriteAdmin user role

  • ReadOnlyAdmin (str) – ReadOnlyAdmin user role

  • Support (str) – Support user role

ComplianceOfficer = 'complianceOfficerSettings'#
ReadOnlyAdmin = 'readOnlyAdminSettings'#
ReadWriteAdmin = 'readWriteAdminSettings'#
Support = 'supportAdminSettings'#
class cterasdk.core.enum.SearchType#

Bases: object

Search Type

Variables:
  • User (str) – User search type

  • Group (str) – Group search type

Groups = 'groups'#
Users = 'users'#
class cterasdk.core.enum.ServerMode#

Bases: object

Portal Server Mode

Variables:
  • Master (str) – Master

  • Slave (str) – Slave

Master = 'master'#
Slave = 'slave'#
class cterasdk.core.enum.SetupWizardStage#

Bases: object

Portal Setup Wizard Stage

Variables:
  • Server (str) – Initializing Server

  • Portal (str) – Initializing Portal

  • Replication (str) – Setting Database Replication

  • Restart (str) – Restarting Server

  • Finish (str) – Finished

Finish = 'finish'#
Portal = 'initPortal'#
Replication = 'setReplication'#
Restart = 'restartingServer'#
Server = 'initServer'#
class cterasdk.core.enum.SetupWizardStatus#

Bases: object

Portal Setup Wizard Status

Variables:
  • NA (str) – Not Relevant

  • Running (str) – In Progress

  • Failed (str) – Failed

  • Completed (str) – Completed

Completed = 'completed'#
Failed = 'failed'#
NA = 'notRelevant'#
Running = 'inProgress'#
class cterasdk.core.enum.Severity#

Bases: object

Portal Log Severity

Variables:
  • EMERGENCY (str) – Emergency log severity

  • ALERT (str) – Alert log severity

  • CRITICAL (str) – Critical log severity

  • ERROR (str) – Error log severity

  • WARNING (str) – Warning log severity

  • NOTICE (str) – Notice log severity

  • INFO (str) – Info log severity

  • DEBUG (str) – Debug log severity

ALERT = 'alert'#
CRITICAL = 'critical'#
DEBUG = 'debug'#
EMERGENCY = 'emergency'#
ERROR = 'error'#
INFO = 'info'#
NOTICE = 'notice'#
WARNING = 'warning'#
class cterasdk.core.enum.SlaveAuthenticaionMethod#

Bases: object

Secondary Portal server authentication mode

Variables:
  • Password (str) – Password

  • PrivateKey (str) – Private Key

Password = 'Password'#
PrivateKey = 'Key'#
class cterasdk.core.enum.TemplateCriteria#

Bases: object

Configuration Template Auto Assignment Rule Builder Criterias

Variables:
  • Type (str) – Device type

  • OperatingSystem (str) – Operating system

  • Version (str) – Installed software version

  • Hostname (str) – Hostname

  • Name (str) – Device name

  • Owner (str) – Device owner username

  • Plan (str) – Plan name

  • Groups (str) – Device owner local or domain groups

Groups = 'ownerGroups'#
Hostname = 'Hostname'#
Name = 'DeviceName'#
OperatingSystem = 'OperatingSystem'#
Owner = 'OwnerUsername'#
Plan = 'Plan'#
Type = 'DeviceType'#
Version = 'InstalledSoftwareVersion'#