Reference
Python client for the CDRouter Web API.
CDRouter
CDRouter
- class cdrouter.CDRouter(base, token=None, username=None, password=None, _getuser=<function _getuser_default>, _getpass=<function _getpass_default>, retries=3, insecure=False)
Service for accessing the CDRouter Web API.
- Parameters
base – Base HTTP or HTTPS URL for CDRouter system as a string, optionally including a port. For example http://localhost, http://cdrouter.lan:8015 or https://127.0.0.1.
token – (optional) CDRouter API token as a string. Not required if Automatic Login is enabled. If omitted, value will be taken from CDROUTER_API_TOKEN environment variable.
username – (optional) Username as string. Can be omitted if
token
is specified or Automatic Login is enabled. If omitted,_getuser
will be called when a username is required.password – (optional) Password as string. Can be omitted if
token
is specified or Automatic Login is enabled. If omitted,_getpass
will be called when a password is required._getuser – (optional) If username is None, function to be called as
_getuser(base)
which returns a username as a string. If_getuser
is None,cdrouter
will print a prompt to stdout and read the username from stdin._getpass – (optional) If password is None, a function to be called as
_getpass(base, username)
which returns user’s password as a string. If_getpass
is None,cdrouter
will print a password prompt to stdout and read the password from stdin.retries – (optional) The number of times to retry authentication with the CDRouter system before giving up as an int.
insecure – (optional) If bool True and base is an HTTPS URL, skip certificate verification and allow insecure connections to the CDRouter system.
- alerts
alerts.AlertsService
object
- annotations
- attachments
- authenticate(retries=3)
Set API token by authenticating via username/password.
- Parameters
retries – Number of authentication retries to make before giving up as an int.
- Returns
Learned API token
- Return type
string
- captures
captures.CapturesService
object
- configs
configs.ConfigsService
object
- devices
devices.DevicesService
object
- exports
exports.ExportsService
object
- highlights
highlights.HighlightsService
object
- history
history.HistoryService
object
- imports
imports.ImportsService
object
- jobs
jobs.JobsService
object
- packages
packages.PackagesService
object
- results
results.ResultsService
object
- system
system.SystemService
object
- tags
tags.TagsService
object
- tests
- testsuites
testsuites.TestsuitesService
object
- users
users.UsersService
object
CDRouterError
- class cdrouter.cdrouter.CDRouterError(*args, **kwargs)
Class for representing CDRouter Web API errors.
Links
- class cdrouter.cdrouter.Links(**kwargs)
Class representing paging information returned by
list
calls to the CDRouter Web API.- Parameters
first – (optional) First page number as an int.
last – (optional) Last page number as an int.
current – (optional) Current page number as an int.
total – (optional) Total element count across all pages as an int.
limit – (optional) Resources per page limit as an int.
next – (optional) Next page number as an int.
prev – (optional) Previous page number as an int.
Filters
Field
- class cdrouter.filters.Field(*args)
Class for constructing CDRouter Web API filters. Field objects can be passed to
filter
parameters to make constructing filters easier.The
value
parameter passed to Field methods is converted to a string using the builtinstr
function. Bool values are additionally lowercased such that boolTrue
becomes string'true'
andFalse
becomes string'false'
. The Field methodscontains
,contained_by
andoverlaps
accept a variable number of values which are converted into a list in accordance with the API’s syntax. For example, the int values1, 2, 3
is converted to the string'{1,2,3}'
and the string values'one', 'two', 'three'
is converted to the string'{one,two,three}'
.Usage:
from cdrouter.filters import Field as field # each pair of filters below are equivalent c.packages.list(filter=[ field('id').eq(123), 'id=123', # field('use_as_testlist').ne(True), 'use_as_testlist!=true', # field('name').not_().match('^(foo|bar)$', ignorecase=True), 'name!~*^(foo|bar)$', # field('tags').contains('foo', 'bar', 'baz'), 'tags@>{foo,bar,baz}', ])
See this page for more details on CDRouter Web API filters.
- contained_by(*args)
Construct an array contained by (
<@
) filter.- Parameters
args – Filter values
- Returns
filters.Field
object- Return type
- contains(*args)
Construct an array contains (
@>
) filter.- Parameters
args – Filter values
- Returns
filters.Field
object- Return type
- eq(value)
Construct an equal to (
=
) filter.- Parameters
value – Filter value
- Returns
filters.Field
object- Return type
- ge(value)
Construct a greater than or equal to (
>=
) filter.- Parameters
value – Filter value
- Returns
filters.Field
object- Return type
- gt(value)
Construct a greater than (
>
) filter.- Parameters
value – Filter value
- Returns
filters.Field
object- Return type
- le(value)
Construct a less than or equal to (
<=
) filter.- Parameters
value – Filter value
- Returns
filters.Field
object- Return type
- lt(value)
Construct a less than (
<
) filter.- Parameters
value – Filter value
- Returns
filters.Field
object- Return type
- match(value, ignorecase=False)
Construct a regexp match (
~
) filter. Combine withnot_
method to construct a negative regexp match (!~
) filter.- Parameters
value – Filter value
ignorecase – If bool True, make match case insensitive (
~*
,!~*
)
- Returns
filters.Field
object- Return type
- ne(value)
Construct a not equal to (
!=
) filter.- Parameters
value – Filter value
- Returns
filters.Field
object- Return type
- not_()
Negate the filter. Not supported by
contains
,contained_by
oroverlaps
methods.- Returns
filters.Field
object- Return type
- overlaps(*args)
Construct an array overlaps (
&&
) filter.- Parameters
args – Filter values
- Returns
filters.Field
object- Return type
Configs
ConfigsService
- class cdrouter.configs.ConfigsService(service)
Service for accessing CDRouter Configs.
- bulk_copy(ids)
Bulk copy a set of configs.
- Parameters
ids – Int list of config IDs.
- Returns
configs.Config
list
- bulk_delete(ids=None, filter=None, type=None, all=False)
Bulk delete a set of configs.
- Parameters
ids – (optional) Int list of config IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_edit(_fields, ids=None, filter=None, type=None, all=False, testvars=None)
Bulk edit a set of configs.
- Parameters
_fields –
configs.Config
objectids – (optional) Int list of config IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
testvars – (optional)
configs.ConfigTestvars
list
- bulk_edit_testvars(id, testvars)
Bulk edit a config’s testvars.
- Parameters
id – Config ID as an int.
testvars –
configs.Testvar
list
- Returns
configs.Testvar
list
- bulk_export(ids)
Bulk export a set of configs.
- Parameters
ids – Int list of config IDs.
- Return type
tuple (io.BytesIO, ‘filename’)
- bulk_upgrade(ids=None, filter=None, type=None, all=False)
Bulk upgrade a set of configs.
- Parameters
ids – (optional) Int list of config IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- check_config(contents)
Process config contents with cdrouter-cli -check-config.
- Parameters
contents – Config contents as string.
- Returns
configs.CheckConfig
object- Return type
- create(resource)
Create a new config.
- Parameters
resource –
configs.Config
object- Returns
configs.Config
object- Return type
- create_testvar_group(id, group)
Create a testvar group in a config. Creating a testvar group is equivalent to removing the IGNORE keyword from the group in the config.
- Parameters
id – Config ID as an int.
group – Testvar group as string.
- delete(id)
Delete a config.
- Parameters
id – Config ID as an int.
- delete_testvar(id, name, group=None)
Delete a testvar in a config. Deleting a testvar unsets any explicitly configured value for it in the config.
- Parameters
id – Config ID as an int.
name – Testvar name as string.
group – (optional) Testvar group as string.
- delete_testvar_group(id, group)
Delete a testvar group in a config. Deleting a testvar group is equivalent to adding the IGNORE keyword to the group in the config.
- Parameters
id – Config ID as an int.
group – Testvar group as string.
- edit(resource)
Edit a config.
- Parameters
resource –
configs.Config
object- Returns
configs.Config
object- Return type
Edit shares for a config.
- Parameters
id – Config ID as an int.
user_ids – User IDs as int list.
- Returns
cdrouter.Share
list
- edit_testvar(id, resource)
Edit a testvar in a config.
- Parameters
id – Config ID as an int.
resource –
configs.Testvar
object.
- Returns
configs.Testvar
object- Return type
- export(id)
Export a config.
- Parameters
id – Config ID as an int.
- Return type
tuple (io.BytesIO, ‘filename’)
- get(id)
Get a config.
- Parameters
id – Config ID as an int.
- Returns
configs.Config
object- Return type
- get_by_name(name)
Get a config by name.
- Parameters
name – Config name as string.
- Returns
configs.Config
object- Return type
- get_interfaces(contents)
Process config contents with cdrouter-cli -print-interfaces.
- Parameters
contents – Config contents as string.
- Returns
configs.Interfaces
list
- get_networks(contents)
Process config contents with cdrouter-cli -print-networks-json.
- Parameters
contents – Config contents as string.
- Returns
configs.Networks
object- Return type
- get_new()
Get output of cdrouter-cli -new-config.
- Return type
string
- get_plaintext(id)
Get a config as plaintext.
- Parameters
id – Config ID as an int.
- Return type
string
Get shares for a config.
- Parameters
id – Config ID as an int.
- Returns
cdrouter.Share
list
- get_testvar(id, name, group=None)
Get a testvar from a config.
- Parameters
id – Config ID as an int.
name – Testvar name as string.
group – (optional) Testvar group as string.
- Returns
configs.Testvar
object- Return type
- iter_list(*args, **kwargs)
Get a list of configs. Whereas
list
fetches a single page of configs according to itslimit
andpage
arguments,iter_list
returns all configs by internally making successive calls tolist
.- Parameters
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
configs.Config
list
- list(filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of configs, using summary representation by default (see
detailed
parameter).- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
configs.Page
object
- list_testvars(id)
Get a list of a config’s testvars.
- Parameters
id – Config ID as an int.
- Returns
configs.Testvar
list
- lock(id)
Lock a config. Locking prevents the config from being modified or deleted until it is unlocked.
- Parameters
id – Config ID as an int.
- Returns
configs.Config
object- Return type
- unlock(id)
Unlock a config. Unlocking a locked config allows it to be modified or deleted once again.
- Parameters
id – Config ID as an int.
- Returns
configs.Config
object- Return type
- upgrade_config(contents)
Process config contents with cdrouter-cli -upgrade-config.
- Parameters
contents – Config contents as string.
- Returns
configs.UpgradeConfig
object- Return type
Config
- class cdrouter.configs.Config(**kwargs)
Model for CDRouter Configs.
- Parameters
id – (optional) Config ID as an int.
name – (optional) Config name as string.
description – (optional) Config description as string.
created – (optional) Creation time as DateTime.
updated – (optional) Last-updated time as DateTime.
locked – (optional) Bool True if config is locked.
contents – (optional) Config contents as string.
user_id – (optional) User ID as an int.
result_id – (optional) Result ID as an int (if a config snapshot).
tags – (optional) Tags as string list.
note – (optional) Note as string.
interfaces – (optional)
configs.Interfaces
list (if a config snapshot).
Page
- class cdrouter.configs.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
configs.Config
listlinks –
cdrouter.Links
object
ConfigError
- class cdrouter.configs.ConfigError(**kwargs)
Model for CDRouter Check Config Error.
- Parameters
lines – (optional) Line numbers as string list.
error – (optional) Error message as string.
CheckConfig
- class cdrouter.configs.CheckConfig(**kwargs)
Model for CDRouter Check Config.
- Parameters
errors – (optional)
configs.ConfigError
list
UpgradeConfig
- class cdrouter.configs.UpgradeConfig(**kwargs)
Model for CDRouter Config Upgrades.
- Parameters
success – (optional) Bool True if successful.
output – (optional) Output as string.
Networks
- class cdrouter.configs.Networks(**kwargs)
Model for CDRouter Config Networks.
- Parameters
name – (optional) Network name as string.
type – (optional) Network type as string.
side – (optional) Network side as string.
title – (optional) Network title as string.
children – (optional)
configs.Networks
list.
Interfaces
- class cdrouter.configs.Interfaces(**kwargs)
Model for CDRouter Config Interfaces.
- Parameters
name – (optional) Interface name (i.e. ‘lan’, ‘wan’, etc.) as string.
value – (optional) Interface value (i.e. ‘eth0’, ‘eth1’, etc.) as string.
is_wireless – (optional) Bool True if interface is a wireless interface.
is_ics – (optional) Bool True if interface is the ICS interface.
Testvar
- class cdrouter.configs.Testvar(**kwargs)
Model for CDRouter Config Testvars.
- Parameters
group – (optional) Testvar group name as string.
name – (optional) Testvar name as string.
value – (optional) Testvar value as string.
default – (optional) Testvar default value as string.
isdefault – (optional) Bool True if testvar is set to default value.
line – (optional) Config file line number as int.
action – (optional) Action to perform on the testvar or group as string. Must be set-testvar, delete-testvar, create-group or delete-group. If not specified, defaults to set-testvar.
Devices
DevicesService
- class cdrouter.devices.DevicesService(service)
Service for accessing CDRouter Devices.
- bulk_copy(ids)
Bulk copy a set of devices.
- Parameters
ids – Int list of device IDs.
- Returns
devices.Device
list
- bulk_delete(ids=None, filter=None, type=None, all=False)
Bulk delete a set of devices.
- Parameters
ids – (optional) Int list of device IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_edit(_fields, ids=None, filter=None, type=None, all=False)
Bulk edit a set of devices.
- Parameters
_fields –
devices.Device
objectids – (optional) Int list of device IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_export(ids)
Bulk export a set of devices.
- Parameters
ids – Int list of device IDs.
- Return type
tuple (io.BytesIO, ‘filename’)
- connect(id)
Open proxy connection to a device’s management interface.
- Parameters
id – Device ID as an int.
- Returns
devices.Connection
object- Return type
- create(resource)
Create a new device.
- Parameters
resource –
devices.Device
object- Returns
devices.Device
object- Return type
- delete(id)
Delete a device.
- Parameters
id – Device ID as an int.
- disconnect(id)
Close proxy connection to a device’s management interface.
- Parameters
id – Device ID as an int.
- edit(resource)
Edit a device.
- Parameters
resource –
devices.Device
object- Returns
devices.Device
object- Return type
Edit shares for a device.
- Parameters
id – Device ID as an int.
user_ids – User IDs as int list.
- Returns
cdrouter.Share
list
- export(id)
Export a device.
- Parameters
id – Device ID as an int.
- Return type
tuple (io.BytesIO, ‘filename’)
- get(id)
Get a device.
- Parameters
id – Device ID as an int.
- Returns
devices.Device
object- Return type
- get_by_name(name)
Get a device by name.
- Parameters
name – Device name as string.
- Returns
devices.Device
object- Return type
- get_connection(id)
Get information on proxy connection to a device’s management interface.
- Parameters
id – Device ID as an int.
- Returns
devices.Connection
object- Return type
Get shares for a device.
- Parameters
id – Device ID as an int.
- Returns
cdrouter.Share
list
- iter_list(*args, **kwargs)
Get a list of devices. Whereas
list
fetches a single page of devices according to itslimit
andpage
arguments,iter_list
returns all devices by internally making successive calls tolist
.- Parameters
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
devices.Device
list
- list(filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of devices, using summary representation by default (see
detailed
parameter).- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
devices.Page
object
- lock(id)
Lock a device. Locking prevents the device from being modified or deleted until it is unlocked.
- Parameters
id – Device ID as an int.
- Returns
devices.Device
object- Return type
- power_off(id)
Power off a device using it’s power off command.
- Parameters
id – Device ID as an int.
- Returns
devices.PowerCmd
object- Return type
- power_on(id)
Power on a device using it’s power on command.
- Parameters
id – Device ID as an int.
- Returns
devices.PowerCmd
object- Return type
- unlock(id)
Unlock a device. Unlocking a locked device allows it to be modified or deleted once again.
- Parameters
id – Device ID as an int.
- Returns
devices.Device
object- Return type
Device
- class cdrouter.devices.Device(**kwargs)
Model for CDRouter Devices.
- Parameters
id – (optional) Device ID as an int.
name – (optional) Name as string.
created – (optional) Creation time as DateTime.
updated – (optional) Last-updated time as DateTime.
locked – (optional) Bool True if device is locked.
user_id – (optional) User ID as an int.
result_id – (optional) Result ID as an int (if a device snapshot).
attachments_dir – (optional) Filepath for attachments as string.
picture_id – (optional) Attachment ID for used for device picture as an int.
tags – (optional) Tags as string list.
default_ip – (optional) Default IP as a string
default_login – (optional) Default login as a string
default_password – (optional) Default password as a string
default_ssid – (optional) Default SSID as a string
location – (optional) Location as a string
device_category – (optional) Device category as a string
manufacturer – (optional) Manufacturer as a string
manufacturer_oui – (optional) Manufacturer OUI as a string
model_name – (optional) Model name as a string
model_number – (optional) Model number as a string
description – (optional) Description as a string
product_class – (optional) Product class as a string
serial_number – (optional) Serial number as a string
hardware_version – (optional) Hardware version as a string
software_version – (optional) Software version as a string
provisioning_code – (optional) Provisioning code as a string
note – (optional) Note as a string
insecure_mgmt_url – (optional) True if insecure HTTPS management URLs are allowed
mgmt_url – (optional) Management URL as a string
add_mgmt_addr – (optional) True if address should be configured when opening proxy connection
mgmt_interface – (optional) Interface on which to configure address as string
mgmt_addr – (optional) Address to configure as string
power_on_cmd – (optional) Command to run to power on device as string
power_off_cmd – (optional) Command to run to power off device as string
Page
- class cdrouter.devices.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
devices.Device
listlinks –
cdrouter.Links
object
PowerCmd
- class cdrouter.devices.PowerCmd(**kwargs)
Model for CDRouter Device Power command result.
- Parameters
output – (optional) Output from power on/off command as string.
Connection
- class cdrouter.devices.Connection(**kwargs)
Model for CDRouter Device Connections.
- Parameters
proxy_port – (optional) HTTP proxy port as an int.
proxy_https – (optional) HTTPS proxy port as an int.
Attachments
AttachmentsService
- class cdrouter.attachments.AttachmentsService(service)
- create(id, fd, filename='attachment-name')
Add an attachment to a device.
- Parameters
id – Device ID as an int.
fd – File-like object to upload.
filename – (optional) Name to use for new attachment as a string.
- Returns
attachments.Attachment
object- Return type
- delete(id, attid)
Delete a device’s attachment.
- Parameters
id – Device ID as an int.
attid – Attachment ID as an int.
- download(id, attid)
Download a device’s attachment.
- Parameters
id – Device ID as an int.
attid – Attachment ID as an int.
- Return type
tuple (io.BytesIO, ‘filename’)
- edit(resource)
Edit a device’s attachment.
- Parameters
resource –
attachments.Attachment
object- Returns
attachments.Attachment
object- Return type
- get(id, attid)
Get a device’s attachment.
- Parameters
id – Device ID as an int.
attid – Attachment ID as an int.
- Returns
attachments.Attachment
object- Return type
- iter_list(id, *args, **kwargs)
Get a list of attachments. Whereas
list
fetches a single page of attachments according to itslimit
andpage
arguments,iter_list
returns all attachments by internally making successive calls tolist
.- Parameters
id – Device ID as an int.
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
attachments.Attachment
list
- list(id, filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of a device’s attachments, using summary representation by default (see
detailed
parameter).- Parameters
id – Device ID as an int.
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
attachments.Page
object
- thumbnail(id, attid, size=None)
Download thumbnail of a device’s attachment. Attachment must be a GIF, JPEG or PNG image.
- Parameters
id – Device ID as an int.
attid – Attachment ID as an int.
size – (optional) Height in pixels of generated thumbnail.
- Return type
tuple (io.BytesIO, ‘filename’)
Attachment
- class cdrouter.attachments.Attachment(**kwargs)
Model for CDRouter Attachments.
- Parameters
id – (optional) Attachment ID as an int.
name – (optional) Name as string.
description – (optional) Description as string.
created – (optional) Creation time as DateTime.
updated – (optional) Last-updated time as DateTime.
size – (optional) Attachment size as an int.
path – (optional) Filepath to attachment as string.
device_id – (optional) Device ID as an int.
Page
- class cdrouter.attachments.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
attachments.Attachment
listlinks –
cdrouter.Links
object
Jobs
JobsService
- class cdrouter.jobs.JobsService(service)
Service for accessing CDRouter Jobs.
- bulk_delete(ids=None, filter=None, type=None, all=False)
Bulk delete a set of jobs.
- Parameters
ids – (optional) Int list of job IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_launch(jobs=None, _fields=None, filter=None, type=None, all=False)
Bulk launch a set of jobs.
- Parameters
jobs –
jobs.Job
list_fields –
jobs.Job
objectfilter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- Returns
jobs.Job
list
- delete(id)
Delete a job.
- Parameters
id – Job ID as an int.
- edit(resource)
Edit a job.
- Parameters
resource –
jobs.Job
object- Returns
jobs.Job
object- Return type
- get_interfaces(resource)
Process job with cdrouter-cli -print-interfaces.
- Parameters
resource –
jobs.Job
object- Returns
configs.Interfaces
list
- iter_list(*args, **kwargs)
Get a list of jobs. Whereas
list
fetches a single page of jobs according to itslimit
andpage
arguments,iter_list
returns all jobs by internally making successive calls tolist
.- Parameters
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
jobs.Job
list
- launch(resource)
Launch a new job.
- Parameters
resource –
jobs.Job
object- Returns
jobs.Job
object- Return type
- list(filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of jobs, using summary representation by default (see
detailed
parameter).- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
jobs.Page
object
Job
- class cdrouter.jobs.Job(**kwargs)
Model for CDRouter Jobs.
- Parameters
id – (optional) Job ID as an int.
active – (optional) Bool True if status is ‘running’.
status – (optional) Job status as a string.
options – (optional)
jobs.Options
objectpackage_id – (optional) Package ID as an int.
package_name – (optional) Package name as string.
config_id – (optional) Config ID as an int.
config_name – (optional) Config name as string.
device_id – (optional) Device ID as an int.
device_name – (optional) Device name as string.
result_id – (optional) Result ID as an int.
user_id – (optional) User ID as an int.
created – (optional) Job creation time as DateTime.
updated – (optional) Job last-updated time as DateTime.
automatic – (optional) Bool True if job scheduled automatically DateTime.
run_at – (optional) Job scheduled run-time DateTime.
interfaces – (optional)
configs.Interfaces
listinterface_names – (optional) Job interface names as string list.
uses_wireless – (optional) Bool True if job uses any wireless interfaces.
uses_ics – (optional) Bool True if job uses any ICS interfaces.
ics_interface_name – (optional) If uses_ics is True, ICS interface name as string.
Options
- class cdrouter.jobs.Options(**kwargs)
Model for CDRouter Job Options.
- Parameters
tags – (optional) Tags as string list.
skip_tests – (optional) Tests to skip as string list.
begin_at – (optional) Test name to begin testing at as string.
end_at – (optional) Test name to end testing at as string.
testvars – (optional) Extra testvars to set as a
configs.Testvar
list.extra_cli_args – (optional) Extra cdrouter-cli arguments as string.
Page
- class cdrouter.jobs.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
jobs.Job
listlinks –
cdrouter.Links
object
Packages
PackagesService
- class cdrouter.packages.PackagesService(service)
Service for accessing CDRouter Packages.
- analyze(id)
Get a list of tests that will be skipped for a package.
- Parameters
id – Package ID as an int.
- Returns
packages.Analysis
object- Return type
- bulk_copy(ids)
Bulk copy a set of packages.
- Parameters
ids – Int list of package IDs.
- Returns
packages.Package
list
- bulk_delete(ids=None, filter=None, type=None, all=False)
Bulk delete a set of packages.
- Parameters
ids – (optional) Int list of package IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_edit(_fields, ids=None, filter=None, type=None, all=False)
Bulk edit a set of packages.
- Parameters
_fields –
packages.Package
objectids – (optional) Int list of package IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_export(ids)
Bulk export a set of packages.
- Parameters
ids – Int list of package IDs.
- Return type
tuple (io.BytesIO, ‘filename’)
- create(resource)
Create a new package.
- Parameters
resource –
packages.Package
object- Returns
packages.Package
object- Return type
- delete(id)
Delete a package.
- Parameters
id – Package ID as an int.
- edit(resource)
Edit a package.
- Parameters
resource –
packages.Package
object- Returns
packages.Package
object- Return type
Edit shares for a package.
- Parameters
id – Package ID as an int.
user_ids – User IDs as int list.
- Returns
cdrouter.Share
list
- export(id)
Export a package.
- Parameters
id – Package ID as an int.
- Return type
tuple (io.BytesIO, ‘filename’)
- get(id)
Get a package.
- Parameters
id – Package ID as an int.
- Returns
packages.Package
object- Return type
- get_by_name(name)
Get a package by name.
- Parameters
name – Package name as string.
- Returns
packages.Package
object- Return type
- get_interfaces(resource)
Process package with cdrouter-cli -print-interfaces.
- Parameters
resource –
packages.Package
object- Returns
configs.Interfaces
list
Get shares for a package.
- Parameters
id – Package ID as an int.
- Returns
cdrouter.Share
list
- iter_list(*args, **kwargs)
Get a list of packages. Whereas
list
fetches a single page of packages according to itslimit
andpage
arguments,iter_list
returns all packages by internally making successive calls tolist
.- Parameters
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
packages.Package
list
- list(filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of packages, using summary representation by default (see
detailed
parameter).- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
packages.Page
object
- lock(id)
Lock a package. Locking prevents the package from being modified or deleted until it is unlocked.
- Parameters
id – Package ID as an int.
- Returns
packages.Package
object- Return type
- testlist_expanded(id)
Get a list of all tests in a package, with any addons, modules or testlists expanded.
- Parameters
id – Package ID as an int.
- Return type
string list
- unlock(id)
Unlock a package. Unlocking a locked package allows it to be modified or deleted once again.
- Parameters
id – Package ID as an int.
- Returns
packages.Package
object- Return type
Package
- class cdrouter.packages.Package(**kwargs)
Model for CDRouter Packages.
- Parameters
id – (optional) Package ID as an int.
name – (optional) Name as a string.
description – (optional) Description as a string.
created – (optional) Creation time as DateTime.
updated – (optional) Last-updated time as DateTime.
locked – (optional) Bool True if package is locked.
test_count – (optional) Test count as an int.
testlist – (optional) Testlist as a string list.
extra_cli_args – (optional) Extra CLI args as a string.
user_id – (optional) User ID as an int.
agent_id – (optional) Agent ID as an int.
config_id – (optional) Config ID as an int.
result_id – (optional) Result ID as an int (if a package snapshot).
device_id – (optional) Device ID as an int.
options – (optional)
packages.Options
objecttags – (optional) Tags as a string list.
use_as_testlist – (optional) Bool True if package is used as a testlist.
note – (optional) Note as a string.
schedule – (optional)
packages.Schedule
objectinterfaces – (optional)
configs.Interfaces
list (if a package snapshot).
Options
- class cdrouter.packages.Options(**kwargs)
Model for CDRouter Package Options.
- Parameters
forever – (optional) Bool True if package looped forver.
loop – (optional) Loop count as an int.
repeat – (optional) Repeat count as an int.
maxfail – (optional) Max fail count as an int.
duration – (optional) Max testing time duration as an int.
duration_units – (optional) Units for max testing time duration as string. Must be seconds, minutes, hours or days.
duration_interrupt – (optional) Bool True if max testing time duration elapsing should interrupt currently running test.
duration_no_error – (optional) Bool True if max testing time duration elapsing should not be considered an error.
wait – (optional) Wait between tests duration as an int.
pause – (optional) Bool True if pausing between tests.
shuffle – (optional) Bool True if testlist is shuffled.
seed – (optional) Shuffle seed as an int.
retry – (optional) Retry count as an int.
rdelay – (optional) Retry delay as an int.
Schedule
- class cdrouter.packages.Schedule(**kwargs)
Model for CDRouter Package Schedule.
- Parameters
enabled – (optional) Bool True if schedule is enabled.
spec – (optional) Cron spec schedule as a string.
options – (optional)
results.Options
object
Page
- class cdrouter.packages.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
packages.Package
listlinks –
cdrouter.Links
object
Analysis
- class cdrouter.packages.Analysis(**kwargs)
Model for CDRouter Package Analysis.
- Parameters
total_count – (optional) Total count as an int.
run_count – (optional) Run count as an int.
skipped_count – (optional) Skipped test count as an int.
skipped_tests – (optional) Skipped tests as a string list.
Results
ResultsService
- class cdrouter.results.ResultsService(service)
Service for accessing CDRouter Results.
- all_stats()
Compute stats for all results.
- Returns
results.AllStats
object- Return type
- bulk_delete(ids=None, filter=None, type=None, all=False)
Bulk delete a set of results.
- Parameters
ids – (optional) Int list of result IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_edit(_fields, ids=None, filter=None, type=None, all=False)
Bulk edit a set of results.
- Parameters
_fields –
results.Result
objectids – (optional) Int list of result IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_export(ids, exclude_captures=False)
Bulk export a set of results.
- Parameters
ids – Int list of result IDs.
- Return type
tuple (io.BytesIO, ‘filename’)
- delete(id)
Delete a result.
- Parameters
id – Result ID as an int.
- diff_stats(ids)
Compute diff stats for a set of results.
- Parameters
id – Result IDs as int list.
- Returns
results.DiffStats
object- Return type
- download_logdir_archive(id, format='zip', exclude_captures=False)
Download logdir archive in tgz or zip format.
- Parameters
id – Result ID as an int.
format – (optional) Format to download, must be string zip or tgz.
exclude_captures – If bool True, don’t include capture files
- Return type
tuple (io.BytesIO, ‘filename’)
- edit(resource)
Edit a result.
- Parameters
resource –
results.Result
object- Returns
results.Result
object- Return type
Edit shares for a result.
- Parameters
id – Result ID as an int.
user_ids – User IDs as int list.
- Returns
cdrouter.Share
list
- export(id, exclude_captures=False)
Export a result.
- Parameters
id – Result ID as an int.
exclude_captures – If bool True, don’t export capture files
- Return type
tuple (io.BytesIO, ‘filename’)
- get(id)
Get a result.
- Parameters
id – Result ID as an int.
- Returns
results.Result
object- Return type
- get_logdir_file(id, filename)
Download a logdir file.
- Parameters
id – Result ID as an int.
filename – Logdir filename as string.
- Return type
tuple (io.BytesIO, ‘filename’)
Get shares for a result.
- Parameters
id – Result ID as an int.
- Returns
cdrouter.Share
list
- get_test_metric(id, tname, metric)
Get a test graph metric. This method is only for getting “bandwidth” or “latency” test metrics.
This method is DEPRECATED since cdrouter.py v0.9.0, new code should use TestResultsService.get_test_metric instead.
- Parameters
id – Result ID as an int.
tname – Test name as string.
metric – Metric name as string.
- Returns
metrics.GraphMetric
list- Return type
- get_test_metric_csv(id, tname, metric)
Get a test metric as CSV. This method is only for getting “bandwidth” or “latency” test metrics.
- Parameters
id – Result ID as an int.
tname – Test name as string.
metric – Metric name as string.
- Return type
string
- iter_list(*args, **kwargs)
Get a list of results. Whereas
list
fetches a single page of results according to itslimit
andpage
arguments,iter_list
returns all results by internally making successive calls tolist
.- Parameters
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
results.Result
list
- list(filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of results, using summary representation by default (see
detailed
parameter).- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
results.Page
object
- list_csv(filter=None, type=None, sort=None, limit=None, page=None)
Get a list of results as CSV.
- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
- Return type
string
- list_logdir(id, filter=None, sort=None)
Get a list of logdir files.
- Parameters
id – Result ID as an int.
filter – Filter to apply as string.
sort – Sort field to apply as string.
- Returns
results.LogDirFile
list
- list_metrics(id, filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of metrics, using summary representation by default (see
detailed
parameter).- Parameters
id – Result ID as an int.
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
metrics.Page
object- Return type
- lock(id)
Lock a result. Locking prevents the result from being modified or deleted until it is unlocked.
- Parameters
id – Result ID as an int.
- Returns
results.Result
object- Return type
- pause(id, when=None)
Pause a running result.
- Parameters
id – Result ID as an int.
when – Must be string end-of-test or end-of-loop.
- pause_end_of_loop(id)
Pause a running result at the end of the current loop.
- Parameters
id – Result ID as an int.
- pause_end_of_test(id)
Pause a running result at the end of the current test.
- Parameters
id – Result ID as an int.
- progress_stats(id)
Compute progress stats for a result.
- Parameters
id – Result ID as an int.
- Returns
results.Progress
object- Return type
- set_stats(ids)
Compute stats for a set of results.
- Parameters
id – Result IDs as int list.
- Returns
results.SetStats
object- Return type
- single_stats(id)
Compute stats for a result.
- Parameters
id – Result ID as an int.
- Returns
results.SingleStats
object- Return type
- stop(id, when=None)
Stop a running result.
- Parameters
id – Result ID as an int.
when – Must be string end-of-test or end-of-loop.
- stop_end_of_loop(id)
Stop a running result at the end of the current loop.
- Parameters
id – Result ID as an int.
- stop_end_of_test(id)
Stop a running result at the end of the current test.
- Parameters
id – Result ID as an int.
- summary_stats(id)
Compute summary stats for a result.
- Parameters
id – Result ID as an int.
- Returns
results.SummaryStats
object- Return type
- unlock(id)
Unlock a result. Unlocking a locked result allows it to be modified or deleted once again.
- Parameters
id – Result ID as an int.
- Returns
results.Result
object- Return type
- unpause(id)
Unpause a running result.
- Parameters
id – Result ID as an int.
- updates(id, update_id=None)
Get updates of a running result via long-polling. If no updates are available, CDRouter waits up to 10 seconds before sending an empty response.
- Parameters
id – Result ID as an int.
update_id – (optional) Update ID as an int.
- Returns
results.Update
object- Return type
Result
- class cdrouter.results.Result(**kwargs)
Model for CDRouter Results.
- Parameters
id – (optional) Result ID as an int.
created – (optional) Creation time as DateTime.
updated – (optional) Last-updated time as DateTime.
locked – (optional) Bool True if result is locked.
result – (optional) Result as a string.
active – (optional) Bool True if status is ‘running’ or ‘paused’.
status – (optional) Status as a string.
loops – (optional) Loop count as an int.
tests – (optional) Test count as an int.
passed – (optional) Passed count as an int.
fail – (optional) Failed count as an int.
alerts – (optional) Alert count as an int.
duration – (optional) Duration in seconds as an int.
size_on_disk – (optional) Size on disk in bytes as an int.
starred – (optional) Bool True if result is starred.
archived – (optional) Bool True if result is archived.
result_dir – (optional) Filepath to result directory as a string.
agent_name – (optional) Agent name as a string.
package_name – (optional) Package name as a string.
device_name – (optional) Device name as a string.
config_name – (optional) Config name as a string.
package_id – (optional) Package ID as an int.
device_id – (optional) Device ID as an int.
config_id – (optional) Config ID as an int.
user_id – (optional) User ID as an int.
note – (optional) Note as a string.
pause_message – (optional) Pause message as a string (if currently paused).
build_info – (optional) Build info as a string.
tags – (optional) Tags as a string list.
testcases – (optional) Testcases as a string list.
options – (optional)
results.Options
objectfeatures – (optional) Dict of feature name strings to
results.Feature
objects.interfaces – (optional)
configs.Interfaces
list.
Page
- class cdrouter.results.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
results.Result
listlinks –
cdrouter.Links
object
TestCount
- class cdrouter.results.TestCount(**kwargs)
Model for CDRouter Test Counts.
- Parameters
name – (optional) Name as a string.
count – (optional) Count as an int.
TestDuration
- class cdrouter.results.TestDuration(**kwargs)
Model for CDRouter Test Durations.
- Parameters
name – (optional) Name as a string.
duration – (optional) Duration as an int.
ResultBreakdown
- class cdrouter.results.ResultBreakdown(**kwargs)
Model for CDRouter Result Breakdowns.
- Parameters
passed – (optional) Pass count as an int.
failed – (optional) Fail count as an int.
skipped – (optional) Skipped count as an int.
alerted – (optional) Alerted count as an int.
TimeBreakdown
- class cdrouter.results.TimeBreakdown(**kwargs)
Model for CDRouter Time Breakdowns.
- Parameters
passed – (optional) Pass duration as an int.
failed – (optional) Fail duration as an int.
SetStats
- class cdrouter.results.SetStats(**kwargs)
Model for CDRouter Result Set Stats.
- Parameters
frequent_failures – (optional)
results.TestCount
listlongest_tests – (optional)
results.TestDuration
listresult_breakdown – (optional)
results.ResultBreakdown
objecttime_breakdown – (optional)
results.TimeBreakdown
object
TestResultSummary
- class cdrouter.results.TestResultSummary(**kwargs)
Model for CDRouter TestResult summaries.
- Parameters
id – (optional) Result ID as an int.
seq – (optional) TestResult sequence ID as an int.
result – (optional) Test result as string.
alerts – (optional) Alert count as an int.
duration – (optional) Test duration as int.
flagged – (optional) True if test is flagged.
name – (optional) Test name as string.
description – (optional) Test description as string.
TestResultDiff
- class cdrouter.results.TestResultDiff(**kwargs)
Model for CDRouter TestResult diffs.
- Parameters
name – (optional) Test name as a string.
summaries – (optional)
results.TestResultSummary
list
DiffStats
- class cdrouter.results.DiffStats(**kwargs)
Model for CDRouter Result Diff Stats.
- Parameters
tests – (optional)
results.TestResultDiff
list
TestResultBreakdown
- class cdrouter.results.TestResultBreakdown(**kwargs)
Model for CDRouter TestResult Breakdowns.
- Parameters
failed_at_least_once – (optional)
results.TestCount
listpassed_every_time – (optional)
results.TestCount
list
Progress
- class cdrouter.results.Progress(**kwargs)
Model for CDRouter Result Progress.
- Parameters
finished – (optional) Finished count as an int.
total – (optional) Total count as an int.
progress – (optional) Progress as an int.
unit – (optional) Unit as a string.
SingleStats
- class cdrouter.results.SingleStats(**kwargs)
Model for CDRouter Single Results Stats.
- Parameters
result_breakdown – (optional)
results.ResultBreakdown
objectprogress – (optional)
results.Progress
object
SummaryStats
- class cdrouter.results.SummaryStats(**kwargs)
Model for CDRouter Summary Results Stats.
- Parameters
result_breakdown – (optional)
results.ResultBreakdown
objecttest_summaries – (optional)
testresults.TestResult
list
PackageCount
- class cdrouter.results.PackageCount(**kwargs)
Model for CDRouter Package Counts.
- Parameters
package_name – (optional) Package name as a string.
count – (optional) Count as an int.
DeviceCount
- class cdrouter.results.DeviceCount(**kwargs)
Model for CDRouter Device Counts.
- Parameters
device_name – (optional) Device name as a string.
count – (optional) Count as an int.
AllStats
- class cdrouter.results.AllStats(**kwargs)
Model for CDRouter All Results Stats.
- Parameters
frequent_packages – (optional)
results.PackageCount
listpackage_names – (optional)
results.PackageCount
listfrequent_devices – (optional)
results.DeviceCount
listdevice_names – (optional)
results.DeviceCount
list
LogDirFile
- class cdrouter.results.LogDirFile(**kwargs)
Model for CDRouter Logdir Files.
- Parameters
name – (optional) Name as a string.
size – (optional) Filesize as an int.
modified – (optional) Last-updated time as a DateTime.
Options
- class cdrouter.results.Options(**kwargs)
Model for CDRouter Result Options.
- Parameters
tags – (optional) Tags as string list.
skip_tests – (optional) Tests to skip as string list.
begin_at – (optional) Test name to begin testing at as string.
end_at – (optional) Test name to end testing at as string.
testvars – (optional) Extra testvars to set as a
configs.Testvar
list.extra_cli_args – (optional) Extra cdrouter-cli arguments as string.
Feature
- class cdrouter.results.Feature(**kwargs)
Model for CDRouter Result Feature.
- Parameters
feature – (optional) Feature as a string.
enabled – (optional) True if feature is enabled.
reason – (optional) Reason as a string
Update
- class cdrouter.results.Update(**kwargs)
Model for CDRouter Result Update.
- Parameters
id – (optional) Update ID as an int.
timestamp – (optional) System time as DateTime.
progress – (optional)
results.Progress
objectrunning – (optional)
testresults.TestResult
objectupdates – (optional)
results.Result
,testresults.TestResult
andalerts.Alert
list
Alerts
AlertsService
- class cdrouter.alerts.AlertsService(service)
Service for accessing CDRouter Alerts.
- all_stats(id)
Compute alert stats for a single result.
- Parameters
id – Result ID as an int.
- Returns
alerts.AllStats
object- Return type
- get(id, idx)
Get an alert.
- Parameters
id – Result ID as an int.
idx – Alert index as an int.
- Returns
alerts.Alert
object- Return type
- iter_list(id, *args, **kwargs)
Get a list of alerts. Whereas
list
fetches a single page of alerts according to itslimit
andpage
arguments,iter_list
returns all alerts by internally making successive calls tolist
.- Parameters
id – Result ID as an int.
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
alerts.Alert
list
- list(id, filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of alerts, using summary representation by default (see
detailed
parameter).- Parameters
id – Result ID as an int.
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
alerts.Page
object
Alert
- class cdrouter.alerts.Alert(**kwargs)
Model for CDRouter Alerts.
- Parameters
id – (optional) Result ID as an int.
idx – (optional) Alert index as an int.
created – (optional) Creation time as DateTime.
updated – (optional) Last-updated time as DateTime.
seq – (optional) TestResult sequence ID as an int.
loop – (optional) Loop number as an int.
test_name – (optional) Test name as string.
test_description – (optional) Test description as string.
category – (optional) Alert category as a string.
description – (optional) Alert description as a string.
dest_ip – (optional) Alert destination IP as a string.
dest_port – (optional) Alert destination port as an int.
interface – (optional) Alert incoming interface as a string.
payload – (optional) Alert payload as a base64 string.
payload_ascii – (optional) Alert payload as an ASCII string.
payload_hex – (optional) Alert payload as a hex string.
proto – (optional) Alert protocol as a string.
references – (optional) Alert references as a string list.
rev – (optional) Alert rule revision as an int.
rule – (optional) Alert rule as a string.
rule_set – (optional) Alert rule set as a string.
severity – (optional) Alert severity as an int.
sid – (optional) Alert rule SID as an int.
signature – (optional) Alert signature as a string.
src_ip – (optional) Alert source IP as a string.
src_port – (optional) Alert source port as an int.
Page
- class cdrouter.alerts.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
alerts.Alert
listlinks –
cdrouter.Links
object
SeverityCount
- class cdrouter.alerts.SeverityCount(**kwargs)
Model for CDRouter Severity Counts.
- Parameters
name – (optional) Severity name as a string.
severity – (optional) Severity as an int.
count – (optional) Count as an int.
CategoryCount
- class cdrouter.alerts.CategoryCount(**kwargs)
Model for CDRouter Category Counts.
- Parameters
category – (optional) Category name as a string.
severity – (optional) Severity as an int.
count – (optional) Count as an int.
RuleSetCount
- class cdrouter.alerts.RuleSetCount(**kwargs)
Model for CDRouter RuleSet Counts.
- Parameters
name – (optional) RuleSet name as a string.
count – (optional) Count as an int.
SignatureCount
- class cdrouter.alerts.SignatureCount(**kwargs)
Model for CDRouter Signature Counts.
- Parameters
signature – (optional) Signature name as a string.
severity – (optional) Severity as an int.
count – (optional) Count as an int.
TestCount
- class cdrouter.alerts.TestCount(**kwargs)
Model for CDRouter Test Counts.
- Parameters
name – (optional) Test name as a string.
count – (optional) Count as an int.
AddrCount
- class cdrouter.alerts.AddrCount(**kwargs)
Model for CDRouter Addr Counts.
- Parameters
addr – (optional) Address as a string.
count – (optional) Count as an int.
AllStats
- class cdrouter.alerts.AllStats(**kwargs)
Model for CDRouter All Alerts Stats.
- Parameters
severities – (optional) Dict of ints to
alerts.SeverityCount
categories – (optional)
alerts.CategoryCount
listrule_sets – (optional)
alerts.RuleSetCount
listsignatures – (optional)
alerts.SignatureCount
listtests – (optional)
alerts.TestCount
listfrequent_sources – (optional)
alerts.AddrCount
listfrequent_destinations – (optional)
alerts.AddrCount
list
TestResults
TestResultsService
- class cdrouter.testresults.TestResultsService(service)
Service for accessing CDRouter TestResults.
- edit(resource)
Edit a test result.
- Parameters
resource –
testresults.TestResult
object- Returns
testresults.TestResult
object- Return type
- get(id, seq)
Get a test result.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
- Returns
testresults.TestResult
object- Return type
- get_log_plaintext(id, seq)
Get a test result’s log as plaintext.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
- Return type
string
- get_test_metric(id, seq, metric)
Get a bandwidth, latency, client_bandwidth or client_latency test metric. This method is only for getting “bandwidth”, “latency”, “client_bandwidth” or “client_lantecy” test metrics.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
metric – Metric name as string, must be “bandwidth”, “latency”, “client_bandwidth” or “client_latency”
- Returns
metrics.Bandwidth
list,metrics.Latency
list,metrics.ClientBandwidth
list ormetrics.ClientLatency
list- Return type
Union[metrics.Bandwidth, metrics.Latency, metrics.ClientBandwidth, metrics.ClientLatency]
- get_test_metric_csv(id, seq, metric)
Get a test metric as CSV. This methods support all test metrics.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
id – Metric name as string.
- Return type
string
- iter_list(id, *args, **kwargs)
Get a list of test results. Whereas
list
fetches a single page of test results according to itslimit
andpage
arguments,iter_list
returns all test results by internally making successive calls tolist
.- Parameters
id – Result ID as an int.
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
testresults.TestResult
list
- iter_list_log(id, seq, *args, **kwargs)
Get a test result’s log. Whereas
list_log
fetches a single range of log lines according to itslimit
andoffset
arguments,iter_list_log
returns all log lines by internally making successive calls tolist_log
.- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
args – Arguments that
list_log
takes.kwargs – Optional arguments that
list_log
takes.
- Returns
testresults.Line
list
- list(id, filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of test results, using summary representation by default (see
detailed
parameter).- Parameters
id – Result ID as an int.
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
testresults.Page
object
- list_csv(id, filter=None, type=None, sort=None, limit=None, page=None)
Get a list of test results as CSV.
- Parameters
id – Result ID as an int.
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
- Return type
string
- list_log(id, seq, offset=None, limit=None, filter=None, packets=None, warnings=None, timestamp_format=None)
Get a test result’s log.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
offset – (optional) Offset within logfile to get.
limit – (optional) Limit returned list length.
filter – (optional) Filters to apply as a string list.
packets – (optional) Set to bool False to omit packet logs.
warnings – (optional) Set to bool False to omit warning logs.
timestamp_format – (optional) Timestamp format to use, must be string long or short.
- Returns
testresults.Log
object- Return type
- list_metrics(id, seq, filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of metrics, using summary representation by default (see
detailed
parameter).- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
metrics.Page
object- Return type
TestResult
- class cdrouter.testresults.TestResult(**kwargs)
Model for CDRouter TestResults.
- Parameters
id – (optional) Result ID as an int.
seq – (optional) TestResult sequence ID as an int.
loop – (optional) Loop number as an int.
active – (optional) Bool True if result is ‘running’ or ‘waiting’.
result – (optional) Test result as string.
alerts – (optional) Alerts count as int.
retries – (optional) Retry count as int.
started – (optional) Test start time as DateTime.
duration – (optional) Test duration as int.
flagged – (optional) True if test is flagged.
name – (optional) Test name as string.
description – (optional) Test description as string.
skip_name – (optional) Skip name for TestResult as string.
skip_reason – (optional) Skip reason for TestResult as string.
log – (optional) Logfile path for TestResult as string.
keylog – (optional) Keylog path for TestResult as string.
note – (optional) Note for TestResult as string.
Page
- class cdrouter.testresults.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
testresults.TestResult
listlinks –
cdrouter.Links
object
Summary
- class cdrouter.testresults.Summary(**kwargs)
Model for CDRouter Log Section Summaries.
- Parameters
errors – (optional) Error log count as int.
fails – (optional) Fail log count as int.
passes – (optional) Pass log count as int.
warnings – (optional) Warning log count as int.
alerts – (optional) Alert log count as int.
Line
- class cdrouter.testresults.Line(**kwargs)
Model for CDRouter Log Lines.
- Parameters
raw – (optional) Raw log text as string.
line – (optional) Line number as int.
header – (optional) True if line is a header.
section – (optional) True if line is a section.
prefix – (optional) Log prefix as string.
name – (optional) Log stack name as string.
timestamp – (optional) Log timestamp as string.
timestamp_display – (optional) Log display timestamp as string.
message – (optional) Log message as string.
interface – (optional) Log interface as string (if packet log).
packet – (optional) Log frame number as an int (if packet log).
src – (optional) Log source address as string (if packet log).
dst – (optional) Log destination address as string (if packet log).
proto – (optional) Log protocol name as string (if packet log).
info – (optional) Log protocol summary as string (if packet log).
alert_interface – (optional) Log alert interface as string (if alert log).
alert_index – (optional) Log alert index as an int (if alert log).
alert_src – (optional) Log alert source address as string (if alert log).
alert_dst – (optional) Log alert destination address as string (if alert log).
alert_proto – (optional) Log alert protocol name as string (if alert log).
alert_src_port – (optional) Log alert source port as int (if alert log).
alert_dst_port – (optional) Log alert destination port as int (if alert log).
alert_signature – (optional) Log alert signature as string (if alert log).
alert_severity – (optional) Log alert severity as int (if alert log).
alert_severity_display – (optional) Log alert display severity as string (if alert log).
alert_sid – (optional) Log alert SID as int (if alert log).
alert_rev – (optional) Log alert revision as int (if alert log).
summary – (optional)
testresults.Summary
object (if section log)
Log
- class cdrouter.testresults.Log(**kwargs)
Model for CDRouter Log.
- Parameters
offset – (optional) Zero-based offset in logfile as int.
limit – (optional) Limit as int.
lines – (optional)
testresults.Line
listtotal – (optional) Total line count as int.
more – (optional) Bool True if more lines are available.
Annotations
AnnotationsService
- class cdrouter.annotations.AnnotationsService(service)
Service for accessing CDRouter Annotations.
- create(id, seq, resource)
Create an annotation.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
resource –
annotations.Annotation
object
- Returns
annotations.Annotation
object- Return type
- create_or_edit(id, seq, resource)
Create or edit an annotation.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
resource –
annotations.Annotation
object
- Returns
annotations.Annotation
object- Return type
- delete(id, seq, line)
Delete an annotation.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
line – Line number in TestResult’s logfile as an int.
- edit(id, seq, resource)
Edit an annotation.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
resource –
annotations.Annotation
object
- Returns
annotations.Annotation
object- Return type
- get(id, seq, line)
Get an annotation.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
line – Line number in TestResult’s logfile as an int.
- Returns
annotations.Annotation
object- Return type
- list(id, seq, detailed=None)
Get a list of annotations, using summary representation by default (see
detailed
parameter).- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
detailed – (optional) Return all fields if Bool True.
- Returns
annotations.Annotation
list
Annotation
- class cdrouter.annotations.Annotation(**kwargs)
Model for CDRouter Annotations.
- Parameters
id – (optional) Result ID as an int.
seq – (optional) TestResult sequence ID as an int.
line – (optional) Line number in TestResult’s logfile as an int.
comment – (optional) Comment text as string.
Metrics
Bandwidth
- class cdrouter.metrics.Bandwidth(**kwargs)
Model for CDRouter Bandwidth Metrics.
- Parameters
log_file – (optional) Filepath to logfile as a string.
timestamp – (optional) Timestamp for metric as a DateTime.
metric – (optional) Metric name as a string.
bandwidth – (optional) Bandwidth value as a float.
bandwidth_units – (optional) Bandwidth value units as a string.
result – (optional) Metric result as a string.
client_interface – (optional) Client interface as a string.
server_interface – (optional) Server interface as a string.
streams – (optional) Stream count as an int.
protocol – (optional) Protocol as a string.
direction – (optional) Direction as a string.
loss_percentage – (optional) Loss percentage value as a float.
loss_percentage_units – (optional) Loss percentage units as a string.
client_device – (optional) Client device as a string.
server_device – (optional) Server device as a string.
seq – (optional) TestResult sequence ID as an int.
ClientBandwidth
- class cdrouter.metrics.ClientBandwidth(**kwargs)
Model for CDRouter Client Bandwidth Metrics.
- Parameters
timestamp – (optional) Timestamp for metric as a DateTime.
num_rates – (optional) Size of metric bandwidth rates list as an int.
rate – (optional) Metric bandwidth rates as a float list.
ClientLatency
- class cdrouter.metrics.ClientLatency(**kwargs)
Model for CDRouter Client Latency Metrics.
- Parameters
timestamp – (optional) Timestamp for metric as a DateTime.
num_rates – (optional) Size of metric latency rates list as an int.
rate – (optional) Metric latency rates as an int list.
GraphMetric
- class cdrouter.metrics.GraphMetric(**kwargs)
Model for CDRouter Graph Metrics.
- Parameters
log_file – (optional) Filepath to logfile as a string.
timestamp – (optional) Timestamp for metric as a DateTime.
metric – (optional) Metric name as a string.
value – (optional) First metric value as a float.
units – (optional) First metric units as a string.
result – (optional) Metric result as a string.
interface_1 – (optional) First interface as a string.
interface_2 – (optional) Second interface as a string.
streams – (optional) Stream count as an int.
protocol – (optional) Protocol as a string.
direction – (optional) Direction as a string.
value_2 – (optional) Second metric value as a float.
units_2 – (optional) Second metric units as a string.
device_1 – (optional) First device as a string.
device_2 – (optional) Second device as a string.
seq – (optional) TestResult sequence ID as an int.
Latency
- class cdrouter.metrics.Latency(**kwargs)
Model for CDRouter Latency Metrics.
- Parameters
log_file – (optional) Filepath to logfile as a string.
timestamp – (optional) Timestamp for metric as a DateTime.
metric – (optional) Metric name as a string.
total_latency – (optional) Total latency value as an int.
total_latency_units – (optional) Total latency units as a string.
result – (optional) Metric result as a string.
interface – (optional) Interface as a string.
download_latency – (optional) Download latency as an int.
download_latency_units – (optional) Download latency units as a string.
upload_latency – (optional) Upload latency as an int.
upload_latency_units – (optional) Upload latency units as a string.
seq – (optional) TestResult sequence ID as an int.
Metric
- class cdrouter.metrics.Metric(**kwargs)
Model for CDRouter Metrics.
- Parameters
id – (optional) Result ID as an int.
seq – (optional) TestResult sequence ID as an int.
created – (optional) Creation time as DateTime.
updated – (optional) Last-updated time as DateTime.
test_name – (optional) Test name as a string.
metric – (optional) Metric name as a string.
filename – (optional) Filename as a string.
log_file – (optional) Log file as a string.
Page
- class cdrouter.metrics.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
metrics.Metric
listlinks –
cdrouter.Links
object
Captures
CapturesService
- class cdrouter.captures.CapturesService(service)
Service for accessing CDRouter Captures.
- download(id, seq, intf, inline=False)
Download a capture as a PCAP file.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
intf – Interface name as string.
inline – (optional) Use inline version of capture file.
- Return type
tuple (io.BytesIO, ‘filename’)
- get(id, seq, intf)
Get a capture.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
intf – Interface name as string.
- Returns
captures.Capture
object- Return type
- list(id, seq, detailed=None)
Get a list of captures, using summary representation by default (see
detailed
parameter).- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
detailed – (optional) Return all fields if Bool True.
- Returns
captures.Capture
list
- send_to_cloudshark(id, seq, intf, inline=False)
Send a capture to a CloudShark Appliance. Both cloudshark_appliance_url and cloudshark_appliance_token must be properly configured via system preferences.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
intf – Interface name as string.
inline – (optional) Use inline version of capture file.
- Returns
captures.CloudShark
object- Return type
Capture
- class cdrouter.captures.Capture(**kwargs)
Model for CDRouter Captures.
- Parameters
id – (optional) Result ID as an int.
seq – (optional) TestResult sequence ID as an int.
type – (optional) Capture type as string.
interface – (optional) Interface name as string.
filename – (optional) Path to capture file as string.
CloudShark
- class cdrouter.captures.CloudShark(**kwargs)
Model for CDRouter CloudShark uploads.
- Parameters
url – (optional) CloudShark URL as a string.
Highlights
HighlightsService
- class cdrouter.highlights.HighlightsService(service)
Service for accessing CDRouter Highlights.
- create(id, seq, resource)
Create a highlight.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
resource –
highlights.Highlight
object
- Returns
highlights.Highlight
object- Return type
- create_or_edit(id, seq, resource)
Create or edit a highlight.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
resource –
highlights.Highlight
object
- Returns
highlights.Highlight
object- Return type
- delete(id, seq, line)
Delete a highlight.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
line – Line number in TestResult’s logfile as an int.
- edit(id, seq, resource)
Edit a highlight.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
resource –
highlights.Highlight
object
- Returns
highlights.Highlight
object- Return type
- get(id, seq, line)
Get a highlight.
- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
line – Line number in TestResult’s logfile as an int.
- Returns
highlights.Highlight
object
- list(id, seq, detailed=None)
Get a list of highlights, using summary representation by default (see
detailed
parameter).- Parameters
id – Result ID as an int.
seq – TestResult sequence ID as an int.
detailed – (optional) Return all fields if Bool True.
- Returns
highlights.Highlight
list
Highlight
- class cdrouter.highlights.Highlight(**kwargs)
Model for CDRouter Highlights.
- Parameters
id – (optional) Result ID as an int.
seq – (optional) TestResult sequence ID as an int.
line – (optional) Line number in TestResult’s logfile as an int.
color – (optional) Highlight color as string.
Imports
ImportsService
- class cdrouter.imports.ImportsService(service)
Service for accessing CDRouter Imports.
- commit(id, impreq)
Commit a staged import.
- Parameters
id – Staged import ID as an int.
impreq –
imports.Request
object
- Returns
imports.Request
object- Return type
- delete(id)
Delete a staged import.
- Parameters
id – Staged import ID as an int.
- get(id)
Get a staged import.
- Parameters
id – Staged import ID as an int.
- Returns
imports.Import
object- Return type
- get_commit_request(id)
Get a commit request for a staged import.
- Parameters
id – Staged import ID as an int.
- Returns
imports.Request
object- Return type
- list()
Get a list of staged (in-progress) imports.
- Returns
imports.Import
list
- stage_import_from_file(fd, filename='upload.gz')
Stage an import from a file upload.
- Parameters
fd – File-like object to upload.
filename – (optional) Filename to use for import as string.
- Returns
imports.Import
object
- stage_import_from_filesystem(filepath)
Stage an import from a filesystem path.
- Parameters
filepath – Local filesystem path as string.
- Returns
imports.Import
object
- stage_import_from_url(url, token=None, username=None, password=None, insecure=False)
Stage an import from a URL to another CDRouter system.
- Parameters
url – URL to import as string.
token – (optional) API token to use as string (may be required if importing from a CDRouter 10+ system).
username – (optional) API username to use as string (may be required if importing from a CDRouter 10+ system).
password – (optional) API password to use as string (may be required if importing from a CDRouter 10+ system).
insecure – (optional) Allow insecure HTTPS connections if bool True.
- Returns
imports.Import
object
Import
- class cdrouter.imports.Import(**kwargs)
Model for CDRouter Staged Imports.
- Parameters
id – (optional) Staged import ID as an int.
user_id – (optional) User ID as an int.
created – (optional) Creation time as DateTime.
updated – (optional) Last-updated time as DateTime.
archive – (optional) Path to archive as string.
path – (optional) Local filepath as string.
url – (optional) URL to fetch as string.
insecure – (optional) Allow insecure HTTPS connections if bool True.
size – (optional) Size of import as int.
Response
- class cdrouter.imports.Response(**kwargs)
Model for CDRouter Import Responses.
- Parameters
imported – (optional) Bool True if resource imported successfully.
id – (optional) Resource ID as an int.
name – (optional) Resource name as string.
message – (optional) Response message as string.
Resource
- class cdrouter.imports.Resource(**kwargs)
Model for CDRouter Import Resources.
- Parameters
name – (optional) Set to string to rename resource, leave empty to keep original
should_import – (optional) Bool True if resource should be imported.
existing_id – (optional) Contains ID as an int of existing resource which will be overwritten if should_import is True.
response – (optional)
imports.Response
object
Request
- class cdrouter.imports.Request(**kwargs)
Model for CDRouter Import Requests.
- Parameters
replace_existing – (optional) Bool True if existing resources should be overwritten.
configs – (optional) Dict of strings to
imports.Resource
objects.devices – (optional) Dict of strings to
imports.Resource
objects.packages – (optional) Dict of strings to
imports.Resource
objects.results – (optional) Dict of strings to
imports.Resource
objects.tags – (optional) Tags to add to imported resources as string list.
Exports
ExportsService
- class cdrouter.exports.ExportsService(service)
Service for accessing CDRouter Exports.
- bulk_export(config_ids=None, device_ids=None, package_ids=None, result_ids=None, exclude_captures=False)
Bulk export a set of configs, devices, packages and results.
- Parameters
config_ids – (optional) Int list of config IDs.
device_ids – (optional) Int list of device IDs.
package_ids – (optional) Int list of package IDs.
result_ids – (optional) Int list of result IDs.
exclude_captures – (optional) Exclude capture files if bool True.
- Return type
tuple (io.BytesIO, ‘filename’)
History
HistoryService
- class cdrouter.history.HistoryService(service)
Service for accessing CDRouter History.
- iter_list(*args, **kwargs)
Get a list of history entries. Whereas
list
fetches a single page of history entries according to itslimit
andpage
arguments,iter_list
returns all history entries by internally making successive calls tolist
.- Parameters
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
historys.History
list
- list(filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of history entries, using summary representation by default (see
detailed
parameter).- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
history.Page
object
History
- class cdrouter.history.History(**kwargs)
Model for CDRouter History entries.
- Parameters
user_id – (optional) User ID as an int.
created – (optional) Entry creation time as DateTime.
resource – (optional) Resource type as string.
id – (optional) Resource ID as an int.
name – (optional) Resource name as string.
action – (optional) Action name as string.
description – (optional) Resource description as string.
Page
- class cdrouter.history.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
history.History
listlinks –
cdrouter.Links
object
System
SystemService
- class cdrouter.system.SystemService(service)
Service for accessing CDRouter System.
- check_for_lounge_upgrade(email)
Check the CDRouter Support Lounge for eligible upgrades using your Support Lounge email.
- Parameters
email – CDRouter Support Lounge email as a string.
- Returns
system.Release
object- Return type
- diagnostics()
Get system diagnostics from cdrouter-diag output.
- Return type
tuple (io.BytesIO, ‘filename’)
- edit_preferences(resource)
Edit preferences in /usr/cdrouter-data/etc/config.yml.
- Parameters
resource –
system.Preferences
object- Returns
system.Preferences
object- Return type
- get_preferences()
Get preferences from /usr/cdrouter-data/etc/config.yml.
- Returns
system.Preferences
object- Return type
- hostname()
Get system hostname.
- Return type
string
- in_use_interfaces()
Get system interfaces, with flags to determine which are in use.
- Returns
system.InUseInterface
list
- info()
Get system info from cdrouter-cli -info output.
- Return type
string
- interfaces(addresses=False)
Get system interfaces.
- Parameters
addresses – (optional) If bool True, include interface addresses.
- Returns
system.Interface
list
- latest_lounge_release()
Get the latest release of CDRouter from the CDRouter Support Lounge.
- Returns
system.ReleaseLatest
object- Return type
- lounge_update_license()
Download & install a license for your CDRouter system from the CDRouter Support Lounge.
- Returns
system.Upgrade
object- Return type
- lounge_upgrade(email, nonce, filename='cdrouter.rpm')
Download & install an upgrade from the CDRouter Support Lounge using your Support Lounge email and upgrade nonce. Please note that any running tests will be stopped.
- Parameters
email – CDRouter Support Lounge email as a string.
nonce – Upgrade nonce from
system.Release
.filename – Upgrade filename from
system.Release
.
- Returns
system.Upgrade
object- Return type
- manual_update_license(fd, filename='cdrouter.lic')
Update the license on your CDRouter system manually by uploading a .lic license from the CDRouter Support Lounge.
- Parameters
fd – File-like object to upload.
filename – (optional) Filename to use for license as string.
- manual_upgrade(fd, filename='cdrouter.rpm')
Upgrade CDRouter manually by uploading an .rpm installer from the CDRouter Support Lounge. Please note that any running tests will be stopped.
- Parameters
fd – File-like object to upload.
filename – (optional) Filename to use for installer as string.
- Returns
system.Upgrade
object- Return type
- poweroff()
Poweroff the NTA1000. Please note that any running tests will be stopped.
- reboot()
Reboot the NTA1000. Please note that any running tests will be stopped.
- restart()
Restart the CDRouter Web UI. Please note that any running tests will be stopped.
- shutdown()
Shutdown the CDRouter Web UI. Please note that any running tests will be stopped.
- space()
Get system disk space usage.
- Returns
system.Space
object- Return type
- time()
Get system time.
- Return type
string
Version
- class cdrouter.system.Version(**kwargs)
Model for CDRouter Release Versions.
- Parameters
raw – (optional) Raw version as string.
major – (optional) Major version as int.
minor – (optional) Minor version as int.
build – (optional) Build version as int.
ReleaseLatest
- class cdrouter.system.ReleaseLatest(**kwargs)
Model for CDRouter Latest Releases.
- Parameters
latest – (optional)
system.Version
object.current – (optional)
system.Version
object.newer – (optional) Bool True if newer release available.
Testsuite
- class cdrouter.system.Testsuite(**kwargs)
Model for CDRouter Testsuite names.
- Parameters
shortname – (optional) Brief testsuite name as string.
name – (optional) Full testsuite name as string.
Release
- class cdrouter.system.Release(**kwargs)
Model for CDRouter Releases.
- Parameters
build_date – (optional) Build date as string.
filename – (optional) Installer filename as string.
version – (optional)
system.Version
objecttestsuite – (optional)
system.Testsuite
objectnonce – (optional) Upgrade nonce as string.
Upgrade
- class cdrouter.system.Upgrade(**kwargs)
Model for CDRouter Upgrades.
- Parameters
success – (optional) Bool True if successful.
installer_path – (optional) Installer filename as string.
output – (optional) Output as string.
error – (optional) Error output as string.
InterfaceFlags
- class cdrouter.system.InterfaceFlags(**kwargs)
Model for CDRouter Interface Flags.
- Parameters
up – (optional) Bool True if interface is up.
broadcast – (optional) Bool True if interface is broadcasting.
loopback – (optional) Bool True if interface is a loopback interface.
point_to_point – (optional) Bool True if interface is a point-to-point interface.
multicast – (optional) Bool True if interface is multicast.
InterfaceAddr
- class cdrouter.system.InterfaceAddr(**kwargs)
Model for CDRouter Interface Addresses.
- Parameters
network – (optional) Interface network as a string.
address – (optional) Interface address as a string.
Interface
- class cdrouter.system.Interface(**kwargs)
Model for CDRouter Interfaces.
- Parameters
index – (optional) Interface index as an int.
mtu – (optional) Interface MTU as an int.
name – (optional) Interface name as a string.
hardware_addr – (optional) Interface hardware address as a string.
flags – (optional)
system.InterfaceFlags
objectaddresses – (optional)
system.InterfaceAddr
listmulticast_addresses – (optional)
system.InterfaceAddr
list
InUseInterfaceFlags
- class cdrouter.system.InUseInterfaceFlags(**kwargs)
Model for CDRouter In Use Interface Flags.
- Parameters
in_use – (optional) Bool True if interface is in use by a running job.
is_wireless – (optional) Bool True if interface is a wireless interface.
is_ics – (optional) Bool True if interface is in use as the ICS interface of a running job.
InUseInterface
- class cdrouter.system.InUseInterface(**kwargs)
Model for CDRouter In Use Interfaces.
- Parameters
name – (optional) Interface name as a string.
flags – (optional)
system.InUseInterfaceFlags
object
Preferences
- class cdrouter.system.Preferences(**kwargs)
Model for CDRouter Preferences.
- Parameters
automatic_login – (optional) Bool True if Automatic Login is enabled.
cloudshark_appliance_autotags – (optional) CloudShark Appliance autotags as a string.
cloudshark_appliance_insecure – (optional) String yes if insecure CloudShark Appliance URLs are allowed.
cloudshark_appliance_password – (optional) CloudShark Appliance password as a string.
cloudshark_appliance_tags – (optional) CloudShark Appliance tags as a string.
cloudshark_appliance_token – (optional) CloudShark Appliance API token as a string.
cloudshark_appliance_url – (optional) CloudShark Appliance URL as a string.
cloudshark_appliance_username – (optional) CloudShark Appliance username as a string.
hostname – (optional) CDRouter system’s hostname as a string.
migrated – (optional) Migrated resources as a string list.
port – (optional) CDRouter’s HTTP port as an int.
https – (optional) CDRouter’s HTTPS port as an int.
force_https – (optional) If string yes, redirect HTTP connections to CDRouter to HTTPS.
use_cloudshark – (optional) If string yes, use CloudShark Appliance for capture viewing.
log_timestamp_format – (optional) Log timestamp format, must be string short or long.
editor_keymap – (optional) Config editor keymap, must be string default, emacs or vim.
lounge_url – (optional) CDRouter Support Lounge URL as a string.
lounge_insecure – (optional) If bool True, allow insecure HTTPS connections to the CDRouter Support Lounge.
Space
- class cdrouter.system.Space(**kwargs)
Model for CDRouter Disk Space Usage.
- Parameters
avail – (optional) Available disk space as an int.
path – (optional) Path to CDRouter’s data directory as a string.
pcent – (optional) Percentage of disk space used as an int.
size – (optional) Total disk space as an int.
unit – (optional) Disk space units as a string, default is ‘bytes’.
used – (optional) Used disk space as an int.
Testsuites
TestsuitesService
- class cdrouter.testsuites.TestsuitesService(service)
Service for accessing CDRouter Testsuites.
- get_error(name)
Get an error.
- Parameters
name – Error name as string.
- Returns
testsuites.Error
object- Return type
- get_group(name)
Get a group.
- Parameters
name – Group name as string.
- Returns
testsuites.Group
object- Return type
- get_label(name)
Get a label.
- Parameters
name – Label name as string.
- Returns
testsuites.Label
object- Return type
- get_module(name)
Get a module.
- Parameters
name – Module name as string.
- Returns
testsuites.Module
object- Return type
- get_test(name)
Get a test.
- Parameters
name – Test name as string.
- Returns
testsuites.Test
object- Return type
- get_testvar(name)
Get a testvar.
- Parameters
name – Testvar name as string.
- Returns
testsuites.Testvar
object- Return type
- info()
Get testsuite info.
- Returns
testsuites.Info
object- Return type
- list_errors(filter=None, type=None, sort=None, detailed=None)
Get a list of errors.
- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
detailed – (optional) Return all fields if Bool True.
- Returns
testsuites.Error
list
- list_groups(filter=None, type=None, sort=None, detailed=None)
Get a list of groups.
- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
detailed – (optional) Return all fields if Bool True.
- Returns
testsuites.Group
list
- list_labels(filter=None, type=None, sort=None, detailed=None)
Get a list of labels.
- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
detailed – (optional) Return all fields if Bool True.
- Returns
testsuites.Label
list
- list_modules(filter=None, type=None, sort=None, detailed=None)
Get a list of modules.
- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
detailed – (optional) Return all fields if Bool True.
- Returns
testsuites.Module
list
- list_tests(filter=None, type=None, sort=None, detailed=None)
Get a list of tests.
- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
detailed – (optional) Return all fields if Bool True.
- Returns
testsuites.Test
list
- list_testvars(filter=None, type=None, sort=None, detailed=None)
Get a list of testvars.
- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
detailed – (optional) Return all fields if Bool True.
- Returns
testsuites.Testvar
list
- search(query)
Perform full text search of testsuite.
- Parameters
query – Search query as a string.
- Returns
testsuites.Search
object- Return type
- update()
Update testsuite info.
Info
- class cdrouter.testsuites.Info(**kwargs)
Model for CDRouter Testsuite Info.
- Parameters
id – (optional) Testsuite ID as an int.
build_info – (optional) CDRouter build info as string.
copyright – (optional) CDRouter copyright info as string.
license_type – (optional) License type as string.
customer – (optional) Customer name from license as string.
lifetime – (optional) License lifetime as string.
killtime – (optional) License killtime as string.
nag – (optional) Bool True if should nag leading up to license expiration.
os – (optional) OS name as string.
os_type – (optional) OS type as string.
serial_number – (optional) NTA serial number as string.
system_id – (optional) CDRouter system ID as string.
testsuite – (optional) CDRouter testsuite name as string.
release – (optional) CDRouter release as string.
addons – (optional) Enabled CDRouter addons as string list.
all_addons – (optional) All CDRouter addons as string list.
interfaces – (optional)
configs.Interfaces
listexecute_instances – (optional) Execute instances as an int.
license_info – (optional)
testsuites.LicenseInfo
object
Group
- class cdrouter.testsuites.Group(**kwargs)
Model for CDRouter Groups.
- Parameters
id – (optional) Testsuite ID as an int.
name – (optional) Name as string.
index – (optional) Index as int.
test_count – (optional) Test count as int.
modules – (optional) Modules as string list.
Module
- class cdrouter.testsuites.Module(**kwargs)
Model for CDRouter Modules.
- Parameters
id – (optional) Testsuite ID as an int.
name – (optional) Name as string.
index – (optional) Index as int.
group – (optional) Group name as string.
description – (optional) Module description as string.
test_count – (optional) Test count as int.
tests – (optional) Tests as string list.
labels – (optional) Labels as string list.
aliases – (optional) Aliases as string list.
Test
- class cdrouter.testsuites.Test(**kwargs)
Model for CDRouter Tests.
- Parameters
id – (optional) Testsuite ID as an int.
name – (optional) Name as string.
index – (optional) Index as int.
group – (optional) Group name as string.
module – (optional) Module name as string.
synopsis – (optional) Test synopsis as string.
description – (optional) Test description as string.
labels – (optional) Labels as string list.
aliases – (optional) Aliases as string list.
testvars – (optional) Testvars as string list.
skip_name – (optional) Skip name as string.
skip_reason – (optional) Skip reason as string.
Label
- class cdrouter.testsuites.Label(**kwargs)
Model for CDRouter Skip Labels.
- Parameters
id – (optional) Testsuite ID as an int.
name – (optional) Name as string.
index – (optional) Index as int.
reason – (optional) Skip reason as string.
description – (optional) Description as string.
modules – (optional) Modules as string list.
tests – (optional) Tests as string list.
Error
- class cdrouter.testsuites.Error(**kwargs)
Model for CDRouter Start Errors.
- Parameters
id – (optional) Testsuite ID as an int.
name – (optional) Name as string.
index – (optional) Index as int.
description – (optional) Description as string.
Testvar
- class cdrouter.testsuites.Testvar(**kwargs)
Model for CDRouter Start Errors.
- Parameters
id – (optional) Testsuite ID as an int.
name – (optional) Name as a string.
index – (optional) Index as an int.
humanname – (optional) Human-readable name as a string.
display – (optional) Display name as a string.
dataclass – (optional) Data-type as a string.
addedin – (optional) Added-in info as a string.
deprecatedin – (optional) Deprecated-in info as a string.
obsoletedin – (optional) Obsoleted-in info as a string.
min – (optional) Minimum value as a string.
max – (optional) Maximum value as a string.
length – (optional) Required length as a string.
description – (optional) Description as a string.
default – (optional) Default value as a string.
defaultdisabled – (optional) Bool True if testvar has no default value.
dyndefault – (optional) Bool True if testvar’s default value is dynamically calculated.
keywords – (optional) Accepted values as a string list.
alsoaccept – (optional) Also-accepted values as a string list.
wildcard – (optional) Bool True if testvar is a wildcard testvar.
instances – (optional) Number of allowed wildcard instances as an int.
parent – (optional) Parent wildcard testvar name as a string.
children – (optional) Child testvars as a string list.
tests – (optional) Test names as a string list.
Search
- class cdrouter.testsuites.Search(**kwargs)
Model for CDRouter Testsuite Searches.
- Parameters
addons – (optional)
testsuites.Group
listmodules – (optional)
testsuites.Module
listtests – (optional)
testsuites.Test
listreasons – (optional)
testsuites.Label
listerrors – (optional)
testsuites.Error
listtestvars – (optional)
testsuites.Testvar
list
Users
UsersService
- class cdrouter.users.UsersService(service)
Service for accessing CDRouter Users.
- bulk_copy(ids)
Bulk copy a set of users.
- Parameters
ids – Int list of user IDs.
- Returns
users.User
list
- bulk_delete(ids=None, filter=None, type=None, all=False)
Bulk delete a set of users.
- Parameters
ids – (optional) Int list of user IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- bulk_edit(_fields, ids=None, filter=None, type=None, all=False)
Bulk edit a set of users.
- Parameters
_fields –
users.User
objectids – (optional) Int list of user IDs.
filter – (optional) String list of filters.
type – (optional) union or inter as string.
all – (optional) Apply to all if bool True.
- change_password(id, new, old=None, change_token=True)
Change a user’s password.
- Parameters
id – User ID as an int.
new – New password as string.
old – (optional) Old password as string (required if performing action as non-admin).
change_token – (optional) If bool True, also generate a new API token for user.
- Returns
users.User
object- Return type
- change_token(id)
Change a user’s token.
- Parameters
id – User ID as an int.
- Returns
users.User
object- Return type
- create(resource)
Create a new user.
- Parameters
resource –
users.User
object- Returns
users.User
object- Return type
- delete(id)
Delete a user.
- Parameters
id – User ID as an int.
- edit(resource)
Edit a user.
- Parameters
resource –
users.User
object- Returns
users.User
object- Return type
- get(id)
Get a user.
- Parameters
id – User ID as an int.
- Returns
users.User
object- Return type
- get_by_name(name)
Get a user by name.
- Parameters
name – User name as string.
- Returns
users.User
object- Return type
- iter_list(*args, **kwargs)
Get a list of users. Whereas
list
fetches a single page of users according to itslimit
andpage
arguments,iter_list
returns all users by internally making successive calls tolist
.- Parameters
args – Arguments that
list
takes.kwargs – Optional arguments that
list
takes.
- Returns
users.User
list
- list(filter=None, type=None, sort=None, limit=None, page=None, detailed=None)
Get a list of users, using summary representation by default (see
detailed
parameter).- Parameters
filter – (optional) Filters to apply as a string list.
type – (optional) union or inter as string.
sort – (optional) Sort fields to apply as string list.
limit – (optional) Limit returned list length.
page – (optional) Page to return.
detailed – (optional) Return all fields if Bool True.
- Returns
users.Page
object
- lock(id)
Lock a user. Locking prevents the user from being modified or deleted until it is unlocked.
- Parameters
id – User ID as an int.
- Returns
users.User
object- Return type
- unlock(id)
Unlock a user. Unlocking a locked user allows it to be modified or deleted once again.
- Parameters
id – User ID as an int.
- Returns
users.User
object- Return type
User
- class cdrouter.users.User(**kwargs)
Model for CDRouter Users.
- Parameters
id – (optional) User ID as an int.
admin – (optional) Bool True if user is an administrator.
disabled – (optional) Bool True if user is disabled.
name – (optional) User name as string.
description – (optional) User description as string.
created – (optional) User creation time as DateTime.
updated – (optional) User last-updated time as DateTime.
locked – (optional) Bool True if user is locked.
token – (optional) User’s API token as string.
Page
- class cdrouter.users.Page(data, links)
Named tuple for a page of list response data.
- Parameters
data –
users.User
listlinks –
cdrouter.Links
object