.. _reference:

Reference
=========

.. automodule:: cdrouter
   :members:

CDRouter
--------

CDRouter
~~~~~~~~

.. autoclass:: cdrouter.CDRouter
   :members:

CDRouterError
~~~~~~~~~~~~~

.. autoclass:: cdrouter.cdrouter.CDRouterError
   :members:

Links
~~~~~

.. autoclass:: cdrouter.cdrouter.Links
   :members:

Share
~~~~~

.. autoclass:: cdrouter.cdrouter.Share
   :members:

Filters
-------

Field
~~~~~

.. autoclass:: cdrouter.filters.Field
   :members:

Configs
-------

ConfigsService
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.configs.ConfigsService
   :members:

Config
~~~~~~

.. autoclass:: cdrouter.configs.Config
   :members:

Page
~~~~

.. autoclass:: cdrouter.configs.Page
   :members:

ConfigError
~~~~~~~~~~~
.. autoclass:: cdrouter.configs.ConfigError
   :members:

CheckConfig
~~~~~~~~~~~

.. autoclass:: cdrouter.configs.CheckConfig
   :members:

UpgradeConfig
~~~~~~~~~~~~~

.. autoclass:: cdrouter.configs.UpgradeConfig
   :members:

Networks
~~~~~~~~

.. autoclass:: cdrouter.configs.Networks
   :members:

Interfaces
~~~~~~~~~~

.. autoclass:: cdrouter.configs.Interfaces
   :members:

Testvar
~~~~~~~

.. autoclass:: cdrouter.configs.Testvar
   :members:

Devices
-------

DevicesService
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.devices.DevicesService
   :members:

Device
~~~~~~

.. autoclass:: cdrouter.devices.Device
   :members:

Page
~~~~

.. autoclass:: cdrouter.devices.Page
   :members:

PowerCmd
~~~~~~~~

.. autoclass:: cdrouter.devices.PowerCmd
   :members:

Connection
~~~~~~~~~~

.. autoclass:: cdrouter.devices.Connection
   :members:

Attachments
-----------

AttachmentsService
~~~~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.attachments.AttachmentsService
   :members:

Attachment
~~~~~~~~~~

.. autoclass:: cdrouter.attachments.Attachment
   :members:

Page
~~~~

.. autoclass:: cdrouter.attachments.Page
   :members:

Jobs
----

JobsService
~~~~~~~~~~~

.. autoclass:: cdrouter.jobs.JobsService
   :members:

Job
~~~

.. autoclass:: cdrouter.jobs.Job
   :members:

Options
~~~~~~~

.. autoclass:: cdrouter.jobs.Options
   :members:

Page
~~~~

.. autoclass:: cdrouter.jobs.Page
   :members:

Packages
--------

PackagesService
~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.packages.PackagesService
   :members:

Package
~~~~~~~

.. autoclass:: cdrouter.packages.Package
   :members:

Options
~~~~~~~

.. autoclass:: cdrouter.packages.Options
   :members:

Schedule
~~~~~~~~

.. autoclass:: cdrouter.packages.Schedule
   :members:

Page
~~~~

.. autoclass:: cdrouter.packages.Page
   :members:

Analysis
~~~~~~~~

.. autoclass:: cdrouter.packages.Analysis
   :members:

Results
-------

ResultsService
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.results.ResultsService
   :members:

Result
~~~~~~

.. autoclass:: cdrouter.results.Result
   :members:

Page
~~~~

.. autoclass:: cdrouter.results.Page
   :members:

TestCount
~~~~~~~~~

.. autoclass:: cdrouter.results.TestCount
   :members:

TestDuration
~~~~~~~~~~~~

.. autoclass:: cdrouter.results.TestDuration
   :members:

ResultBreakdown
~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.results.ResultBreakdown
   :members:

TimeBreakdown
~~~~~~~~~~~~~

.. autoclass:: cdrouter.results.TimeBreakdown
   :members:

SetStats
~~~~~~~~

.. autoclass:: cdrouter.results.SetStats
   :members:

