[ Module Hierarchy
| Class Hierarchy ]
Class Hierarchy
- unreachable
- onep.applmgmt.ApplicationCli.ApplicationCli:
The ApplmgmtData class represents application managed data that
reside in the network element.
- onep.topology.NodeConnector.NodeConnector:
NodeConnector class represents the logical/physical interfaces
forming an edge in a topology graph.
- ctypes.Structure
- onep.topology.TopologyFilter.TopologyFilter:
This class implements of the EventFilter abstract class for
filtering topology
- object:
The most base type
- onep.policy.Acl.Acl:
Access Control List (ACL) Class.
- onep.policyservice.action.Action:
The Action class is an abstract class that represents an action to
be applied to a policy entry (PolicyMap.Entry).
- onep.policyservice.bulk.ActivationHolder:
This class is provided as a container to group a policy with its
intended targets.
- onep.routing.AppRouteTable.AppRouteTable:
This class represents an application route table.
- onep.core.event.AsyncMsg.AsyncMsg:
This abstract class is meant to be implemented by a any class
acting as a event object.
- onep.aaa.Attribute.Attribute:
The Attribute class stores the AAA attributes defined for a user.
- exceptions.BaseException:
Common base class for all exceptions
- exceptions.Exception:
Common base class for all non-exit exceptions.
- onep.core.exception.OnepException.OnepException:
OnepException represents a general exception to be thrown by ONE-P API when
an unrecoverable error is encountered.
- exceptions.StandardError:
Base class for all standard Python exceptions that do not represent
interpreter exiting.
- exceptions.EnvironmentError:
Base class for I/O related errors.
- exceptions.IOError:
I/O operation failed.
- exceptions.ValueError:
Inappropriate argument value (of correct type).
- onep.policyservice.bulk.BulkService:
BulkService class.
- onep.mediatrace.mtrace.CPUProfile:
Read only class containing CPU profile information of a node in
trace
- onep.location.location.CivicLocation:
LocationCivic consists of a standard CAType constant and the
associated value.
- onep.policyservice.classmap.ClassFilter:
Filter specifications for ClassMap get functions
- onep.policyservice.classmap.ClassMap:
ClassMap class.
- onep.policyservice.classmap.ClassResultAsync:
docstring...
- onep.policyservice.statistics.ClassStatistics:
Class statistic totals
- onep.vty.VtyService.VtyService.CmdResults:
cmdResults is the collection of command results associated with the
VTY and last command run
- onep.element.ConnectionEvent.ConnectionEvent:
An event which indicates that a connection event occurred in a
network element
- onep.location.location.CustomLocation:
The Cisco Custom location type allows specification of multiple
arbitrary name and value pairs, in order to describe a location.
- onep.vty.util.DoHost:
This is a helper class that accepts input from shell scripts or
shell commands and pipes them to the onep Python SDK.
- onep.mediatrace.mtrace.EchoProfile:
Read only class containing ECHO profile information of a node in
trace
- onep.topology.Edge.Edge:
Edge class represents a path as seen by a protocol from one
interface (head) on a node to an interface (tail) on another node.
- onep.element.ElementProperty.ElementProperty:
Provides the static properties of the NetworkElement.
- onep.policyservice.policymap.Entry:
Entry class.
- onep.policyservice.statistics.EntryStatistics:
Service policy delta statistics
- onep.core.event.EventFilter.EventFilter:
This abstract class is meant to be implemented by any class acting
as an event filter.
- onep.core.event.EventListener.EventListener:
This interface is to be inherited by a any listener interface that
allows registering of interested events.
- onep.element.FRU.FRU:
This class represent the static properties of the Field Replaceable
Unit (FRU) on the network element.
- onep.location.location.GeoLocation:
GeoLocation contains geographic (GPS) location information
for an object in agreement with RFC 3825.
- onep.topology.Graph.Graph:
The Graph class represents the topology graph as seen by a protocol
from a node.
- onep.core.util.HostIpCheck.HostIpCheck:
Use this to check for a valid ipv4, ipv6 or hostname string.
- onep.identity.identity.Identity:
Session Aware Network (aka.
- onep.identity.identity.IdentitySession:
IdentitySession represents a session record in the database in a
network element.
- onep.interfaces.InterfaceConfig.InterfaceConfig:
This class represents the configuration (software property) of the
network interface.
- onep.mediatrace.mtrace.InterfaceProfile:
Read only class containing INTERFACE profile information of a node
in trace
- onep.interfaces.InterfaceProperty.InterfaceProperty:
This class represents hardware property of the network interface.
- onep.interfaces.InterfaceStatistics.InterfaceStatistics:
This class represents the Interface Statistics properties of the
network interface.
- onep.interfaces.InterfaceStatus.InterfaceStatus:
Class which handles provides information about status of the
interface
- onep.policy.L2Ace.L2Ace:
L2 Access Control Element (ACE) Class.
- onep.policy.L3Ace.L3Ace:
L3 Access Control Element (ACE) Class.
- onep.location.location.Location:
Location class stores all information related to physical location
in the real world.
- onep.policyservice.match.Match:
The Match class is an abstract class that represents a match
specified in the class map.
- onep.policyservice.statistics.MatchStatistics:
Match statistics
- onep.mediatrace.mtrace.MediatraceNode:
Read only class containing basic information of a node in trace
- onep.mediatrace.mtrace.MediatraceRoute:
Read only class holding route information from results of trace
- onep.mediatrace.mtrace.MemoryProfile:
Read only class containing MEMORY profile information of a node in
trace
- onep.element.NetworkApplication.NetworkApplication:
NetworkApplication represents the network services consumer
delegate and is the owner of onePK application-level property
settings and statistics.
- onep.element.NetworkElement.NetworkElement:
The NetworkElement class represents the hardware that hosts the
network OS.
- onep.interfaces.NetworkInterface.NetworkInterface:
This class represents a NetworkInterface.
- onep.interfaces.NetworkPrefix.NetworkPrefix:
Class representing the interface prefix that includes the IP
address and Prefix length.
- onep.routing.NextHop.NextHop
- onep.topology.Node.Node:
Node class represents topology node discovered via a protocol by
connecting to a NetworkElement.
- onep.core.util.OnepConstants.OnepConstants
- onep.vty.VtyService.VtyService.ParserState:
ParserState is used to determine what went wrong with a command
block.
- onep.mediatrace.mtrace.PathSpecifier:
Class holding path specifications for trace to follow
- onep.mediatrace.mtrace.PerfmonProfile:
Read only class containing PERFMON profile information of a node in
trace
- onep.core.util.Period.Period
- onep.policyservice.statistics.PoliceStatistics:
This class contains all the information received from the Network
Element about PoliceStatistics.
- onep.policyservice.caps.PolicyCapabilities:
Internal PolicyCapabilities class stores the capabilities of the
Network Element.
- onep.policyservice.policymap.PolicyFilter:
Filter for policy map gets
- onep.policyservice.caps.PolicyGlobal:
Policy capabilities of network element
- onep.policyservice.policymap.PolicyMap:
PolicyMap class.
- onep.policyservice.caps.PolicyPipeline:
Policy pipeline capabilities
- onep.policyservice.statistics.PolicyStatistics:
Policy statistics class
- onep.policyservice.caps.PolicyTable:
Policy capabilities of a table type
- onep.policyservice.statistics.QueueStatistics:
QueueStatistics class.
- onep.routing.RIB.RIB:
RIB class represents service provided by RIB (Routing Information
Base).
- onep.routing.RIBFilter.RIBFilter:
This abstract class is the parent class of L3UnicastRibFilter and
in the future for L3MulticastRibFilter, L2UnicastRibFilter,
L2MulticastRibFilter, etc.
- onep.policyservice.policymap.ResultAsync:
Header for most policy async results
- onep.routing.Route.Route:
This abstract class is the parent class of L3UnicastRoute and in
the future for L3MulticastRoute, L2UnicastRoute, L2MulticastRoute,
etc.
- onep.routing.RouteOperation.RouteOperation:
This abstract class is the parent class of L3UnicastRouteOperation
and in the future for L3MulticastRouteOperation,
L2UnicastRouteOperation, L2MulticastRouteOperation, etc.
- onep.routing.RouteRange.RouteRange:
This abstract class is the parent class of L3UnicastRouteRange and
in the future for L3MulticastRouteRange, L2UnicastRouteRange,
L2MulticastRouteRange, etc.
- onep.routing.RoutingClass.Routing:
Routing class represents the entry point of Routing Service.To access the
Routing Service API, the application instantiates a Routing object that's
associated with a NetworkElement.
- onep.routing.Scope.Scope:
This abstract class is the parent class of L3UnicastScope and in
the future for L3MulticastScope, L2UnicastScope, L2MulticastScope,
etc.
- onep.aaa.Server.Server:
Server class describes the AAA Server that is used for user
authentication.
- onep.discovery.ServiceSetDescription.ServiceSetDescription:
ServiceSetDescription defines a collection of service sets that are
grouped as an integral unit to provide a collection of services on
a network element.
- onep.element.SessionConfig.SessionConfig:
SessionConfig contains the configuration that will be used for
connecting to the network element.
- onep.element.SessionHandle.SessionHandle:
SessionHandle represents a live session (connection) between a
NetworkApplication and a single NetworkElement.
- onep.element.SessionProperty.SessionProperty:
SessionProperty contains properties of a connection to the network
element.
- onep.element.SessionStatistics.SessionStatistics:
SessionStatistics represents statistical data of a live session
(connection) between a NetworkApplication and a single
NetworkElement.
- onep.core.util.tlspinning.TLSUnverifiedElementHandler:
This class represents a handler for TLS connections in which the
network element has not been verified.
- onep.interfaces.Vlan.Vlan.Tag:
This class represent a VLAN tag, where: The most significant
16-bits is the Protocol Identifier (TPID).
- onep.policyservice.target.Target:
Target Class.
- onep.topology.TopologyClass.TopologyClass:
The Topology class represents the network topology as seen by a protocol in
an element.It provides methods to obtain the topology graph and to register
listener for receiving topology change events.
- onep.aaa.User.User:
AAA User class.
- onep.core.util.Version.Version:
Version class represents the version of a onePK component.
- onep.interfaces.Vlan.Vlan:
The VLAN class represents the information about the interface VLAN
encapsulation type and the associated tags.
- onep.interfaces.Vlan.VlanConfig:
Vlan configuration class for setting up 802.1Q VLAN encapsulation
- onep.interfaces.NetworkInterface.VtemplateInterface:
Vtemplate is a container, there are many types of vtemplates,
- onep.vty.util.VtyHelper:
VTY helper for any presentation service to VtyService handling
- onep.vty.VtyProxy.VtyProxy:
INTERNAL USE VTY proxy for development presentation services (Not
supported in onePK releases)
- onep.vty.VtyService.VtyService:
The VtyService class represents a vty on a network element i.e.