cterasdk.edge.types module

class cterasdk.edge.types.AccessControlEntryValidator

Bases: object

static validate_permission(permission)

class cterasdk.edge.types.AlertSettings(firmware_upgrade, device_startup, backup_success, storage_volume_usage, storage_volume_usage_percent, overdue_backup, overdue_backup_days, delayed_synchronization, delayed_synchronization_hours, disconnected, disconnected_hours)

Bases: Object

Alert Settings

Variables:

• firmware_upgrade (bool) – Enables alerting when a firmware upgrade occurs.

• device_startup (bool) – Enables alerting on Edge Filer shutdowns and startups.

• backup_success (bool) – Enables alerting upon successful backup completion.

• storage_volume_usage (bool) – Enables alerting for high storage volume utilization.

• storage_volume_usage_percent (int) – Volume usage percentage threshold that triggers an alert.

• overdue_backup (bool) – Enables alerting when a Cloud Backup is overdue.

• overdue_backup_days (int) – Number of days since last Cloud Backup after which an alert is triggered.

• delayed_synchronization (bool) – Enables alerting when synchronization is delayed.

• delayed_synchronization_hours (int) – Number of hours of synchronization delay to trigger an alert.

• disconnected (bool) – Enables alerting when the Edge Filer disconnects from the CTERA Portal.

• disconnected_hours (int) – Number of hours of disconnection duration to trigger an alert.

static from_server_object(server_object)

to_server_object()

class cterasdk.edge.types.AntivirusUpdateSchedule(**kwargs)

Bases: Object

Edge Filer Antivirus Update Schedule

static daily(hour, minute)

Daily update.

Parameters:

• hour (int) – Hour

• minute (int) – Minute

static monthly(day, hour, minute)

Monthly update.

Parameters:

• day (int) – Day

• hour (int) – Hour

• minute (int) – Minute

static weekly(day, hour, minute)

Weekly update.

Parameters:

• day (cterasdk.common.enum.DayOfWeek) – Day

• hour (int) – Hour

• minute (int) – Minute

class cterasdk.edge.types.DeduplicationStatus(enabled, size, usage)

Bases: Object

Edge Filer Local Deduplication Status Object

Variables:

• enabled (bool) – True if deduplication is enabled, False otherwise

• size (int) – Logical Size in Bytes

• usage (int) – Actual Size in Bytes

class cterasdk.edge.types.HostCredentials(host, username, password, host_type=None)

Bases: object

Source Host Credential Object

Variables:

• host_type (cterasdk.edge.enum.SourceType) – Host type

• host (str) – Fully qualified domain name, hostname or IP address

• username (str) – Source host account username

• password (str) – Source host account password

property host

property host_type

static localhost()

property password

property username

class cterasdk.edge.types.NFSv3AccessControlEntry(address, netmask, perm, insecure=False)

Bases: object

NFS v3 export access control entry :ivar str address: IP address, hostname or fully qualified domain name of client machine :ivar str netmask: Subnet mask :ivar cterasdk.edge.enum.FileAccessMode perm: File access permission :ivar bool insecure: Allow insecure NFS connections

property address

static from_server_object(server_object)

property insecure

property netmask

property perm

to_server_object()

class cterasdk.edge.types.NetworkInterface(port, name, mac)

Bases: Object

Interface Status

Variables:

• port (int) – Port number

• name (str) – Interface name

• mac (str) – MAC address

class cterasdk.edge.types.RemoveNFSv3AccessControlEntry(address, netmask)

Bases: object

Object holding address and netmasak for NFS v3 export access control entry :ivar str address: IP address, hostname or fully qualified domain name of client machine :ivar str netmask: Subnet mask

property address

property netmask

class cterasdk.edge.types.RemoveShareAccessControlEntry(principal_type, name)

Bases: UserGroupEntry

Object holding share access control principal type and name

Variables:

• principal_type (cterasdk.edge.enum.PrincipalType) – Principal type of the ACL

• name (str) – The name of the user or group

class cterasdk.edge.types.ShareAccessControlEntry(principal_type, name, perm)

Bases: object

Share access control entry for filer shares

Variables:

• principal_type (cterasdk.edge.enum.PrincipalType) – Principal type of the ACL

• name (str) – The name of the user or group

• perm (cterasdk.edge.enum.FileAccessMode) – The file access permission

static from_server_object(server_object)

property name

property perm

property principal_type

to_server_object()

class cterasdk.edge.types.StaticRoute(id, port, interface, network, gateway)

Bases: tuple

Object holding a network interface static route

gateway

Gateway IP address

id

Route ID

interface

Interface name

network

Network (CIDR)

port

Port number

class cterasdk.edge.types.TCPConnectResult(host, port, is_open)

Bases: tuple

Tuple holding the host and port to connect over TCP

host

The ip address, hostname or fully qualified domain name of the host

is_open

Boolean, indicating whether a TCP connection can be successfully established to the target host over the specified port

port

The port number

class cterasdk.edge.types.TCPService(host, port)

Bases: tuple

Tuple holding the host and port to connect over TCP

host

The ip address, hostname or fully qualified domain name of the host

port

The port number

class cterasdk.edge.types.UserGroupEntry(principal_type, name)

Bases: object

User or Group Entry

Variables:

• principal_type (cterasdk.edge.enum.PrincipalType) – Principal type of the ACL

• name (str) – The name of the user or group

static from_server_object(server_object)

property principal_type

to_server_object()