cterasdk.object.Portal module

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

Bases: Portal

Main class for Global Admin operations on a Portal

Variables

• portals (cterasdk.core.portals.Portals) – Object holding the Portals Management APIs

• cli (cterasdk.core.cli.CLI) – Object holding the Portal GlobalAdmin CLI APIs

• servers (cterasdk.core.servers.Servers) – Object holding the Servers Management APIs

• setup (cterasdk.core.setup.Setup) – Object holding the Portal setup APIs

• ssl (cterasdk.core.ssl.SSL) – Object holding the Portal SSL Certificate APIs

• startup (cterasdk.core.startup.Startup) – Object holding the Portal startup APIs

• syslog (cterasdk.core.syslog.Syslog) – Object holding the Portal syslog APIs

• antivirus (cterasdk.core.antivirus.Antivirus) – Object holding the Portal Antivirus APIs

• buckets (cterasdk.core.buckets.Buckets) – Object holding the Portal Storage Node APIs

• messaging (cterasdk.core.messaging.Messaging) – Object holding the Portal Messaging Service Management APIs

property backups_base_path

property cloud_drive_base_path

property context

class cterasdk.object.Portal.Portal(host, port, https)

Bases: CTERAHost

Parent class for communicating with the Portal through either GlobalAdmin or ServicesPortal

Variables

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

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

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

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

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

• directoryservice (cterasdk.core.directoryservice.DirectoryService) – Object holding the Portal Active Directory Service APIs

• zones (cterasdk.core.zones.Zones) – Object holding the Portal zones APIs

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

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

• cloudfs (cterasdk.core.cloudfs.CloudFS) – Object holding the Portal CloudFS 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

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

• files (cterasdk.core.files.browser.FileBrowser) – Object holding the Portal File Browsing 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, port=None, https=True)

Bases: Portal

Main class for Service operations on a Portal

property backups_base_path

property cloud_drive_base_path

property context