cterasdk.core package

Subpackages

• cterasdk.core.files package
  • Submodules
    • cterasdk.core.files.browser module
    • cterasdk.core.files.io module
      • add_share_recipients()
      • copy()
      • delete()
      • get_share_details()
      • handle()
      • handle_many()
      • list_shares()
      • listdir()
      • mkdir()
      • move()
      • public_link()
      • remove_share_recipients()
      • share()
      • undelete()
      • update_share()
      • upload()
      • versions()

Submodules

• cterasdk.core.activation module
  • Activation
    • Activation.generate_code()
• cterasdk.core.antivirus module
  • Antivirus
    • Antivirus.default
    • Antivirus.list_servers()
    • Antivirus.rescan()
    • Antivirus.status()
    • Antivirus.suspend()
    • Antivirus.unsuspend()
  • AntivirusServers
    • AntivirusServers.add()
    • AntivirusServers.delete()
    • AntivirusServers.get()
    • AntivirusServers.suspend()
    • AntivirusServers.unsuspend()
• cterasdk.core.base_command module
  • BaseCommand
    • BaseCommand.session()
• cterasdk.core.buckets module
  • Buckets
    • Buckets.add()
    • Buckets.default
    • Buckets.delete()
    • Buckets.get()
    • Buckets.list_buckets()
    • Buckets.modify()
    • Buckets.read_only()
    • Buckets.read_write()
• cterasdk.core.cli module
  • CLI
    • CLI.run_command()
• cterasdk.core.cloudfs module
  • Backups
    • Backups.add()
    • Backups.all()
    • Backups.default
    • Backups.delete()
    • Backups.modify()
  • CloudDrives
    • CloudDrives.add()
    • CloudDrives.all()
    • CloudDrives.default
    • CloudDrives.default_extensions
    • CloudDrives.delete()
    • CloudDrives.find()
    • CloudDrives.modify()
    • CloudDrives.recover()
    • CloudDrives.setfacl()
    • CloudDrives.setoacl()
  • CloudFS
  • Exports
    • Exports.add()
    • Exports.all()
    • Exports.delete()
    • Exports.get()
    • Exports.get_endpoint()
    • Exports.modify()
  • FolderGroups
    • FolderGroups.add()
    • FolderGroups.all()
    • FolderGroups.default
    • FolderGroups.delete()
    • FolderGroups.get()
    • FolderGroups.modify()
  • Locks
    • Locks.all()
  • Zones
    • Zones.add()
    • Zones.add_devices()
    • Zones.add_folders()
    • Zones.all()
    • Zones.delete()
    • Zones.get()
    • Zones.name_attr
    • Zones.search()
• cterasdk.core.connection module
  • test()
• cterasdk.core.decorator module
  • update_current_session()
  • update_current_tenant()
• cterasdk.core.devices module
  • Devices
    • Devices.agents()
    • Devices.by_name()
    • Devices.default
    • Devices.desktops()
    • Devices.device()
    • Devices.devices()
    • Devices.filers()
    • Devices.get_comment()
    • Devices.name_attr
    • Devices.servers()
    • Devices.set_comment()
    • Devices.type_attr