TestResultSummary
~~~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.results.TestResultSummary
   :members:

TestResultDiff
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.results.TestResultDiff
   :members:

DiffStats
~~~~~~~~~

.. autoclass:: cdrouter.results.DiffStats
   :members:

TestResultBreakdown
~~~~~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.results.TestResultBreakdown
   :members:

Progress
~~~~~~~~

.. autoclass:: cdrouter.results.Progress
   :members:

SingleStats
~~~~~~~~~~~

.. autoclass:: cdrouter.results.SingleStats
   :members:

SummaryStats
~~~~~~~~~~~~

.. autoclass:: cdrouter.results.SummaryStats
   :members:

PackageCount
~~~~~~~~~~~~

.. autoclass:: cdrouter.results.PackageCount
   :members:

DeviceCount
~~~~~~~~~~~

.. autoclass:: cdrouter.results.DeviceCount
   :members:

AllStats
~~~~~~~~

.. autoclass:: cdrouter.results.AllStats
   :members:

LogDirFile
~~~~~~~~~~

.. autoclass:: cdrouter.results.LogDirFile
   :members:

Options
~~~~~~~

.. autoclass:: cdrouter.results.Options
   :members:

Feature
~~~~~~~

.. autoclass:: cdrouter.results.Feature
   :members:

Update
~~~~~~

.. autoclass:: cdrouter.results.Update
   :members:

Alerts
------

AlertsService
~~~~~~~~~~~~~

.. autoclass:: cdrouter.alerts.AlertsService
   :members:

Alert
~~~~~

.. autoclass:: cdrouter.alerts.Alert
   :members:

Page
~~~~

.. autoclass:: cdrouter.alerts.Page
   :members:

SeverityCount
~~~~~~~~~~~~~

.. autoclass:: cdrouter.alerts.SeverityCount
   :members:

CategoryCount
~~~~~~~~~~~~~

.. autoclass:: cdrouter.alerts.CategoryCount
   :members:

RuleSetCount
~~~~~~~~~~~~

.. autoclass:: cdrouter.alerts.RuleSetCount
   :members:

SignatureCount
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.alerts.SignatureCount
   :members:

TestCount
~~~~~~~~~

.. autoclass:: cdrouter.alerts.TestCount
   :members:

AddrCount
~~~~~~~~~

.. autoclass:: cdrouter.alerts.AddrCount
   :members:

AllStats
~~~~~~~~

.. autoclass:: cdrouter.alerts.AllStats
   :members:

TestResults
-----------

TestResultsService
~~~~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.testresults.TestResultsService
   :members:

TestResult
~~~~~~~~~~

.. autoclass:: cdrouter.testresults.TestResult
   :members:

Page
~~~~

.. autoclass:: cdrouter.testresults.Page
   :members:

Summary
~~~~~~~

.. autoclass:: cdrouter.testresults.Summary
   :members:

Line
~~~~

.. autoclass:: cdrouter.testresults.Line
   :members:

Log
~~~

.. autoclass:: cdrouter.testresults.Log
   :members:

Annotations
-----------

AnnotationsService
~~~~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.annotations.AnnotationsService
   :members:

Annotation
~~~~~~~~~~

.. autoclass:: cdrouter.annotations.Annotation
   :members:

Metrics
-------

Bandwidth
~~~~~~~~~

.. autoclass:: cdrouter.metrics.Bandwidth
   :members:

ClientBandwidth
~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.metrics.ClientBandwidth
   :members:

ClientLatency
~~~~~~~~~~~~~

.. autoclass:: cdrouter.metrics.ClientLatency
   :members:

GraphMetric
~~~~~~~~~~~

.. autoclass:: cdrouter.metrics.GraphMetric
   :members:

Latency
~~~~~~~

.. autoclass:: cdrouter.metrics.Latency
   :members:

Metric
~~~~~~

.. autoclass:: cdrouter.metrics.Metric
   :members:

Page
~~~~

.. autoclass:: cdrouter.metrics.Page
   :members:

Captures
--------

CapturesService
~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.captures.CapturesService
   :members:

