State¶
Leafs
-
class
NetworkInstances.NetworkInstance.ConnectionPoints.ConnectionPoint.Endpoints.Endpoint.
State
¶ Bases:
Entity
Class Hierarchy:
NetworkInstances
NetworkInstance
ConnectionPoints
ConnectionPoint
Endpoints
Endpoint
State
This class represents state data.
Operational state parameters relating to the
endpoint
-
endpoint_id
¶ An identifier for the endpoint
type: str
config: False
-
precedence
¶ The precedence of the endpoint - the lowest precendence viable endpoint will be utilised as the active endpoint within a connection
type: int
range: 0..65535config: False
-
type
¶ The type of endpoint that is referred to by the current endpoint
type: one of the below values:
LOCAL
config: False
-
active
¶ When the backup endpoint is active, the value of this parameter is set to true
type: bool
config: False
-