• cterasdk.core.directoryservice module
• cterasdk.core.enum module
  • AntivirusType
    • AntivirusType.ESET
    • AntivirusType.McAfeeVSES
    • AntivirusType.McAfeeWG
    • AntivirusType.Sophos
    • AntivirusType.Symantec
    • AntivirusType.TrendMicro
  • BucketType
    • BucketType.AWS
    • BucketType.Azure
    • BucketType.Cloudian
    • BucketType.GenericS3
    • BucketType.Google
    • BucketType.ICOS
    • BucketType.NetAppStorageGRID
    • BucketType.Nutanix
    • BucketType.Scality
    • BucketType.Wasabi
  • CollaboratorType
    • CollaboratorType.DG
    • CollaboratorType.DU
    • CollaboratorType.EXT
    • CollaboratorType.LG
    • CollaboratorType.LU
  • ConflictHandler
    • ConflictHandler.Overwrite
    • ConflictHandler.Rename
    • ConflictHandler.Skip
  • Context
    • Context.Invitations
    • Context.ServicesPortal
    • Context.admin
  • DeduplicationMethodType
    • DeduplicationMethodType.AverageBlockSize
    • DeduplicationMethodType.FixedBlockSize
  • DeviceType
    • DeviceType.Agents
    • DeviceType.C200
    • DeviceType.C400
    • DeviceType.C800
    • DeviceType.C800P
    • DeviceType.CloudPlug
    • DeviceType.Gateways
    • DeviceType.ServerAgent
    • DeviceType.WorkstationAgent
    • DeviceType.vGateway
  • DirectorySearchEntityType
    • DirectorySearchEntityType.Group
    • DirectorySearchEntityType.User
  • DirectoryServiceFetchMode
    • DirectoryServiceFetchMode.Eager
    • DirectoryServiceFetchMode.Lazy
  • DirectoryServiceType
    • DirectoryServiceType.Apple
    • DirectoryServiceType.LDAP
    • DirectoryServiceType.Microsoft
  • Duration
    • Duration.Days
    • Duration.Hours
    • Duration.Minutes
    • Duration.Months
    • Duration.Years
  • EnvironmentVariables
    • EnvironmentVariables.AGENTS
    • EnvironmentVariables.ALLUSERSPROFILE
    • EnvironmentVariables.APPDATA
    • EnvironmentVariables.PRIMARYUSER
    • EnvironmentVariables.PROGRAMFILES
    • EnvironmentVariables.PROJECTS
    • EnvironmentVariables.SYNCS
    • EnvironmentVariables.SYSTEMDRIVE
    • EnvironmentVariables.TEMP
    • EnvironmentVariables.USERPROFILE
    • EnvironmentVariables.USERS
    • EnvironmentVariables.WINDIR
  • ExtendedAttributes
    • ExtendedAttributes.MacOS
  • FileAccessMode
    • FileAccessMode.NA
    • FileAccessMode.PO
    • FileAccessMode.RO
    • FileAccessMode.RW
    • FileAccessMode.UO
  • ICAPServices
    • ICAPServices.Antivirus
    • ICAPServices.DLP
  • IPProtocol
    • IPProtocol.TCP
    • IPProtocol.UDP
  • ListFilter
    • ListFilter.All
    • ListFilter.Deleted
    • ListFilter.NonDeleted
  • LocationType
    • LocationType.Azure
    • LocationType.NetAppStorageGRID
    • LocationType.S3
    • LocationType.S3Compatible
  • LogTopic
    • LogTopic.Access
    • LogTopic.Audit
    • LogTopic.CloudBackup
    • LogTopic.CloudSync
    • LogTopic.System
  • Mode
    • Mode.Disabled
    • Mode.Enabled
  • NativeFormat
    • NativeFormat.Bidirectional
    • NativeFormat.Bucket
    • NativeFormat.Filesystem
  • OriginType
    • OriginType.Device
    • OriginType.Portal
  • PlanCriteria
    • PlanCriteria.BillingId
    • PlanCriteria.Comment
    • PlanCriteria.Company
    • PlanCriteria.First
    • PlanCriteria.Groups
    • PlanCriteria.Last
    • PlanCriteria.Role
    • PlanCriteria.Username
  • PlanItem
    • PlanItem.Connect
    • PlanItem.EV128
    • PlanItem.EV16
    • PlanItem.EV32
    • PlanItem.EV4
    • PlanItem.EV64
    • PlanItem.EV8
    • PlanItem.SA
    • PlanItem.Share
    • PlanItem.Storage
    • PlanItem.WA
  • PlanRetention
    • PlanRetention.All
    • PlanRetention.Daily
    • PlanRetention.Deleted
    • PlanRetention.Hourly
    • PlanRetention.Monthly
    • PlanRetention.Quarterly
    • PlanRetention.Weekly
    • PlanRetention.Yearly
  • PlanService
    • PlanService.CloudBackup
    • PlanService.CloudDrive
    • PlanService.Remote
    • PlanService.Seeding
  • PlanServiceState
    • PlanServiceState.Connect
    • PlanServiceState.Disabled
    • PlanServiceState.Enabled
  • Platform
    • Platform.C200_ARM
    • Platform.C200_Kirkwood
    • Platform.C200_Orion
    • Platform.C400_C800
    • Platform.Edge_6
    • Platform.Edge_7
    • Platform.Linux
    • Platform.OSX
    • Platform.Windows
  • PolicyType
    • PolicyType.ALL
    • PolicyType.NONE
    • PolicyType.SELECT
  • PortalAccountType
    • PortalAccountType.Group
    • PortalAccountType.User
  • PortalType
    • PortalType.Reseller
    • PortalType.Team
  • ProtectionLevel
    • ProtectionLevel.Email
    • ProtectionLevel.Public
  • Reports
    • Reports.FolderGroups
    • Reports.Folders
    • Reports.Portals
    • Reports.Storage
  • ResourceError
    • ResourceError.Conflict
    • ResourceError.DestinationNotExists
    • ResourceError.FileWithTheSameNameExist
    • ResourceError.InvalidName
    • ResourceError.PermissionDenied
    • ResourceError.ReservedName
  • ResourceScope
    • ResourceScope.Backup
    • ResourceScope.BackupsContainer
    • ResourceScope.CloudDrivesContainer
    • ResourceScope.InsideCloudFolder
    • ResourceScope.OfflineFolder
    • ResourceScope.Personal
    • ResourceScope.Project
    • ResourceScope.ProjectsContainer
    • ResourceScope.Root
    • ResourceScope.Shared
    • ResourceScope.SharedContainer
    • ResourceScope.SharedDomain
    • ResourceScope.UsersContainer
    • ResourceScope.UsersFoldersContainer
  • RetentionMode
    • RetentionMode.Compliance
    • RetentionMode.Delete
    • RetentionMode.Enterprise
  • Role
    • Role.ComplianceOfficer
    • Role.Disabled
    • Role.EndUser
    • Role.ReadOnlyAdmin
    • Role.ReadWriteAdmin
    • Role.Support
  • RoleResolver
    • RoleResolver.ComplianceOfficer
    • RoleResolver.ReadOnlyAdmin
    • RoleResolver.ReadWriteAdmin
    • RoleResolver.Support
  • SearchType
    • SearchType.Groups
    • SearchType.Users
  • ServerMode
    • ServerMode.Master
    • ServerMode.Slave
  • SetupWizardStage
    • SetupWizardStage.Finish
    • SetupWizardStage.Portal
    • SetupWizardStage.Restart
    • SetupWizardStage.Server
  • SetupWizardStatus
    • SetupWizardStatus.Completed
    • SetupWizardStatus.Failed
    • SetupWizardStatus.NA
    • SetupWizardStatus.Running
  • Severity
    • Severity.ALERT
    • Severity.CRITICAL
    • Severity.DEBUG
    • Severity.EMERGENCY
    • Severity.ERROR
    • Severity.INFO
    • Severity.NOTICE
    • Severity.WARNING
  • SlaveAuthenticaionMethod
    • SlaveAuthenticaionMethod.Password
    • SlaveAuthenticaionMethod.PrivateKey
  • TemplateCriteria
    • TemplateCriteria.Groups
    • TemplateCriteria.Hostname
    • TemplateCriteria.Name
    • TemplateCriteria.OperatingSystem
    • TemplateCriteria.Owner
    • TemplateCriteria.Plan
    • TemplateCriteria.Type
    • TemplateCriteria.Version
  • UploadError
    • UploadError.FolderQuotaViolation
    • UploadError.NoStorageBucket
    • UploadError.PortalQuotaViolation
    • UploadError.RejectedByPolicy
    • UploadError.UserQuotaViolation
    • UploadError.WindowsACL