Capture
~~~~~~~

.. autoclass:: cdrouter.captures.Capture
   :members:

CloudShark
~~~~~~~~~~

.. autoclass:: cdrouter.captures.CloudShark
   :members:

Highlights
----------

HighlightsService
~~~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.highlights.HighlightsService
   :members:

Highlight
~~~~~~~~~

.. autoclass:: cdrouter.highlights.Highlight
   :members:

Imports
-------

ImportsService
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.imports.ImportsService
   :members:

Import
~~~~~~

.. autoclass:: cdrouter.imports.Import
   :members:

Response
~~~~~~~~

.. autoclass:: cdrouter.imports.Response
   :members:

Resource
~~~~~~~~

.. autoclass:: cdrouter.imports.Resource
   :members:

Request
~~~~~~~

.. autoclass:: cdrouter.imports.Request
   :members:

Exports
-------

ExportsService
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.exports.ExportsService
   :members:

History
-------

HistoryService
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.history.HistoryService
   :members:

History
~~~~~~~

.. autoclass:: cdrouter.history.History
   :members:

Page
~~~~

.. autoclass:: cdrouter.history.Page
   :members:

System
------

SystemService
~~~~~~~~~~~~~

.. autoclass:: cdrouter.system.SystemService
   :members:

Version
~~~~~~~

.. autoclass:: cdrouter.system.Version
   :members:

ReleaseLatest
~~~~~~~~~~~~~

.. autoclass:: cdrouter.system.ReleaseLatest
   :members:

Testsuite
~~~~~~~~~

.. autoclass:: cdrouter.system.Testsuite
   :members:

Release
~~~~~~~

.. autoclass:: cdrouter.system.Release
   :members:

Upgrade
~~~~~~~

.. autoclass:: cdrouter.system.Upgrade
   :members:

InterfaceFlags
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.system.InterfaceFlags
   :members:

InterfaceAddr
~~~~~~~~~~~~~

.. autoclass:: cdrouter.system.InterfaceAddr
   :members:

Interface
~~~~~~~~~

.. autoclass:: cdrouter.system.Interface
   :members:

InUseInterfaceFlags
~~~~~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.system.InUseInterfaceFlags
   :members:

InUseInterface
~~~~~~~~~~~~~~

.. autoclass:: cdrouter.system.InUseInterface
   :members:

Preferences
~~~~~~~~~~~

.. autoclass:: cdrouter.system.Preferences
   :members:

Space
~~~~~~~~~~~

.. autoclass:: cdrouter.system.Space
   :members:

Tags
----

TagsService
~~~~~~~~~~~

.. autoclass:: cdrouter.tags.TagsService
   :members:

Tag
~~~

.. autoclass:: cdrouter.tags.Tag
   :members:

ResourceTags
~~~~~~~~~~~~

.. autoclass:: cdrouter.tags.ResourceTags
   :members:

Testsuites
----------

TestsuitesService
~~~~~~~~~~~~~~~~~

.. autoclass:: cdrouter.testsuites.TestsuitesService
   :members:

Info
~~~~

.. autoclass:: cdrouter.testsuites.Info
   :members:

Group
~~~~~

.. autoclass:: cdrouter.testsuites.Group
   :members:

Module
~~~~~~

.. autoclass:: cdrouter.testsuites.Module
   :members:

Test
~~~~

.. autoclass:: cdrouter.testsuites.Test
   :members:

Label
~~~~~

.. autoclass:: cdrouter.testsuites.Label
   :members:

Error
~~~~~

.. autoclass:: cdrouter.testsuites.Error
   :members:

Testvar
~~~~~~~

.. autoclass:: cdrouter.testsuites.Testvar
   :members:

Search
~~~~~~

.. autoclass:: cdrouter.testsuites.Search
   :members:

Users
-----

UsersService
~~~~~~~~~~~~

.. autoclass:: cdrouter.users.UsersService
   :members:

User
~~~~

.. autoclass:: cdrouter.users.User
   :members:

Page
~~~~

.. autoclass:: cdrouter.users.Page
   :members: