cterasdk.common.types module

cterasdk.common.types module#

class cterasdk.common.types.ADDomainIDMapping(domain, start, end)#

Bases: Object

Base Class for Directory Service ID Mapping

Variables:

domain (str) – The domain flat name

Parameters:

start (int) – The minimum id to use for mapping
end (int) – The maximum id to use for mapping

class cterasdk.common.types.AdvancedFilterRule(classname, field, operator)#: Bases: Object

class cterasdk.common.types.AfterOperator(right)#: Bases: Operator

class cterasdk.common.types.ApplicationBackupSet(apps)#: Bases: BackupSet

class cterasdk.common.types.BackupScheduleBuilder#

Bases: object

static interval(hours=None, minutes=None)#

Schedule backup to periodically, defaults to 24 hours

Parameters:

hours (int) – Hours
minutes (int) – Minutes

static window(time_range)#

Schedule backup to run at a specific time

Parameters:: time_range (cterasdk.common.types.TimeRange) – Time range

class cterasdk.common.types.BackupSet(name, directory_tree=None, filter_rules=None, defaults_dirs=None, template_dirs=None, enabled=True, boolean_function=None, comment=None)#: Bases: Object

class cterasdk.common.types.BeforeOperator(right)#: Bases: Operator

class cterasdk.common.types.BeginsWithOperator(right)#: Bases: Operator

class cterasdk.common.types.ConsentPage(header, body)#

Bases: tuple

Tuple holding the consent page header and body

body#: The consent page body

header#: The consent page header

class cterasdk.common.types.ContainsOperator(right)#: Bases: Operator

class cterasdk.common.types.CriteriaBuilder(criteria_type, criteria_field)#

Bases: object

build()#

class cterasdk.common.types.DateTimeCriteriaBuilder(criteria_type, criteria_field)#

Bases: CriteriaBuilder

after(value)#

before(value)#

class cterasdk.common.types.DirEntry(name, display_name=None, included=None, children=None)#: Bases: FileEntry

class cterasdk.common.types.DirectoryEntryFactory#

Bases: object

static root(included)#

class cterasdk.common.types.EndsWithOperator(right)#: Bases: Operator

class cterasdk.common.types.FileEntry(name, display_name=None, included=None)#: Bases: Object

class cterasdk.common.types.FileFilterBuilder#

Bases: object

Type = 'File'#

static extensions()#: Filter files by extension

static last_modified()#: Filter files by last modification date

static name()#: Filter files by name pattern

static names()#: Filter files by names

static path()#: Filter files by path pattern

static paths()#: Filter files by path

static size()#: Filter files by size

class cterasdk.common.types.FilterBackupSet(name, directory_tree=None, filter_rules=None, defaults_dirs=None, template_dirs=None, enabled=True, boolean_function=None, comment=None)#: Bases: BackupSet

class cterasdk.common.types.IntegerCriteriaBuilder(criteria_type, criteria_field)#

Bases: CriteriaBuilder

less_than(value)#

more_than(value)#

class cterasdk.common.types.IsOneOfOperator(right)#: Bases: Operator

class cterasdk.common.types.IsOperator(right)#: Bases: Operator

class cterasdk.common.types.LessThanOperator(right)#: Bases: Operator

class cterasdk.common.types.ListCriteriaBuilder(criteria_type, criteria_field)#

Bases: CriteriaBuilder

include(values)#

class cterasdk.common.types.MoreThanOperator(right)#: Bases: Operator

class cterasdk.common.types.Operator(right)#: Bases: Object

class cterasdk.common.types.PolicyRule(assignment, criteria)#: Bases: object

class cterasdk.common.types.PolicyRuleConverter#

Bases: object

static convert(rule, classname, property_name, assignment=None)#

class cterasdk.common.types.SoftwareUpdatePolicyBuilder#

Bases: object

Software Update Policy Builder

build()#: Build the Software Update Policy

download_and_install(download_and_install)#: Download and install updates automatically. :param bool download_and_install: Set True to enable and False to disable.

reboot_after_update(reboot_after_update)#

Restart device automatically after installing new firmware

Parameters:: reboot_after_update (bool) – Set True to enable and False to disable.

schedule(schedule)#

Set the throttling rule schedule

Parameters:: schedule (cterasdk.common.types.TimeRange) – Schedule

class cterasdk.common.types.SoftwareUpdatesTopic(enabled, reboot_after_update, reboot_when)#

Bases: Object

download_and_install(enabled)#

reboot_after_update(enabled)#

reboot_asap()#

schedule(window)#

class cterasdk.common.types.StringCriteriaBuilder(criteria_type, criteria_field)#

Bases: CriteriaBuilder

contains(value)#

endswith(value)#

equals(value)#

isoneof(values)#

startswith(value)#

class cterasdk.common.types.TaskSchedule#: Bases: Object

class cterasdk.common.types.ThrottlingRule#

Bases: object

Throttling Rule

Variables:

upload (int) – Throttling rate upstream (Kilobits)
download (int) – Throttling rate downstream (Kilobits)
start (str) – Start time
end (str) – End time
days (list[str]) – Days

static from_server_object(param)#

to_server_object()#

class cterasdk.common.types.ThrottlingRuleBuilder#

Bases: object

Bandwidth Throttling Rule Builder

build()#: Build the throttling rule

download(kbps)#

Throttle bandwidth downstream

Parameters:: kbps (int) – Kilobits per second

schedule(schedule)#

Set the throttling rule schedule

Parameters:: schedule (cterasdk.common.types.TimeRange) – Schedule

upload(kbps)#

Throttle bandwidth upstream

Parameters:: kbps (int) – Kilobits per second

class cterasdk.common.types.TimeRange#

Bases: object

Class representing a task schedule

build()#: Build the time range

days(days)#

Set days

Parameters:: days (list[cterasdk.common.enum.DayOfWeek]) – A list of days

end(end)#

End time

Parameters:: end (str) – A military time string ‘hh:mm:ss’ or a datetime object

start(start)#

Start time

Parameters:: start (str) – A military time string ‘hh:mm:ss’ or a datetime object

terminate_at_endtime()#: Terminate at end time, defaults to teminate on completion.

cterasdk.common.types module

Contents

cterasdk.common.types module#