• cterasdk.core.kms module
  • KMS
    • KMS.disable()
    • KMS.enable()
    • KMS.modify()
    • KMS.settings()
    • KMS.status()
  • KMSServers
    • KMSServers.add()
    • KMSServers.all()
    • KMSServers.delete()
    • KMSServers.get()
    • KMSServers.modify()
• cterasdk.core.login module
  • Login
    • Login.login()
    • Login.logout()
    • Login.sso()
• cterasdk.core.logs module
  • Alerts
    • Alerts.add()
    • Alerts.delete()
    • Alerts.get()
    • Alerts.put()
  • Logs
    • Logs.device()
    • Logs.get()
• cterasdk.core.mail module
  • Mail
    • Mail.disable()
    • Mail.enable()
    • Mail.is_enabled()
    • Mail.modify()
• cterasdk.core.messaging module
  • Messaging
    • Messaging.add()
    • Messaging.get_servers_status()
    • Messaging.get_status()
    • Messaging.is_active()
• cterasdk.core.portals module
  • Portals
    • Portals.add()
    • Portals.apply_changes()
    • Portals.browse()
    • Portals.browse_global_admin()
    • Portals.default
    • Portals.delete()
    • Portals.get()
    • Portals.list_tenants()
    • Portals.subscribe()
    • Portals.tenants()
    • Portals.undelete()
• cterasdk.core.query module
  • Filter
  • FilterBuilder
    • FilterBuilder.after()
    • FilterBuilder.before()
    • FilterBuilder.eq()
    • FilterBuilder.ge()
    • FilterBuilder.gt()
    • FilterBuilder.le()
    • FilterBuilder.like()
    • FilterBuilder.lt()
    • FilterBuilder.ne()
    • FilterBuilder.notLike()
    • FilterBuilder.ref()
    • FilterBuilder.setValue()
  • FilterType
    • FilterType.Boolean
    • FilterType.BooleanRefFilter
    • FilterType.DateTime
    • FilterType.IntRefFilter
    • FilterType.Integer
    • FilterType.RefFilter
    • FilterType.String
    • FilterType.fromValue()
  • QueryParamBuilder
    • QueryParamBuilder.addFilter()
    • QueryParamBuilder.allPortals()
    • QueryParamBuilder.build()
    • QueryParamBuilder.countLimit()
    • QueryParamBuilder.include()
    • QueryParamBuilder.include_classname()
    • QueryParamBuilder.orFilter()
    • QueryParamBuilder.ownedBy()
    • QueryParamBuilder.put()
    • QueryParamBuilder.sortBy()
    • QueryParamBuilder.startFrom()
  • QueryParams
    • QueryParams.include_classname()
    • QueryParams.increment()
  • Restriction
    • Restriction.EQUALS
    • Restriction.GREATER_EQUALS
    • Restriction.GREATER_THAN
    • Restriction.LESS_EQUALS
    • Restriction.LESS_THAN
    • Restriction.LIKE
    • Restriction.NOT_EQUALS
    • Restriction.UNLIKE
  • create_callback_function()
  • iterator()
  • run()
• cterasdk.core.reports module
  • Reports
    • Reports.folder_groups()
    • Reports.folders()
    • Reports.generate()
    • Reports.portals()
    • Reports.storage()
• cterasdk.core.plans module
  • PlanAutoAssignPolicy
    • PlanAutoAssignPolicy.get_policy()
    • PlanAutoAssignPolicy.set_policy()
  • Plans
    • Plans.add()
    • Plans.by_name()
    • Plans.default
    • Plans.delete()
    • Plans.get()
    • Plans.list_plans()
    • Plans.modify()
