| | |
- yangbase.YangBase(__builtin__.object)
-
- Openhltest
- Sessions
- SessionsConfig
- SessionsConfigPorts
- SessionsConfigProtocolGroups
- SessionsConfigTrafficGroups
- SessionsStatisticEventsPorts
- SessionsStatistics
- SessionsStatisticsPorts
class Openhltest(yangbase.YangBase) |
| |
This module is the top level of the test hierarchy.
|
| |
- Method resolution order:
- Openhltest
- yangbase.YangBase
- __builtin__.object
Methods defined here:
- __init__(self, ip_address, rest_port)
- create_sessions(self, name)
- Create a sessions instance on the server.
A list of test tool sessions.
Args:
name (str): A unique key value that does not exist in the list on the server.
Returns:
:obj:`Sessions`: An object encapsulating an instance of the sessions model.
Raises:
AlreadyExistsError: An instance of sessions with the supplied key value already exists on the server.
ServerError: An abnormal server error has occurred.
- sessions(self, name=None)
- Get the sessions object(s) from the server.
A list of test tool sessions.
Args:
name (:obj:`str`, optional, default=None): A key value in the sessions list.
Returns:
:obj:`list` of :obj:`Sessions` | :obj:`Sessions`: If arg name is None a list of Sessions objects otherwise a single Sessions object.
Raises:
NotFoundError: name is not in the list of sessions objects.
ServerError: An abnormal server error has occurred.
Methods inherited from yangbase.YangBase:
- create_sibling(self, yang_key_value)
- dump(self)
- refresh(self)
Data descriptors inherited from yangbase.YangBase:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- url
|
class Sessions(yangbase.YangBase) |
| |
A list of test tool sessions.
|
| |
- Method resolution order:
- Sessions
- yangbase.YangBase
- __builtin__.object
Methods defined here:
- __init__(self, parent, yang_key_value=None)
- config(self)
- Get the config object from the server
This container aggregates all other top level configuration submodules.
Returns:
:obj:`SessionsConfig`: An object encapsulating an instance of the config model.
Raises:
ServerError: An abnormal server error has occurred.
- statistics(self)
- Get the statistics object from the server
The statistics pull model
Returns:
:obj:`SessionsStatistics`: An object encapsulating an instance of the statistics model.
Raises:
ServerError: An abnormal server error has occurred.
Data descriptors defined here:
- name
- str: The unique name of the test tool session. Once the session has been created the name cannot be modified.
- session_type
- :str:`enum`: The type of test tool session. Once the session has been created the session-type cannot be modified.
Enums:
L2L3: A layer 23 test tool session
L4L7: A layer 47 test tool session. This is currently not supported and is a feature placeholder
Methods inherited from yangbase.YangBase:
- create_sibling(self, yang_key_value)
- dump(self)
- refresh(self)
Data descriptors inherited from yangbase.YangBase:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- url
|
class SessionsConfig(yangbase.YangBase) |
| |
This container aggregates all other top level configuration submodules.
|
| |
- Method resolution order:
- SessionsConfig
- yangbase.YangBase
- __builtin__.object
Methods defined here:
- __init__(self, parent)
- clear(self)
- Execute the clear action on the server
Clear the current configuration
:return: None.
:raises ServerException: An abnormal server error has occurred.
- connect_ports(self, connect_ports_input)
- Execute the connect-ports action on the server
Connect abstract test ports to physical hardware test ports and/or virtual machine test ports
:return: ConnectPortsOutput.
:raises ServerException: An abnormal server error has occurred.
- create_ports(self, name)
- Create a ports instance on the server.
A list of abstract test ports
Args:
name (str): A unique key value that does not exist in the list on the server.
Returns:
:obj:`SessionsConfigPorts`: An object encapsulating an instance of the ports model.
Raises:
AlreadyExistsError: An instance of ports with the supplied key value already exists on the server.
ServerError: An abnormal server error has occurred.
- create_protocol_groups(self, name)
- Create a protocol-groups instance on the server.
A list of emulated protocol groups
Args:
name (str): A unique key value that does not exist in the list on the server.
Returns:
:obj:`SessionsConfigProtocolGroups`: An object encapsulating an instance of the protocol-groups model.
Raises:
AlreadyExistsError: An instance of protocol-groups with the supplied key value already exists on the server.
ServerError: An abnormal server error has occurred.
- create_traffic_groups(self, name)
- Create a traffic-groups instance on the server.
A list of traffic groups
Args:
name (str): A unique key value that does not exist in the list on the server.
Returns:
:obj:`SessionsConfigTrafficGroups`: An object encapsulating an instance of the traffic-groups model.
Raises:
AlreadyExistsError: An instance of traffic-groups with the supplied key value already exists on the server.
ServerError: An abnormal server error has occurred.
- disconnect_ports(self, disconnect_ports_input)
- Execute the disconnect-ports action on the server
Disconnect abstract test ports from any connected physical hardware test ports and/or virtual machine test ports
:return: DisconnectPortsOutput.
:raises ServerException: An abnormal server error has occurred.
- load(self, load_input)
- Execute the load action on the server
Load a vendor specific configuration
:return: None.
:raises ServerException: An abnormal server error has occurred.
- ports(self, name=None)
- Get the ports object(s) from the server.
A list of abstract test ports
Args:
name (:obj:`str`, optional, default=None): A key value in the ports list.
Returns:
:obj:`list` of :obj:`SessionsConfigPorts` | :obj:`SessionsConfigPorts`: If arg name is None a list of SessionsConfigPorts objects otherwise a single SessionsConfigPorts object.
Raises:
NotFoundError: name is not in the list of ports objects.
ServerError: An abnormal server error has occurred.
- protocol_groups(self, name=None)
- Get the protocol-groups object(s) from the server.
A list of emulated protocol groups
Args:
name (:obj:`str`, optional, default=None): A key value in the protocol-groups list.
Returns:
:obj:`list` of :obj:`SessionsConfigProtocolGroups` | :obj:`SessionsConfigProtocolGroups`: If arg name is None a list of SessionsConfigProtocolGroups objects otherwise a single SessionsConfigProtocolGroups object.
Raises:
NotFoundError: name is not in the list of protocol-groups objects.
ServerError: An abnormal server error has occurred.
- start_protocols(self, start_protocols_input)
- Execute the start-protocols action on the server
Start one or more emulated protocol groups. An empty list signifies that all protocol groups will be started.
:return: StartProtocolsOutput.
:raises ServerException: An abnormal server error has occurred.
- start_traffic(self, start_traffic_input)
- Execute the start-traffic action on the server
Start one or more traffic groups. An empty list signifies that all traffic groups will be started.
:return: StartTrafficOutput.
:raises ServerException: An abnormal server error has occurred.
- stop_protocols(self, stop_protocols_input)
- Execute the stop-protocols action on the server
Stop one or more protocol groups. An empty list signifiels that all protocol groups will be stopped.
:return: StopProtocolsOutput.
:raises ServerException: An abnormal server error has occurred.
- stop_traffic(self, stop_traffic_input)
- Execute the stop-traffic action on the server
Stop one or more traffic groups. An empty list signifies that all traffic groups will be stopped.
:return: StopTrafficOutput.
:raises ServerException: An abnormal server error has occurred.
- traffic_groups(self, name=None)
- Get the traffic-groups object(s) from the server.
A list of traffic groups
Args:
name (:obj:`str`, optional, default=None): A key value in the traffic-groups list.
Returns:
:obj:`list` of :obj:`SessionsConfigTrafficGroups` | :obj:`SessionsConfigTrafficGroups`: If arg name is None a list of SessionsConfigTrafficGroups objects otherwise a single SessionsConfigTrafficGroups object.
Raises:
NotFoundError: name is not in the list of traffic-groups objects.
ServerError: An abnormal server error has occurred.
Data and other attributes defined here:
- ConnectPortsInput = <class 'openhltest.ConnectPortsInput'>
- ConnectPortsOutput = <class 'openhltest.ConnectPortsOutput'>
- DisconnectPortsInput = <class 'openhltest.DisconnectPortsInput'>
- DisconnectPortsOutput = <class 'openhltest.DisconnectPortsOutput'>
- LoadInput = <class 'openhltest.LoadInput'>
- StartProtocolsInput = <class 'openhltest.StartProtocolsInput'>
- StartProtocolsOutput = <class 'openhltest.StartProtocolsOutput'>
- StartTrafficInput = <class 'openhltest.StartTrafficInput'>
- StartTrafficOutput = <class 'openhltest.StartTrafficOutput'>
- StopProtocolsInput = <class 'openhltest.StopProtocolsInput'>
- StopProtocolsOutput = <class 'openhltest.StopProtocolsOutput'>
- StopTrafficInput = <class 'openhltest.StopTrafficInput'>
- StopTrafficOutput = <class 'openhltest.StopTrafficOutput'>
Methods inherited from yangbase.YangBase:
- create_sibling(self, yang_key_value)
- dump(self)
- refresh(self)
Data descriptors inherited from yangbase.YangBase:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- url
|
class SessionsStatisticEventsPorts(yangbase.YangBase) |
| |
TBD
|
| |
- Method resolution order:
- SessionsStatisticEventsPorts
- yangbase.YangBase
- __builtin__.object
Methods defined here:
- __init__(self, parent, yang_key_value=None)
Data descriptors defined here:
- connected_test_port_description
- str: Free form vendor specific description of the connected test port. Can include details such as make/model/productId of the underlying hardware. Empty if the abstract port is not connected to a test port.
- connected_test_port_id
- str: The id of the connected test port. Empty if the abstract port is not connected to a test port.
- connection_state
- :str:`enum`: The state of the connection to the physical hardware test port or virtual machine test port
Enums:
CONNECTING: TBD
CONNECTED_LINK_UP: TBD
CONNECTED_LINK_DOWN: TBD
DISCONNECTING: TBD
DISCONNECTED: TBD
- connection_state_details
- str: Free form vendor specific information about the state of the connection to the physical hardware test port or virtual machine test port. Empty if the abstract port is not connected to a test port.
- name
- str: An abstract test port name
- rx_frames
- str: The total number of frames received on the the port. Empty if the abstract port is not connected to a test port.
- speed
- str: The actual speed of the test port. Empty if the abstract port is not connected to a test port.
- tx_frames
- str: The total number of frames transmitted on the port. Empty if the abstract port is not connected to a test port.
Methods inherited from yangbase.YangBase:
- create_sibling(self, yang_key_value)
- dump(self)
- refresh(self)
Data descriptors inherited from yangbase.YangBase:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- url
|
class SessionsStatistics(yangbase.YangBase) |
| |
The statistics pull model
|
| |
- Method resolution order:
- SessionsStatistics
- yangbase.YangBase
- __builtin__.object
Methods defined here:
- __init__(self, parent)
- clear(self)
- Execute the clear action on the server
Clear all statistic counters.
:return: None.
:raises ServerException: An abnormal server error has occurred.
- create_ports(self, name)
- Create a ports instance on the server.
TBD
Args:
name (str): A unique key value that does not exist in the list on the server.
Returns:
:obj:`SessionsStatisticsPorts`: An object encapsulating an instance of the ports model.
Raises:
AlreadyExistsError: An instance of ports with the supplied key value already exists on the server.
ServerError: An abnormal server error has occurred.
- ports(self, name=None)
- Get the ports object(s) from the server.
TBD
Args:
name (:obj:`str`, optional, default=None): A key value in the ports list.
Returns:
:obj:`list` of :obj:`SessionsStatisticsPorts` | :obj:`SessionsStatisticsPorts`: If arg name is None a list of SessionsStatisticsPorts objects otherwise a single SessionsStatisticsPorts object.
Raises:
NotFoundError: name is not in the list of ports objects.
ServerError: An abnormal server error has occurred.
Data descriptors defined here:
- first_activity_timestamp
- yang:date-and-time: Timestamp of the first request to this session.
- last_activity_timestamp
- yang:date-and-time: Timestamp of the last request to this session
Methods inherited from yangbase.YangBase:
- create_sibling(self, yang_key_value)
- dump(self)
- refresh(self)
Data descriptors inherited from yangbase.YangBase:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- url
|
class SessionsStatisticsPorts(yangbase.YangBase) |
| |
TBD
|
| |
- Method resolution order:
- SessionsStatisticsPorts
- yangbase.YangBase
- __builtin__.object
Methods defined here:
- __init__(self, parent, yang_key_value=None)
Data descriptors defined here:
- connected_test_port_description
- str: Free form vendor specific description of the connected test port. Can include details such as make/model/productId of the underlying hardware. Empty if the abstract port is not connected to a test port.
- connected_test_port_id
- str: The id of the connected test port. Empty if the abstract port is not connected to a test port.
- connection_state
- :str:`enum`: The state of the connection to the physical hardware test port or virtual machine test port
Enums:
CONNECTING: TBD
CONNECTED_LINK_UP: TBD
CONNECTED_LINK_DOWN: TBD
DISCONNECTING: TBD
DISCONNECTED: TBD
- connection_state_details
- str: Free form vendor specific information about the state of the connection to the physical hardware test port or virtual machine test port. Empty if the abstract port is not connected to a test port.
- name
- str: An abstract test port name
- rx_frames
- str: The total number of frames received on the the port. Empty if the abstract port is not connected to a test port.
- speed
- str: The actual speed of the test port. Empty if the abstract port is not connected to a test port.
- tx_frames
- str: The total number of frames transmitted on the port. Empty if the abstract port is not connected to a test port.
Methods inherited from yangbase.YangBase:
- create_sibling(self, yang_key_value)
- dump(self)
- refresh(self)
Data descriptors inherited from yangbase.YangBase:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- url
| |