cterasdk.object.Portal module#

class cterasdk.object.Portal.GlobalAdmin(host=None, port=None, https=True, *, url=None)#

Bases: Portal

Class for Global Administrator Functions

Variables:
property backups_base_path#
property cloud_drive_base_path#
property context#
class cterasdk.object.Portal.Portal(host, port, https, *, url=None)#

Bases: CTERAHost

Base Class for CTERA Portal

Variables:
  • activation (cterasdk.core.activation.Activation) – Object holding the Portal activation APIs

  • admins (cterasdk.core.admins.Administrators) – Object holding the Portal GlobalAdmin users APIs

  • cloudfs (cterasdk.core.cloudfs.CloudFS) – Object holding the Portal CloudFS APIs

  • devices (cterasdk.core.devices.Devices) – Object holding the Portal devices APIs

  • directoryservice (cterasdk.core.directoryservice.DirectoryService) – Object holding the Directory Services APIs

  • domains (cterasdk.core.domains.Domains) – Object holding the Portal domain APIs

  • files (cterasdk.core.files.browser.FileBrowser) – Object holding the Portal File Browsing APIs

  • firmwares (cterasdk.core.firmwares.Firmwares) – Object holding the Portal Firmware Repository APIs

  • groups (cterasdk.core.groups.Groups) – Object holding the Portal group APIs

  • logs (cterasdk.core.logs.Logs) – Object holding the Portal logs APIs

  • plans (cterasdk.core.plans.Plans) – Object holding the Plan APIs

  • reports (cterasdk.core.reports.Reports) – Object holding the Portal reports APIs

  • roles (cterasdk.core.roles.Roles) – Object holding the Portal Role Settings APIs

  • settings (cterasdk.core.settings.Settings) – Object holding the Portal Settings APIs

  • storage_classes (cterasdk.core.settings.StorageClasses) – Object holding the Portal Storage Classes APIs

  • tasks (cterasdk.core.taskmgr.Tasks) – Object holding the Portal Background Tasks APIs

  • templates (cterasdk.core.templates.Templates) – Object holding the Portal Configuration Templates APIs

  • users (cterasdk.core.users.Users) – Object holding the Portal user APIs

property backups_base_path#
property base_api_url#
property base_file_url#
property base_portal_url#
property cloud_drive_base_path#
property context#
iterator(path, param)#
public_info()#

Obtain the Portal’s public info.

put(path, value, use_file_url=False)#

Update a schema object or attribute.

query(path, name, param)#
show_query(path, name, param)#
test()#

Verification check to ensure the target host is a Portal.

class cterasdk.object.Portal.ServicesPortal(host=None, port=None, https=True, *, url=None)#

Bases: Portal

Class for End User or Tenant Administrator Functions

property backups_base_path#
property cloud_drive_base_path#
property context#