• cterasdk.core.remote module
  • remote_command()
• cterasdk.core.roles module
  • Roles
    • Roles.find()
    • Roles.get()
    • Roles.modify()
    • Roles.types()
• cterasdk.core.servers module
  • Backup
    • Backup.connected()
    • Backup.disable()
    • Backup.enable()
  • Servers
    • Servers.default
    • Servers.get()
    • Servers.list_servers()
    • Servers.modify()
    • Servers.system_database
  • Tasks
    • Tasks.background()
    • Tasks.scheduled()
• cterasdk.core.setup module
  • Setup
    • Setup.default_settings()
    • Setup.get_setup_status()
    • Setup.init_application_server()
    • Setup.init_master()
  • SetupWizardStatusMonitor
    • SetupWizardStatusMonitor.wait()
• cterasdk.core.ssl module
  • SSL
    • SSL.create_zip_archive()
    • SSL.export()
    • SSL.get()
    • SSL.import_from_chain()
    • SSL.import_from_zip()
    • SSL.thumbprint
• cterasdk.core.startup module
  • Startup
    • Startup.Started
    • Startup.status()
    • Startup.wait()
• cterasdk.core.syslog module
  • Syslog
    • Syslog.disable()
    • Syslog.enable()
    • Syslog.get_configuration()
    • Syslog.import_ca()
    • Syslog.import_client_certificate()
    • Syslog.is_enabled()
    • Syslog.modify()
• cterasdk.core.tasks module
  • Tasks
    • Tasks.awaitable_task()
    • Tasks.wait()
• cterasdk.core.templates module
  • TemplateAutoAssignPolicy
    • TemplateAutoAssignPolicy.apply_changes()
    • TemplateAutoAssignPolicy.get_policy()
    • TemplateAutoAssignPolicy.set_policy()
  • Templates
    • Templates.add()
    • Templates.by_name()
    • Templates.default
    • Templates.delete()
    • Templates.get()
    • Templates.list_templates()
    • Templates.remove_default()
    • Templates.set_default()
• cterasdk.core.types module
  • AccessControlEntry
    • AccessControlEntry.account
    • AccessControlEntry.role
  • AccessControlRule
  • AlertBuilder
    • AlertBuilder.build()
    • AlertBuilder.content()
    • AlertBuilder.description()
    • AlertBuilder.log()
    • AlertBuilder.min_severity()
    • AlertBuilder.name()
    • AlertBuilder.origin_type()
    • AlertBuilder.topic()
  • AmazonS3
    • AmazonS3.to_server_object()
  • ArchiveSettingsBuilder
    • ArchiveSettingsBuilder.build()
    • ArchiveSettingsBuilder.compliance()
    • ArchiveSettingsBuilder.default()
    • ArchiveSettingsBuilder.enterprise()
  • AzureBlob
    • AzureBlob.to_server_object()
  • BackgroundTask
    • BackgroundTask.from_server_object()
  • Bucket
    • Bucket.to_server_object()
  • CloudFSFolderFindingHelper
    • CloudFSFolderFindingHelper.name
    • CloudFSFolderFindingHelper.owner
  • Cloudian
  • Collaborator
    • Collaborator.domain_group()
    • Collaborator.domain_user()
    • Collaborator.expire_in()
    • Collaborator.expire_on()
    • Collaborator.external()
    • Collaborator.from_server_object()
    • Collaborator.local_group()
    • Collaborator.local_user()
    • Collaborator.no_access()
    • Collaborator.preview_only()
    • Collaborator.read_only()
    • Collaborator.read_write()
    • Collaborator.upload_only()
  • ComplianceSettingsBuilder
    • ComplianceSettingsBuilder.build()
    • ComplianceSettingsBuilder.compliance()
    • ComplianceSettingsBuilder.default()
    • ComplianceSettingsBuilder.enterprise()
    • ComplianceSettingsBuilder.grace_period()
    • ComplianceSettingsBuilder.none()
  • ConflictResolver
    • ConflictResolver.all
    • ConflictResolver.build()
    • ConflictResolver.handler
    • ConflictResolver.ignore()
    • ConflictResolver.overwrite()
    • ConflictResolver.rename()
  • DomainControllers
    • DomainControllers.primary
    • DomainControllers.secondary
  • ExtendedAttribute
  • ExtendedAttributesBuilder
    • ExtendedAttributesBuilder.add()
    • ExtendedAttributesBuilder.build()
    • ExtendedAttributesBuilder.default()
    • ExtendedAttributesBuilder.disabled()
  • GenericS3
  • Google
  • GroupAccount
    • GroupAccount.account_type
  • HTTPBucket
    • HTTPBucket.to_database_backup_server_object()
    • HTTPBucket.to_native_format_server_object()
    • HTTPBucket.trust_all_certificates
  • ICOS
  • NativeFormatSettingsBuilder
    • NativeFormatSettingsBuilder.bidirectional()
    • NativeFormatSettingsBuilder.bucket()
    • NativeFormatSettingsBuilder.build()
    • NativeFormatSettingsBuilder.filesystem()
  • NetAppStorageGRID
    • NetAppStorageGRID.to_server_object()
  • Nutanix
  • PlanCriteriaBuilder
    • PlanCriteriaBuilder.Type
    • PlanCriteriaBuilder.billing_id()
    • PlanCriteriaBuilder.comment()
    • PlanCriteriaBuilder.company()
    • PlanCriteriaBuilder.first_name()
    • PlanCriteriaBuilder.last_name()
    • PlanCriteriaBuilder.role()
    • PlanCriteriaBuilder.user_groups()
    • PlanCriteriaBuilder.username()
  • PlatformVersion
    • PlatformVersion.name
    • PlatformVersion.version
  • PortalAccount
    • PortalAccount.account_type
    • PortalAccount.from_collaborator()
    • PortalAccount.is_local
    • PortalAccount.upn
  • PortalInvitation
    • PortalInvitation.from_server_object()
  • RoleSettings
    • RoleSettings.from_server_object()
    • RoleSettings.to_server_object()
  • S3Compatible
    • S3Compatible.to_server_object()
  • Scality
  • ScheduledTask
    • ScheduledTask.from_server_object()
  • Task
  • TemplateCriteriaBuilder
    • TemplateCriteriaBuilder.Type
    • TemplateCriteriaBuilder.groups()
    • TemplateCriteriaBuilder.hostname()
    • TemplateCriteriaBuilder.name()
    • TemplateCriteriaBuilder.os()
    • TemplateCriteriaBuilder.owner()
    • TemplateCriteriaBuilder.plan()
    • TemplateCriteriaBuilder.type()
    • TemplateCriteriaBuilder.version()
  • TemplateScript
    • TemplateScript.after_backup()
    • TemplateScript.after_logon()
    • TemplateScript.before_backup()
    • TemplateScript.linux()
    • TemplateScript.mac()
    • TemplateScript.platform
    • TemplateScript.to_server_object()
    • TemplateScript.windows()
  • UserAccount
    • UserAccount.account_type
  • Wasabi
• cterasdk.core.admins module
  • Administrators
    • Administrators.add()
    • Administrators.default
    • Administrators.delete()
    • Administrators.get()
    • Administrators.list_admins()
    • Administrators.modify()
• cterasdk.core.users module
  • Credentials
  • S3
    • S3.all()
    • S3.create()
    • S3.delete()
  • Users
    • Users.add()
    • Users.apply_changes()
    • Users.default
    • Users.delete()
    • Users.generate_ticket()
    • Users.get()
    • Users.list_domain_users()
    • Users.list_local_users()
    • Users.modify()