Package onep :: Package mediatrace :: Module mtrace
[frames] | no frames]

Module mtrace

Classes
  PathSpecifier
Class holding path specifications for trace to follow
  MediatraceRoute
Read only class holding route information from results of trace
  EchoProfile
Read only class containing ECHO profile information of a node in trace
  CPUProfile
Read only class containing CPU profile information of a node in trace
  InterfaceProfile
Read only class containing INTERFACE profile information of a node in trace
  MemoryProfile
Read only class containing MEMORY profile information of a node in trace
  PerfmonProfile
Read only class containing PERFMON profile information of a node in trace
  MediatraceNode
Read only class containing basic information of a node in trace
Functions
 
trace_request(element, profile, path_spec, timeout)
Trace request allows applications to gather network device information along a path without addressing each device directly.
Variables
  Protocol = enum(TCP= 6, UDP= 17)
  ProfileType = enum('ECHO', 'CPU', 'INTERFACE', 'MEMORY', 'PERF...
  RouteStatus = enum('PENDING', 'OK', 'NO_MEM', 'NO_OPER_COMP', ...
  TraceRouteStatus = enum('UNKNOWN', 'IN_PROGRESS', 'COMPLETE', ...
  NodeType = enum('MT', 'TR')
  NodeStatus = enum('FAIL', 'OK', 'SYSTEM_NO_MEM', 'SYSTEM_RESP_...
Function Details

trace_request(element, profile, path_spec, timeout)

 

Trace request allows applications to gather network device information along a path without addressing each device directly.

Parameters:
  • element ({NetworkElement<onep.element.NetworkElement>}) - NetworkElement class
  • profile ({ProfileType<onep.mediatrace.mtrace.ProfileType>}) - mtrace.ProfileType of trace
  • path_spec ({PathSpecifier<onep.mediatrace.mtrace.PathSpecifier>}) - PathSpecifier class
  • timeout (int) - Timeout value of trace

Variables Details

ProfileType

Value:
enum('ECHO', 'CPU', 'INTERFACE', 'MEMORY', 'PERFMON')

RouteStatus

Value:
enum('PENDING', 'OK', 'NO_MEM', 'NO_OPER_COMP', 'CONNECTING_TIMEOUT', \
'ESESCREATE1', 'ESESCREATE2', 'ESESCOMM', 'ETIMEOUT', 'NO_SUCH_PROFILE\
', 'TOO_MANY_PROFILE', 'EROUTECHG', 'EABORT_ROUTECHG', 'EINCOMPLETEHOP\
', 'ENOROUTE', 'ESESDOWN', 'RESP_NULL_PTR', 'RESP_SNMP_FAILURE', 'FNFV\
9_DECODE_FAILED', 'DVMC_REGISTRATION_FAILED', 'DVMC_MON_OBJ_BUILD_FAIL\
ED', 'DVMC_MONITOR_START_FAILED', 'DVMC_MONITOR_STOP_FAILED', 'DVMC_DA\
TA_COLLECTION_FAILED', 'DVMC_DATA_NO_RECORD', 'PROF_PROT_MISMATCH', 'P\
ROF_NOT_ATTACHED', 'FAIL', 'UNKNOWN')

TraceRouteStatus

Value:
enum('UNKNOWN', 'IN_PROGRESS', 'COMPLETE', 'ERROR', 'TIMEOUT', 'NO_MAT\
CH')

NodeStatus

Value:
enum('FAIL', 'OK', 'SYSTEM_NO_MEM', 'SYSTEM_RESP_NULL_PTR', 'SYSTEM_RE\
SP_SNMP_FAILURE', 'PERFMON_CLIENT_INVALID', 'PERFMON_CLIENT_EXIST', 'P\
ERFMON_MOBJ_ACTIVE', 'PERFMON_MOBJ_INVALID', 'PERFMON_PATH_INVALID', '\
PERFMON_IF_INVALID', 'PERFMON_FSPEC_INVALID', 'PERFMON_FSPEC_FAIL', 'P\
ERFMON_ROBJ_INVALID', 'PERFMON_ROBJ_EXIST', 'PERFMON_ROBJ_CREATE_FAIL'\
, 'PERFMON_FNF_DECODE_FAIL', 'PERFMON_FNF_NOMSG', 'PERFMON_FNF_ENCODE_\
FAIL', 'PERFMON_FNF_ENCODE_OPT_FAIL', 'PERFMON_XML_NOMSG', 'PERFMON_XM\
L_FAIL', 'PERFMON_XML_KEY_UNKNOWN', 'PERFMON_RPT_NO_RECORD', 'PERFMON_\
...