Object Model¶

Network¶

WAE OPM API

The OPM API exists to provide a more pythonic interface to WAE than the RPC API. Because the RPC API is multi-lingual, its syntax more closely resembles the idioms of Java and C++. This OPM API is python-specific, so it can translate common RPC API proceedures into constructs that are more familiar to a python programmer.

Note that this wrapping does carry with it some overhead in the form of extra memory usage and longer run times. If absolute performance is an imperative, consider using the RPC API instead.

com.cisco.wae.opm.network.open_plan(*args, **kwds)¶

Return a context-managed Network object.

Parameters:

plan (string or bytearray) – Path to a plan file, the bytes content of a planfile, an RPC PlanKey, an RPC PlanKey.id, a CDB network name, or an OPM API Network instance. If a Network instance is passed, a clone of the original Network is generated.
host (string, optional) – Name of the host where the RPC API service is hosted. The default, None, means the localhost.
port (int, optional) – Port on which the RPC API is hosted. The default, None, means the default port.
protocol (string, optional) – Protocol over which the RPC API is hosted, ‘http’ or ‘https’. None can be used to mean the default.
linger (bool, optional) – Controls what happens to the RPC plan when the context returns. If True, the plan is kept. If False, the plan is removed. If None (the default), the plan is kept if the function’s plan argument is the key to an existing plan in the RPC service and deleted otherwise.

Yields:

(Network) – Once the object goes out of scope, it will be cleaned up automatically.

class com.cisco.wae.opm.network.Network(plan, host=None, port=None, protocol=None, designapid_loglevel=None)¶

Bases: object

Wrapper to the a WAE plan opened in the RPC API.

Each plan has its own instance of a Network object and that object is used to access all the sub-modules of this package within the context of the current plan.

Parameters:

plan (string) – Path to the plan file to be opened, RPC PlanKey, RPC PlanKey.id, a CDB network name to be loaded, or the bytes that make up the plan. Can also be a Network instance, which will generate a clone of the passed instance.
host (string, optional) – Name of the host where the RPC API service is hosted. The default, None, means the localhost.
port (int, optional) – Port on which the RPC API is hosted. The default, None, means the default port.
protocol (string, optional) – Protocol over which the RPC API is hosted, ‘http’ or ‘https’. None can be used to mean the default.

Variables:

model (Model) – contains the OPM API Model for this plan
service_connection (ServiceConnection) – contains the ServiceConnection instance for this Network
rpc_simulation_manager (ServiceConnection) – contains the RPC API SimulationManager for this plan
rpc_tool_manager (ToolManager) – contains the RPC API ToolManager for this plan
rpc_plan (Plan) – contains the RPC API Plan that is being wrapped
rpc_plan_layout_manager (LayoutManager) – contains the RPC API Plan’s LayoutManager
rpc_plan_plotview_manager (PlotviewManager) – contains the RPC API Plan’s PlotviewManager
rpc_plan_traffic_manager (TrafficManager) – contains the RPC API Plan’s TrafficManager
rpc_plan_network (Network) – contains the RPC API Plan’s Network instance
closed (bool) – whether the plan has been closed
opened_from_existing (bool) – Whether this instance was created from an existing network in the RPC service

__init__(plan, host=None, port=None, protocol=None, designapid_loglevel=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

clone()¶: Returns a clone of the current network.

Caution: Use of this method is meant for advanced cases only since it bypasses the normal cleanup of new plans in the RPC service. When used, it is up to the user to call the remove_from_rpc() method at the correct time to prevent leaking plans/memory. If the simple case of cloning an existing plan that gets cleaned up when closed is desired, consider using open_plan(plan) instead.

remove_from_rpc()¶: Remove this plan from the RPC service. This should only be called immediately before calling close().

close()¶: Disconnect from the RPC API.

write(filename, plan_format=None)¶

Write the current plan to the local filesystem.

If the filename already exists, it will be overwritten. If the filename has a file extension, it will be ignored in preference to the method’s plan_format value, so be sure that they match. If the Network has already been closed, a RuntimeError will be raised.

Parameters:	filename (string) – Path of the file on the local filesystem to write to. plan_format (string, optional) – What format to write the filename in. If None, then the format will be inferred from the file extension of the filename argument. If it cannot be inferred, then ‘pln’ will be used. The format can be one of the following string values: ‘pln’, ‘txt’, or ‘db’.

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.ServiceConnection(host=None, port=None, protocol=None)¶

Bases: object

OPM API wrapper to RPC API ServiceConnection

Each host/port/protocol set used to open plans will share a single ServiceConnection instance. When a connection to a new set is needed, a connection is made and pooled. When the last Network on a ServiceConnection is goes out of scope, the ServiceConnection is shut down.

Parameters:

host (string, optional) – Name of the host where the RPC API service is hosted. The default, None, means the localhost.
port (int, optional) – Port on which the RPC API is hosted. The default, None, means the default port.
protocol (string, optional) – Protocol over which the RPC API is hosted, ‘tcp’ or ‘udp’. None can be used to mean the default (tcp).

Variables:

host (string) – The host that was connected to.
port (int) – The port that was connected to.
protocol (string) – The protocol that is being used to communicate with the RPC.
networks (list) – The Networks connected to the RPC API through this ServiceConnection
rpc_service_connection (ServiceConnection) – The RPC API ServiceConnection being wrapped.
rpc_plan_manager (PlanManager) – The RPC API PlanManager for this connection.

__init__(host=None, port=None, protocol=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

static register(network, host=None, port=None, protocol=None)¶

Register a Network instance as a client to a ServiceConnection.

Parameters:

network (Network) – The Network instance being registered.
host (string, optional) – Name of the host where the RPC API service is hosted. The default, None, means the localhost.
port (int, optional) – Port on which the RPC API is hosted. The default, None, means the default port.
protocol (string, optional) – Protocol over which the RPC API is hosted, ‘tcp’ or ‘udp’. None can be used to mean the default.

static deregister(network)¶

Disconnect a Network from its registered ServiceConnection.

Parameters:	network (`Network`) – The Network instance to disconnect.

Model Abstraction Layer¶

OPM API Model Abstraction Layer

The abstraction layer is designed to provide a framework that gives the end-programmer a relatively uniform interface and makes defining specific objects within the API easy since most of the functionality can be reused.

class com.cisco.wae.opm.network.model.NetworkObject(model=None, key=None, record=None)¶

Bases: object

Wrapper to an RPC object instance.

Each RPC API network object that is supported in the OPM API extends this base class. It defines the basic behavior for network model objects. In essence, these objects are interacted with using properties almost exclusively. Attributes that can be changed can have their properties assigned to. Read-only attributes can only have their properties read from. All objects also have hooks for describing the RPC layer objects that they represent.

Parameters:

model (Model, optional) – The Model instance that this object is to be associated with.
key (NetworkObjectKey, optional) – The key value that will be used to identify this object. This value need not be an actual NetworkObjectKey instance. It can be any value that can be converted into a key for the implementing class’ key class. Specifically, that means tuples, lists, dicts, and strings are also valid.
record (optional) – An RPC Record that will be used to initalize the instance.

Variables:

connected_to_rpc (ro, bool) – Whether the instance has a connection to the RPC API.
key (ro, NetworkObjectKey) – The key value that can be used to represent this object.
model (rw, Model) – The Model that this object is associated with. Can be set to None to remove the object from the model.
rpc_key (ro) – An RPC key that can be used to represent this object.
rpc_object (ro) – The RPC object that this object wraps.
rpc_record (ro) – The RPC record representation of this object.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__hash__() <==> hash(x)¶

__ne__(other)¶: x.__ne__(y) <==> x!=y

__repr__() <==> repr(x)¶

__str__() <==> str(x)¶

get_rpc_object()¶: Return the RPC API object that represents this object.

copy()¶: Return a copy of the object that isn’t attached to the current network Model.

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.NetworkObjectKey(value, model=None)¶

Bases: object

Unique identifier for a NetworkObject

Each NetworkObject class also has a NetworkObjectKey class. The Key class is used to represent an immutable value that can be used to represent a object instance. This concept is the same as the RPC API’s concept of keys except that in the OPM API end-programmers rarely need to work with key instances directly since they can usually be inferred by lookup methods.

Parameters:

value – Keys can be instanciated from strings, tuples, lists, dicts, RPC object instances, RPC keys, or even NetworkObject instances provided that the passed value contains enough information to identify all the key parts. If any information is missing, then a partial key is generated. Key parts in a partial key are assigned the None value. When a string is used, at least two potential formats are acceptable: Strings formatted like the key’s __str__ output is always acceptable. For example, a node could be keyed as ‘node{nodename}’. For objects that have only one key value, a simple string that is the content of that’s keyvalue can be passed. For example, for the same node from the previous example, the key ‘nodename’ could be used since Node objects have only one key value: name. If a list or tuple is passed, the tuple should values to match the keyvalues in the key. To extend our example, [‘nodename’] or (‘nodename’,) could be used. For dicts, the keys should be the key’s keynames and the values their corresponding keyvalues. ie. {‘name’:’nodename’}

Variables:

rpc_class (ro, class) – The RPC key class that this key wraps.
rpc_key (ro) – The RPC key instance that this key wraps.

__init__(value, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__hash__() <==> hash(x)¶

__ne__(other)¶: x.__ne__(y) <==> x!=y

__repr__() <==> repr(x)¶

__str__() <==> str(x)¶

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.NetworkObjectManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶

Bases: _abcoll.MutableMapping, _abcoll.MutableSequence

Collection of NetworkObject instances

NetworkObjectManager instances are used to represent collections of NetworkObject instances. For example, all the Interface objects in a Model are accessed through the model.interfaces property, which is an instance of InterfaceManager, which extends NetworkObjectManager. All the Interfaces on any given Node instance are accessed through the node.interfaces property, which is also an InterfaceManager instance.

NetworkObjectManagers behave like both python dicts and lists. Their key values are NetworkObjectKey instances and their values are the contained NetworkObject instances. When iterated, NetworkObjectManagers yield their values, not their keys. Depending upon the manager’s parent object, insertion order may not be preserved.

Parameters:

parent (Model or NetworkObject, optional) – Object that contains this collection object.
rpc_getter (string, optional) – Name of the method on the parent object that returns the object that has the methods listed in the other args.
size_method (string, optional) – Name of the method that returns the number of objects contained.
getall_method (string, optional) – Name of the method that returns all the objects contained.
getone_method (string, optional) – Name of the method that returns an object identified by its RPC key.
addone_method (string, optional) – Name of the method that adds an object to the container.
addlist_method (string, optional) – Name of the method that adds a list of objects to the container.
hasone_method (string, optional) – Name of the method that returns whether an object identified by its RPC key exists in the collection.
delone_method (string, optional) – Name of the method that removes an object from the collection.
dellist_method (string, optional) – Name of the method that removes a list of objects from the collection.
clear_method (string, optional) – Name of the method that removes all the objects from the collection.
objects (list, optional) – List of instances to inialize the manager’s cache with.

Variables:

cache_valid (rw, bool) – Whether the cached list of objects is valid. Set it to False if changes are made directly via the RPC layer.
connected_to_rpc (ro, bool) – Whether the manager is connected to the RPC API.
model (rw, Model) – The Model this manager is associated with.
parent (rw, Model or NetworkObject) – The manager’s parent object.

static manager_name()¶

Abstract method to be implemented by Subclasses.

Represents the property name in the top-level model instance’s manager of this type.

__init__(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ge__(other)¶: x.__ge__(y) <==> x>=y

__gt__(other)¶: x.__gt__(y) <==> x>y

__hash__() <==> hash(x)¶

__le__(other)¶: x.__le__(y) <==> x<=y

__lt__(other)¶: x.__lt__(y) <==> x<y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__repr__() <==> repr(x)¶

__str__() <==> str(x)¶

append(value)¶: S.append(object) – append object to the end of the sequence

clear() → None. Remove all items from D.¶

count(value) → integer -- return number of occurrences of value¶

extend(values)¶: S.extend(iterable) – extend sequence by appending elements from the iterable

get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶

index(value) → integer -- return first index of value.¶: Raises ValueError if the value is not present.

insert(position, value)¶: S.insert(index, object) – insert object before index

items() → list of D's (key, value) pairs, as 2-tuples¶

iteritems() → an iterator over the (key, value) items of D¶

iterkeys() → an iterator over the keys of D¶

itervalues() → an iterator over the values of D¶

keys() → list of D's keys¶

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair¶: as a 2-tuple; but raise KeyError if D is empty.

remove(value)¶: S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()¶: S.reverse() – reverse IN PLACE

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

update([E, ]**F) → None. Update D from mapping/iterable E and F.¶: If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → list of D's values¶

class com.cisco.wae.opm.network.model.FailibleNetobject¶

Bases: object

Used to mark a NetworkObject class as a potential part of a RouteSimulation failure.

When generating a route simulation, a failure scenario is used. The failure scenario is essentially a collection of failed objects. The list of failures used can be defined in two ways: Either setting a list of FallibleNetobject instances to the model instance’s route_simulation property, or by setting the fail property of each of the objects that should be in the scenario before the route simulation is used.

Variables:	failed (rw, bool) – Whether or not the object was used in the current route simulation. Changing the value signals that the current route simulation is no longer valid and whether or not this object should be used in generating the next route simulation.

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.Routable¶

Bases: object

Used to mark a NetworkObject class as one that can have a route in a route simulation.

Accessing either property implicitly generates a route simulation if there is no current valid route simulation on the model.

Variables:	route (ro, `Route`) – Returns the Route instance for this object, if routed. routed (ro, bool) – Whether the object is routed in the current simulation.

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.TagContainer¶

Bases: object

Used to mark NetworkObject classes that can have tags.

Variables:	tags (rw, `TagSet`) – NetworkObjects that extend this class gain this attribute which is used to manage the tags on each instance. Setting to this property resets the tags on the object, or clears them is set to None.

__init__()¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.TagSet(parent)¶

Bases: _abcoll.MutableSet

Container for the tags on an instance of TagContainer.

This class should be used as a mutable set of tags where each tag is a string. All set operations are supported.

Variables:	connected_to_rpc (ro, bool) – Whether or not the TagContaining object is connected to the RPC API.

__init__(parent)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ge__(other)¶: x.__ge__(y) <==> x>=y

__gt__(other)¶: x.__gt__(y) <==> x>y

__hash__() <==> hash(x)¶

__le__(other)¶: x.__le__(y) <==> x<=y

__lt__(other)¶: x.__lt__(y) <==> x<y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__repr__() <==> repr(x)¶

__str__() <==> str(x)¶

add(x)¶: Add an element.

clear()¶: This is slow (creates N new iterators!) but effective.

remove(x)¶: Remove an element. If not a member, raise a KeyError.

discard(x)¶: Remove an element. Do not raise an exception if absent.

pop()¶: Return the popped value. Raise KeyError if empty.

class com.cisco.wae.opm.network.model.UserPropertyContainer¶

Bases: object

Used to mark NetworkObject classes that can have user properties.

Variables:	user_properties (rw, `UserPropertyMapping`) – NetworkObjects that extend this class gain this attribute which is used to manage the user properties on each instance. Setting to this property resets the user properties on the object, or clears them is set to None.

__init__()¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.UserPropertyMapping(parent)¶

Bases: _abcoll.MutableMapping

Container for user properties on a NetworkObject that extends UserPropertyContainer

The UserPropertyMapping container behaves just like a dict. The keys are the user property name and the values are the user property values.

Alternatively, dictionaries can be used as keys to the mapping as well. The dictionary, at minimum, needs to have a ‘name’ key with the column’s name as the value. Other used keys are: ‘displayName’, ‘colType’, ‘decimals’, and ‘shown’. ‘displayName’ should be a string, which defaults to the same value as ‘name’. ‘colType’ can be one of the following strings: ‘null’, ‘bool’, ‘int’, ‘real’, or ‘text’. If missing, then a reasonable value will be guessed based on the value context, or ‘string’ otherwise. ‘decimals’ must be an integer and is only used when the the ‘colType’ is ‘real’. It defaults to 2. Finally, ‘shown’ must be a boolean and defaults to True. This feature is especially handy when setting properties.

Variables:	connected_to_rpc (ro, bool) – If the parent is connected to the RPC API. parent (ro, `UserPropertyContainer`) – The NetworkObject that has these properties.

__init__(parent)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__hash__() <==> hash(x)¶

__ne__(other)¶: x.__ne__(y) <==> x!=y

__repr__() <==> repr(x)¶

__str__() <==> str(x)¶

clear() → None. Remove all items from D.¶

get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶

items() → list of D's (key, value) pairs, as 2-tuples¶

iteritems() → an iterator over the (key, value) items of D¶

iterkeys() → an iterator over the keys of D¶

itervalues() → an iterator over the values of D¶

keys() → list of D's keys¶

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair¶: as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

update([E, ]**F) → None. Update D from mapping/iterable E and F.¶: If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → list of D's values¶

class com.cisco.wae.opm.network.model.RecordObject(record=None, model=None)¶

Bases: object

Wraps RPC API objects that only have record representations.

Some objects in the RPC API are represented only be record objects. They’re used for read-only data. So, classes that extend this class are used for generally read-only values.

Parameters:	record (optional) – An RPC record used to initialize this instance. model (`Model`) – The model this record is attached to.
Variables:	record (ro) – The RPC record being wrapped. record_class (ro, class) – The class of the RPC record being wrapped.

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.RecordObjectManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶

Bases: _abcoll.MutableSequence

Collection of RecordObjects

RecordObjectManager objects are used just like NetworkObjectManager objects, only they contain RecordObject instances instead.

Parameters:

parent (netobjectModel or NetworkObject, optional) – object that contains the manager object.
rpc_getter (string, optional) – Name of the method on the parent object that returns the object that has the methods listed in the other args.
size_method (string, optional) – Name of the method that returns the number of objects contained.
getall_method (string, optional) – Name of the method that returns all the objects contained.
getone_method (string, optional) – Name of the method that returns an object identified by its RPC key.
addone_method (string, optional) – Name of the method that adds an object to the container.
addlist_method (string, optional) – Name of the method that adds a list of objects to the container.
hasone_method (string, optional) – Name of the method that returns whether an object identified by its RPC key exists in the collection.
delone_method (string, optional) – Name of the method that removes an object from the collection.
dellist_method (string, optional) – Name of the method that removes a list of objects from the collection.
clear_method (string, optional) – Name of the method that removes all the objects from the collection.
objects (list, optional) – List of instances to inialize the manager’s cache with.

Variables:

cache_valid (rw, bool) – Whether the cached list of objects is valid. Set it to False if changes are made directly via the RPC layer.
connected_to_rpc (ro, bool) – Whether the manager is connected to the RPC API.
model (rw, Model) – The Model this manager is associated with.
parent (rw, Model or NetworkObject) – The manager’s parent object.

__init__(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ge__(other)¶: x.__ge__(y) <==> x>=y

__gt__(other)¶: x.__gt__(y) <==> x>y

__hash__() <==> hash(x)¶

__le__(other)¶: x.__le__(y) <==> x<=y

__lt__(other)¶: x.__lt__(y) <==> x<y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__repr__() <==> repr(x)¶

__str__() <==> str(x)¶

append(value)¶: S.append(object) – append object to the end of the sequence

count(value) → integer -- return number of occurrences of value¶

extend(values)¶: S.extend(iterable) – extend sequence by appending elements from the iterable

index(value) → integer -- return first index of value.¶: Raises ValueError if the value is not present.

insert(position, value)¶: S.insert(index, object) – insert object before index

pop([index]) → item -- remove and return item at index (default last).¶: Raise IndexError if list is empty or index is out of range.

remove(value)¶: S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()¶: S.reverse() – reverse IN PLACE

Model¶

class com.cisco.wae.opm.network.model.netobject.Model(network=None)¶

Bases: object

The network model of an opened plan.

This object represents the network model described within the current plan. It is analogous to the RPC API’s Network class.

Parameters:

network (Network, optional) – The Network that this model is connected to.

Variables:

name (rw, string) – The model name.
actual_l1_circuit_paths (rw, ActualL1CircuitPathManager) – Manager for all the ActualL1CircuitPath instances in the model.
actual_paths (rw, ActualPathManager) – Manager for all the ActualPath instances in the model.
admin_groups (rw, AdminGroupManager) – Mapping between affinity names and values
anycast_groups (rw, AnycastGroupManager) – Manager for all the AnycastGroup instances in the model.
ases (rw, AutonomousSystemManager) – Manager for all the AutonomousSystem instances in the model.
central_frequency_id_excludelists (rw, CentralFrequencyIDExcludelistManager) – Manager for all the CentralFrequencyIDExcludelists instances in the model.
circuits (rw, CircuitManager) – Manager for all the Circuit instances in the model.
demands (rw, DemandManager) – Manager for all the Demand instances in the model.
external_endpoints (rw, ExternalEndpointManager) – Manager for all the ExternalEndpoint instances in the model.
flows (rw, FlowManager) – Manager for all the Flow instances in the model.
interfaces (ro, InterfaceManager) – Manager for all the Interface instances in the model.
igp_protocols (rw, IGPProtocols) – Responsible for lookup, creation and deletion of domain specific IGPProtocols in the network.
flex_algorithms (rw, FlexAlgorithmManager) – Manager for all the FlexAlgorithms instances in the model.
l1_circuits (rw L1CircuitManager) – Manager for all the L1Circuit instances in the model.
l1_circuit_paths (rw, L1CircuitPathManager) – Manager for all the L1CircuitPath instances in the model.
l1_diversity_constraints (rw, L1DiversityManager) – Manager for all the L1Diversity instances in the model.
l1_links (rw, L1LinkManager) – Manager for all the L1Link instances in the model.
l1_nodes (rw, L1NodeManager) – Manager for all the L1Node instances in the model.
l1_ports (rw, L1PortManager) – Manager for all the L1Port instances in the model.
lsps (rw, LSPManager) – Manager for all the LSP instances in the model.
lsp_classes (rw, LSPClassManager) – Manager for all the LSPClass instances in the model.
lsp_paths (rw, LSPPathManager) – Manager for all the LSPPath instances in the model.
multicast_flows (rw, MulticastFlowManager) – Manager for all the MulticastFlow instances in the model.
multicast_flow_destinations (rw, MulticastFlowDestinationManager) – Manager for all the MulticastFlow destination instances in the model.
named_paths (rw, NamedPathManager) – Manager for all the NamedPath instances in the model.
netint_tables (rw, NetIntTableManager) – Manager for the NetworkInterface tables in the model.
nodes (rw, NodeManager) – Manager for all the Node instances in the model.
node_groups (rw, NodeGroupManager) – Manager for all the Node group instances in the model.
p2mp_lsps (rw, P2MPLSPManager) – Manager for all the P2MPLSP instances in the model.
ports (rw, PortManager) – Manager for all the Port instances in the model.
port_circuits (rw, PortCircuits) – Manager for all the PortCircuit instances in the model.
queues (rw, QueueManager) – Manager for all the Queue instances in the model.
reports (rw, ReportManager) – Manager for all the Report instances in the model.
segment_lists (rw, SegmentListManager) – Manager for all the SegmentList instances in the model.
service_classes (rw, ServiceClassManager) – Manager for all the ServiceClass instances in the model.
sites (rw, SiteManager) – Manager for all the Site instances in the model.
srlgs (rw, SRLGManager) – Manager for all the SRLG instances in the model.
topologies (rw, TopologyManager) – Manager for all the Topology instances in the model.
traffic_levels (rw, TrafficLevelManager) – Manager for all the TrafficLevel instances in the model.
user_tables (rw, UserTableManager) – Manager for user-defined tables in the model.
vpns (rw, VPNManager) – Manager for all the VPN instances in the model.
vpn_nodes (rw, VPNNodeManager) – Manager for all the VPN Nodes in the model.
l3_l1_links (rw, L3L1LinkManager) – Manager for all the links from L3 Nodes to L1 Nodes.
cache_valid (rw, bool) – If any data cached is still valid. Set to False if any data is directly changed in the RPC API.
connected_to_rpc (ro, bool) – If the model is connected to the RPC API.
current_queue (rw, Queue) – The Queue (to be) used to generate the current traffic_simulation. Changing the value signals that the traffic simulation should be recalculated. If a traffic simulation is needed before this property is assigned to, then None will be used.
current_traffic_level (rw, TrafficLevel) – The TrafficLevel (to be) used to generate the current traffic_simulation. Changing this property signals that the traffic simulation should be recalculated. If a traffic simulation is needed before this property is assigned to, then the first traffic level in the model is used. If no traffic levels exist, then one named ‘default’ is created and used.
network (ro, Network) – The Network instance this model is associated with.
rpc_plan_network (ro, Network) – RPC API object that this object wraps.
route_simulation (rw, RouteSimulation) – The current route simulation. Can be assigned a list of Fallible objects to generate a new route simulation using the failed objects as the failure scenario. Empty list or None can be used to generate a route simulation with no failures (the default).
traffic_simulation (rw, TrafficSimulation) – The current traffic simulation. Can be passed a tuple or a dict to signal that a new traffic simulation should be generated. If a tuple is passed, the first element should be the traffic level to be used and the second argument should be the queue to be used. Either can be None to mean the default (default). If a dict is used, then the two keys should be ‘traffic_level’ and ‘queue’. None can also be assigned to generate the default traffic simulation.
demand_traffic (rw, DemandTraffic) – Collection on demand traffic in the model. Can be set to None to clear.
measured_traffic (ro, MeasuredTraffic) – Collection of measured traffic managers.
simulation_analysis (ro, SimulationAnalysis) – Handle to the current simulation analysis tool.
use_network_state_in_simulations (rw, bool) –
use_multicast_network_state_in_simulations (rw, bool) –
igp_protocol (rw, string) – One of: ‘OSPF’, ‘OSPFv3’, ‘ISIS’, ‘ISISv6’, or ‘EIGRP’
igp_maximum_ecmp_paths (rw, bool) –
ebgp_multipath (rw, string) – One of: ‘Enabled’ or ‘Disabled’
ebgp_multipath_incoming (rw, string) – One of: ‘Enabled’ or ‘Disabled’
ibgp_multipath (rw, string) – One of: ‘Enabled’ or ‘Disabled’
multicast_multipath (rw, string) – One of: ‘Enabled’ or ‘Disabled’
lsp_establishment_order_seed (rw, int) –
no_demand_if_private_lsps_unrouted (rw, bool) –
srlg_failure_excludes_protected_circuits (rw, bool) –
simulation_convergence_mode (rw, string) – One of: ‘Full’, ‘FRR’, ‘AutoBW’, or ‘AutoBW_after_failure’.
multiple_igp_abr_restrictions (rw, string) – One of: ‘NO_RESTRICTION_ON_IGP_ABRS’, ‘EXCLUDE_SOME_IGP_ABRS’.
l1_restoration_convergence_mode (rw, bool) –
lsp_capacity_planning_mode (rw, bool) –
anchor_frequency (rw, float) –
central_frequency_granularity (rw, float) –
frequency_id_lower_bound (rw, int) –
frequency_id_upper_bound (rw, int) –
central_frequency_id_excludelist (rw, string) –
enforce_adj_sid_localization (rw, bool) –
num_sim_threads (rw, int) –

__init__(network=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__add__(other)¶

“Adding” a patch file to a model will return a new Network object with a model that has been patched.

Parameters:	other – opened `file` containing patch data, the path to a patch file, or a string containing the patch data.
Returns:	Model object containing a patched plan.
Raises:	RuntimeError if the patch could not be applied

__sub__(other)¶

“Subtracting” one model from another returns a patch where: other + patch == self

Parameters:	other – `Model`
Returns:	string containing the patch data.

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__weakref__¶: list of weak references to the object (if defined)

Actual Layer 1 Circuit Path¶

class com.cisco.wae.opm.network.model.actual_l1_circuit_path.key.ActualL1CircuitPathKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	l1_node_a (ro, string) – l1_port_a (ro, string) – l1_node_b (ro, string) – l1_port_b (ro, string) – path_option (ro, int) –

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__hash__() <==> hash(x)¶

class com.cisco.wae.opm.network.model.actual_l1_circuit_path.manager.ActualL1CircuitPathManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.actual_l1_circuit_path.netobject.ActualL1CircuitPath(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	hops (rw, `ActualL1CircuitPathHopManager`) – Container for the actual hops that this path takes. l1_circuit_path (ro, `L1CircuitPath`) – The L1Circuit that this a path for.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Actual Layer 1 Circuit Path Hop¶

class com.cisco.wae.opm.network.model.actual_l1_circuit_path_hop.manager.ActualL1CircuitPathHopManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.actual_l1_circuit_path_hop.record_object.ActualL1CircuitPathHop(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	actual_l1_circuit_path (ro, `ActualL1CircuitPath`) – step (ro, int) – l1_link (ro, `L1Link`, optional) – l1_node (ro, `L1Node`, optional) – central_frequency_id (ro, int, optional) – hop (ro, `L1Link` or `L1Node`) –

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Actual Path¶

class com.cisco.wae.opm.network.model.actual_path.key.ActualPathKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Parameters:	source (ro, string) – Name of the node that is the source for this path. lsp_name (ro, string) – Name of the LSP that this is the path for. path_option (ro, int) – The LSP option number for this path.

class com.cisco.wae.opm.network.model.actual_path.manager.ActualPathManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.actual_path.netobject.ActualPath(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	destination (rw, `Node`) – The destination Node for this path. hops (rw, `ActualPathHopManager`) – Container for the actual hops that this path takes. lsp (ro, `LSP`) – The LSP that this a path for. path_option (ro, int) – The LSP path option for this path.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Actual Path Hop¶

class com.cisco.wae.opm.network.model.actual_path_hop.manager.ActualPathHopManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.actual_path_hop.record_object.ActualPathHop(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:

node (ro, Node, optional) – The Node this hop represents if it is a node hop.
interface (ro, Interface, optional) – The Interface this hop represents if it is an interface hop.
netint_hop (ro, string) – NetInt hop
hop_type (ro, string) – Either ‘loose’, ‘strict’, or ‘exclude’.
hop (ro, Node or Interface) – The object that this hop represents, always defined.

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Anycast Group¶

class com.cisco.wae.opm.network.model.anycast_group.key.AnycastGroupKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) – The name of the group.

class com.cisco.wae.opm.network.model.anycast_group.manager.AnycastGroupManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.anycast_group.netobject.AnycastGroup(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.UserPropertyContainer

Variables:	nodes (rw, `NodeManager`) – The nodes in this group. sid (rw, int, optional) – The group SID.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Autonomous System¶

class com.cisco.wae.opm.network.model.autonomous_system.key.ASKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	asn (ro, string) – The AS number.

class com.cisco.wae.opm.network.model.autonomous_system.manager.ASManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.autonomous_system.netobject.AS(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer

Variables:

name (rw, string) – The AS name
as_type (rw, string) – The AS type. Possible values: ‘internal’ or ‘external’
external_mesh (rw, string) – The mesh type. Possible values: ‘include’ or ‘exclude’
description (rw, string) – The AS description.
igp_protocol (rw, string) – AS specific IGP protocol
nodes (rw, NodeManager) – The Nodes in this AS.
asn (rw, string) – The AS number.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Central Frequency ID Excludelist¶

class com.cisco.wae.opm.network.model.central_frequency_id_excludelist.key.CentralFrequencyIDExcludelistKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) – Name of the central frequency ID excludeList

class com.cisco.wae.opm.network.model.central_frequency_id_excludelist.manager.CentralFrequencyIDExcludelistManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.central_frequency_id_excludelist.netobject.CentralFrequencyIDExcludelist(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	frequency_ids (rw, string) – Comma separated list of blocking frequency IDs frequency_id_lower_bound (rw, int, optional) – lower bound for frequency ID frequency_id_uper_bound (rw, int, optional) – upper bound for frequency ID

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Circuit¶

class com.cisco.wae.opm.network.model.circuit.key.CircuitKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	node_a (ro, string) – Name of the Node on the “A” side of the Circuit. interface_a (ro, string) – Name of the Interface on node_a. node_b (ro, string) – Name of the Node on the “B” side of the Circuit. interface_b (ro, string) – Name of the Interface on node_b.

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__hash__() <==> hash(x)¶

class com.cisco.wae.opm.network.model.circuit.manager.CircuitManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.circuit.netobject.Circuit(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

name (rw, string) – Name of the Circuit
capacity (rw, int, optional) – Capacity of the circuit
delay (rw, int, optional) – The delay (latency) of the circuit
distance (rw, int, optional) – The distance of the circuit
active (rw, bool) – Whether the circuit is active or not
protected (rw, bool) – Whether the circuit is protected or not
parallel_group_name (rw, string) – The parallel group name of the circuit
last_template_update (rw, string) – The time is written in the ‘YYYY-MM-DDTHH:mm:ss[Z|[+|-]HH:mm]’ format.
initial_cost (rw, float) – Initial cost of the circuit
cost_per_period (rw, float) – Cost per period of the circuit
l1_circuit (rw, L1Circuit) – The L1 circuit object mapped to the circuit
l1_circuits (ro, L1CircuitManager) – The L1 circuit objects directly or indirectly associated to the circuit
interface_a (rw, Interface) – The Interface on the “A” side of the circuit.
interface_b (rw, Interface) – The Interface on the “B” side of the circuit.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Demand¶

com.cisco.wae.opm.network.model.demand.endpoint_to_object(model, endpoint)¶: Convert a demand endpoint string into an OMP API object.

com.cisco.wae.opm.network.model.demand.value_to_endpoint_string(value)¶: Convert an OPM API object into its demand endpoint string representation.

class com.cisco.wae.opm.network.model.demand.key.DemandKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Demand endpoints are uniquely identified by a qualified name. Different kinds of endpoints have different forms of qualifed names.

For an endpoint based on a Node, the name of the endpoint is simply the name of the Node.

For an endpoint based on an interface, the name of the endpoint is the qualified name of the interface, in the form of ‘if{node_name|interface_name}’. Example: ‘if{cr1.ams|to_cr1.lon}’.

For an endpoint based on an AS, the name of the endpoint is the ASN of the AS, enclosed by ‘AS{}’. Example: ‘AS{1234}’. If the AS endpoint has a preferred Node, the name will be append with a colon, followed by the name of the node. Example: ‘AS{1234}:node1’. If the AS endpoint has a preferred interface instead, the name will be append with a colon, followed by the qualified name of the interface, which is in the form ‘if{node_name|interface_name}’. Example: ‘AS{1234}:if{cr1.ams|to_cr1.lon}’.

Variables:	name (ro, string) – Name of the Demand source (ro, string) – String representation of the Demand source endpoint destination (ro, string) – String representation of the Demand destination endpoint. service_class (ro, string) – The name of the Demand’s ServiceClass.

class com.cisco.wae.opm.network.model.demand.manager.DemandManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.demand.netobject.Demand(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.Routable

Variables:

active (rw, bool) – Is this demand active
private_lsp (rw, LSP, optional) – If defined, then private_p2mp_lsp must be None.
private_p2mp_lsp (rw, P2MPLSP, optional) – If defined, then private_lsp must be None.
topology (rw, Topology) – Topology of this demand
latency_bound (rw, float, optional) – Latency bound for demand
name (ro, string) – Demand name
source (ro, Node or Interface or AutonomousSystem) – Source object of demand
destination (ro, Node or Interface or AutonomousSystem) – Destination object of demand
service_class (ro, ServiceClass) – Demand service class
traffic (rw, optional, float) – Demand traffic
growth_percent (rw, optional, float) – Demand growth percent
worst_case_latency (ro, optional, float) – Worst case latency for the current traffic level
worst_case_simulations (ro, optional, list) – Simulation analsysis cases that impact this Demand
worst_case_failed_objects (ro, optional, list) –
current_worst_case_simulations (ro, optional, list) – Simulation analysis cases for the current traffic level that result in the worst case
current_worst_case_failed_objects (ro, optional, list) – Model objects that when failed at the current traffic level result in a worst case scenario

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Demand Endpoint¶

class com.cisco.wae.opm.network.model.demand_endpoint.manager.DemandEndpointManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.demand_endpoint.record_object.DemandEndpoint(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	key (ro, string) –

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

External Endpoint¶

class com.cisco.wae.opm.network.model.external_endpoint.key.ExternalEndpointKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) – Name of the ExternalEndpoint

class com.cisco.wae.opm.network.model.external_endpoint.manager.ExternalEndpointManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.external_endpoint.netobject.ExternalEndpoint(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer

Variables:	members (rw, `ExternalEndpointMemberManager`) – name (ro, string) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

External Endpoint Member¶

class com.cisco.wae.opm.network.model.external_endpoint_member.key.ExternalEndpointMemberKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	external_endpoint (ro, string) – The name of the ExternalEndpoint that this member belongs to. demand_endpoint (ro, string) – The demand endpoint that this endpoint represents.

class com.cisco.wae.opm.network.model.external_endpoint_member.manager.ExternalEndpointMemberManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.external_endpoint_member.netobject.ExternalEndpointMember(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:	priority (rw, int) – traffic_balance_percentage (rw, float, optional) – eem_type (rw, string) – The EEM type can be: ‘shortest_path’, ‘fix_traffic’, or ‘deduce_traffic’ active (rw, bool) – protected (rw, bool) – external_endpoint (ro, `ExternalEndpoint`) – demand_endpoint (ro, `Node` or `Interface` or `AS`) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Flex Algorithm¶

class com.cisco.wae.opm.network.model.flex_algorithm.key.FlexAlgorithmKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	sr_algorithm (ro, int) –

class com.cisco.wae.opm.network.model.flex_algorithm.manager.FlexAlgorithmManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.flex_algorithm.netobject.FlexAlgorithm(model, key)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	sr_algorithm (ro, int) – constraints (rw, `ConstraintManager`) – Constraints for given flex algorithm.

__init__(model, key)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.model.flex_algorithm.constraint_manager.ConstraintManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.flex_algorithm.constraint_object.Constraint(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:

sr_algorithm (ro, int) –
igp_process_id (ro, string) –
ospf_area (ro, string) –
isis_level (rw, int) – The ISIS level of the interface. This is a bit set. Level 1 is represented by 1, Level 2 by 2
metric_type (ro, string) – ‘igp’, ‘te’, or ‘delay’
include_affinities (rw, list, optional) – list of long integers
include_any_affinities (rw, list, optional) – list of long integers
exclude_affinities (rw, list, optional) – list of long integers

Flow¶

class com.cisco.wae.opm.network.model.flow.flow_type.FlowType(value)¶

class com.cisco.wae.opm.network.model.flow.key.FlowKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	flow_id (ro, int) –

class com.cisco.wae.opm.network.model.flow.manager.FlowManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.flow.netobject.Flow(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer

Variables:	from_type (rw, string) – The ‘from’ type of the flow. to_type (rw, string) – The ‘to’ type of the flow. from_nodes (rw, `NodeManager`) – The ‘from’ nodes of this flow. to_nodes (rw, `NodeManager`) – The ‘to’ nodes of this flow.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

IGP Protocol¶

class com.cisco.wae.opm.network.model.igp_protocol.igp_protocol.IGPProtocol(model, igp_process_id, igp_protocol=None)¶

Bases: object

OPM object representation of IGPProtocol. Doesn’t has a Design RPC API counterpart.

Variables:	igp_protocol (rw, string) – IGP Protocol

__init__(model, igp_process_id, igp_protocol=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

__str__() <==> str(x)¶

class com.cisco.wae.opm.network.model.igp_protocol.netobject.IGPProtocols(model)¶

Bases: _abcoll.MutableMapping, _abcoll.MutableSequence

Manager equivalent class. Access the elements using list syntax to get IGPProtocol objects

__init__(model)¶: x.__init__(…) initializes x; see help(type(x)) for signature

items() → list of D's (key, value) pairs, as 2-tuples¶

insert(index, new_value)¶: S.insert(index, object) – insert object before index

remove(key)¶: S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

Interface¶

class com.cisco.wae.opm.network.model.interface.key.InterfaceKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

An Interface key can be generated by a string if the string is in one of the following formats:

NSO path: node[node_name]/intefaces/interface[interface_name]
Demand endpoint: if{node_name|interface_name}
Just the interface name: This ONLY works when the key is used in a manager where the Node’s name is implied.

Variables:	node (ro, string) – Name of the Node that this Interface belongs to. name (ro, string) – Name of the Interface.

class com.cisco.wae.opm.network.model.interface.manager.InterfaceManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

append(value)¶: S.append(object) – append object to the end of the sequence

class com.cisco.wae.opm.network.model.interface.netobject.Interface(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

reservable_bw (rw, float, optional) – The reservable bandwidth of the interface
circuit (ro, Circuit) – The circuit attached to this interface
opposite_interface (ro, Interface) – The interface on the opposite side of the circuit attached
isis_metric (rw, int, optional) – isis metric
igp_metric (rw, int, optional) – The IGP metric of the interface
te_metric (rw, int, optional) – The TE metric of the interface
te_enabled (rw, bool) – Is the interface enabled for TE
ports (ro, PortManager) – Iterable containing the port objects mapped to this interface (LAG)
configured_capacity (rw, float, optional) – The configured capacity of the interface
policy_group (rw, string) – The policy group of the interface
reservable_bw_percent (rw, float, optional) – Percentage of the reservable bandwidth on the interface
available_port_channels (rw, int, optional) – The required number of available port channels on the interface
available_port_channels_bw (rw, float, optional) – The required available bandwidth on port channels on the interface
frr_enabled (rw, bool) – Is the interface enabled for fast re-route (default=true)
sr_frr_enabled (rw, bool) – Is the interface enabled for SR fast re-route (default=true)
isis_level (rw, int) – The ISIS level of the interface. This is a bit set. Level 1 is represented by 1, Level 2 by 2
ospf_area (rw, string) – OSPF Area of the interface
igp_process_id (rw, string) – IGP Process ID for the interface
affinities (rw, list, optional) – List of long integers
sids (rw, InterfaceSIDManager) – Interface SIDs.
srv6_sids (rw, SRv6InterfaceSIDManager) – SRv6 Interface SIDs.
description (rw, string) – The description of the interface
uuid (rw, string) – UUID for the interface
netint_index (rw, int, optional) – The NetIntIndex of the interface
netint_container_index (rw, int, optional) – The NetIntContainerIndex of the interface
netint_type (rw, int, optional) – The NetIntType of the interface
netint_admin_status (rw, string) – The NetIntAdminStatus of the interface
netint_oper_status (rw, string) – The NetIntOperStatus of the interface
netint_subnet (rw, string) – The NetIntSubnet of the interface
eigrp_delay (rw, float, optional) – The EIGRP delay of the interface
sid (rw, int, optional) – The SID of the interface
ip_addresses (rw, list) – List of strings representing IP addresses associated with interface
name (rw, string) – The name of the interface
node (ro, Node) – The Node this Interface belongs to.
traffic_simulation (ro, Interface, optional) –
simulated_traffic (ro, float, optional) – Simulated traffic on interface (Mbps)
simulated_utilization (ro, float, optional) – Simulated utilization of interface
simulated_capacity (ro, float, optional) – Simulated capacity of interface
queue (ro, InterfaceQueue) – InterfaceQueue for the Model’s current Queue
queue_priority (rw, int, optional) – The priority of the Model’s current Queue on the interface
queue_weight (rw, float, optional) – The weight of the Model’s current Queue on the interface
queue_police_limit (rw, float, optional) – The police limit of the Model’s current Queue on the interface.
demands_routed_through (ro, list, optional) – List of Demands routed through this Interface in the current route_simulation.
lsps_routed_through (ro, list, optional) – List of the LSPs routed through this Interface in the current route_simulation.
lsp_paths_routed_through (ro, list, optional) – List of the LSPPaths routed through this Interface in the current route_simulation.
measured_traffic (rw, float, optional) – The measured traffic on this interface for the Model’s current queue and traffic level
measured_growth_percent (rw, float, optional) – The measured traffic growth percent on this interface for the Model’s current queue and traffic level
measured_utilization (ro, float, optional) – The measured traffic utilization on this interface for the Model’s current queue and traffic level
measured_qos_bound (ro, float, optional) – The measured traffic qos bound on this interface for the Model’s current queue and traffic level
worst_case_traffic (ro, float, optional) – Worst case traffic for the current traffic level
worst_case_utilization (ro, float, optional) – Worst case utilization for the current traffic level
worst_case_simulations (ro, list, optional) – Simulation analsysis cases that impact this Interface
worst_case_failed_objects (ro, list, optional) –
current_worst_case_simulations (ro, list, optional) – Simulation analysis cases for the current traffic level that result in the worst case
current_worst_case_failed_objects (ro, list, optional) – Model objects that when failed at the current traffic level result in a worst case scenario
failure_impact (ro, InterfaceFailureImpactRecord, optional) – Impact of failing the object at the current traffic level.
vpns_routed_through (ro, list) – netobject objects that pass through this interface.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.model.interface.sid_manager.InterfaceSIDManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.interface.sid_object.InterfaceSID(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	id (ro, int) – Identifier type (ro, string) – Either ‘’, ‘regular’, strict’, ‘flex_algo’, ‘adj’ or ‘bgp_peer_adj’ protected (ro, bool) – Whether the sid is protected or not

class com.cisco.wae.opm.network.model.interface.srv6_sid_manager.SRv6InterfaceSIDManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.interface.srv6_sid_object.SRv6InterfaceSID(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	id (ro, string) – protected (ro, bool) – sr_algorithm (ro, int) –

Interface Queue¶

class com.cisco.wae.opm.network.model.interface_queue.manager.InterfaceQueueManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObjectManager

__getitem__(identifier)¶: If the Interface doesn’t have a record, make one for it with the default values.

__setitem__(identifier, value)¶: Because we want Interfaces to be able to set each of these properties independantly, we need a custom set method.

__contains__(identifier)¶: Instead of seeing if the identifier has a record, see if it is a valid Interface identifier since all Interfaces implicitly have a record for the current queue.

__delitem__(identifier)¶: “Deleting” the queue record nulls out the record properties, but doesn’t delete the record because all Interfaces need to have a record for the current queue.

__len__()¶: Length of the manager is just the number of interfaces in the model since they all have records.

class com.cisco.wae.opm.network.model.interface_queue.record_object.InterfaceQueue(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	queue (ro, `Queue`) – interface (ro, `Interface`) – priority (ro, int, optional) – weight (ro, float, optional) – police_limit (ro, float, optional) –

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 1 Circuit¶

class com.cisco.wae.opm.network.model.l1_circuit.key.L1CircuitKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	l1_node_a (ro, string) – Name of the Layer1 Node on the “A” side. l1_port_a (ro, string) – Name of the Layer1 Port on l1_node_a. l1_node_b (ro, string) – Name of the Layer1 Node on the “B” side. l1_port_a – Name of the Layer1 Port on l1_node_b.

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__hash__() <==> hash(x)¶

class com.cisco.wae.opm.network.model.l1_circuit.manager.L1CircuitManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.l1_circuit.netobject.L1Circuit(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.Routable

Variables:

name (rw, string) – L1 Circuit name
active_path (rw, int) – The path option of the current active path.
minimum_routed_paths (rw, int) – the minimum number of routed L1 Circuit Paths for this L1 Circuit
bandwidth (rw, float, optional) – L1 Circuit bandwidth
disjoint_group (rw, string) – L1 Circuit Disjoint Group
disjoint_priority (rw, int) – L1 Circuit Disjoint Priority
sson_enabled (rw, bool) – Is the L1 Circuit SSON Enabled? SSON Enabled L1 Circuits can only route over SSON Enabled L1 Links.
prefer_lower_frequency_ids (rw, bool) – Does the spectrum assignment algorithm prefer lower Frequency IDs
l1_port_a (rw, L1Port) – L1Port on the “A” side.
l1_port_b (rw, L1Port) – L1Port on the “B” side.
l3_circuits (ro, CircuitManager) – The L3 circuit object associated to the L1 Circuit.
port_circuit (ro, PortCircuit) – PortCircuit that contains the L1 Circuit.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 1 Circuit Path¶

class com.cisco.wae.opm.network.model.l1_circuit_path.key.L1CircuitPathKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	l1_node_a (ro, string) – l1_port_a (ro, string) – l1_node_b (ro, string) – l1_port_b (ro, string) – path_option (ro, int) –

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__hash__() <==> hash(x)¶

class com.cisco.wae.opm.network.model.l1_circuit_path.manager.L1CircuitPathManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.l1_circuit_path.netobject.L1CircuitPath(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.Routable

Variables:

standby (rw, bool) – Is this L1 Circuit Path on Standby
active (rw, bool) – Is this L1 Circuit Path active
distance (rw, float, optional) – L1 Circuit Path distance
delay (rw, float, optional) – L1 Circuit Path delay
setup_priority (rw, int) – L1 Circuit Path setup priority (1-7)
central_frequency_id (rw, int, optional) – L1 Circuit Path central frequency ID
spectral_width_id (rw, int) – L1 Circuit Path spectral width
auto_spectrum_assignment (rw, bool) – Is auto spectrum assignment configured for L1 Circuit Path
feasibility_limit (rw, float, optional) – The feasibility limit in dB.
feasibility_acceptance_threshold (rw, bool) – The feasibility acceptance threshold set for the L1 Circuit Path
hops (rw, L1CircuitPathHopManager) – L1 Circuit Path hops
l1_circuit (rw, L1Circuit) – L1 Circuit associated with this L1 Circuit Path
path_option (rw, int) – Path Option of this L1 Circuit Path

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 1 Circuit Path Hop¶

class com.cisco.wae.opm.network.model.l1_circuit_path_hop.manager.L1CircuitPathHopManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.l1_circuit_path_hop.record_object.L1CircuitPathHop(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	l1_circuit_path (ro, `L1CircuitPath`) – step (ro, int) – hop_type (ro, string) – Either ‘loose’, ‘strict’, or ‘exclude’ l1_link (ro, `L1Link`, optional) – l1_node (ro, `L1Node`, optional) – central_frequency_id (ro, int, optional) – hop (ro, `L1Link` or `L1Node`) –

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 1 Diversity¶

class com.cisco.wae.opm.network.model.l1_diversity.key.L1DiversityKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.l1_diversity.manager.L1DiversityManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.l1_diversity.netobject.L1Diversity(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	name (rw, string) – L1 Diversity name type (rw, string) – Either ‘strict’ l1_circuit_a (rw, `L1Circuit`) – First L1 circuit in the constraint. l1_circuit_b (rw, `L1Circuit`) – Second L1 circuit in the constraint. l1_node_diversity (rw, bool) – l1_link_diversity (rw, bool) – srlg_diversity (rw, bool) – active (rw, bool) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 1 Link¶

class com.cisco.wae.opm.network.model.l1_link.key.L1LinkKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	l1_node_a (ro, string) – l1_node_b (ro, string) – name (ro, string) –

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__hash__() <==> hash(x)¶

class com.cisco.wae.opm.network.model.l1_link.manager.L1LinkManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.l1_link.netobject.L1Link(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

description (rw, string) – L1 Link description
metric (rw, float, optional) – L1 Link metric
distance (rw, float, optional) – L1 Link distance
delay (rw, float, optional) – L1 Link delay
noise_a_to_b (rw, float, optional) – The linear noise introduced by the L1 Link from L1 Node A to L1 Node B
noise_b_to_a (rw, float, optional) – The linear noise introduced by the L1 Link from L1 Node B to L1 Node A
noise_sigma_a_to_b (rw, float, optional) – The linear noise sigma introduced by the L1 Link from L1 Node A to L1 Node B
noise_sigma_b_to_a (rw, float, optional) – The linear noise sigma introduced by the L1 Link from L1 Node B to L1 Node A
protected (rw, bool) – Is this L1 Link protected
active (rw, bool) – Is this L1 Link Active
sson_enabled (rw, bool) – Is the L1 Link SSON Enabled
central_frequency_id_excludelist_name (rw, str) – Name of associated Central Frequency ID Excludelist
waypoints (rw, L1LinkWaypointManager) – L1 Link Waypoints associated with this L1 Link
l1_node_a (rw, L1Node) – L1 Node on the “A” side
l1_node_b (rw, L1Node) – L1 Node on the “B” side
name (rw, string) – L1 Link name
l1_circuits_routed_through (ro, list, optional) – List of L1Circuits routed through this link.
l1_circuit_paths_routed_through (ro, list, optional) – List of L1CircuitPaths routed through this link.
worst_case_utilization (ro, optional, float) – Worst case utilization for the current traffic level
worst_case_simulations (ro, optional, list) – Simulation analsysis cases that impact this Interface
worst_case_failed_objects (ro, optional, list) – Model objects that when failed result in a worst case scenario
current_worst_case_simulations (ro, optional, list) – Simulation analysis cases for the current traffic level that result in the worst case
current_worst_case_failed_objects (ro, optional, list) – Model objects that when failed at the current traffic level result in a worst case scenario

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 1 Link Waypoint¶

class com.cisco.wae.opm.network.model.l1_link_waypoint.key.L1LinkWaypointKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	l1_node_a (ro, string) – l1_node_b (ro, string) – link_name (ro, string) – order (ro, int) –

class com.cisco.wae.opm.network.model.l1_link_waypoint.manager.L1LinkWaypointManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.l1_link_waypoint.netobject.L1LinkWaypoint(model=None, key=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	description (rw, string) – longtitude (rw, float, optional) – latitude (rw, float, optional) – l1_link (ro, `L1Link`) – order (ro, int) –

__init__(model=None, key=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 1 Node¶

class com.cisco.wae.opm.network.model.l1_node.key.L1NodeKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.l1_node.manager.L1NodeManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.l1_node.netobject.L1Node(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

l1_node_type (rw, string) – Either ‘undefined’, ‘roadm’, or ‘amplifier’
description (rw, string) – L1 Node description
site (rw, Site) – Site containing L1 Node
protected (rw, bool) – Is this L1 Node protected
active (rw, bool) – Is this L1 Node active
ip_address (rw, string) – L1 Node IP Address
management_ip (rw, string) – L1 Node Management IP Address
vendor (rw, string) – L1 Node vendor
hw_model (rw, string) – L1 Node model
l1_links (ro, L1LinkManager) – L1 Links connected to this L1 Node
nodes (rw, ManyToManyRelationship) – Nodes associated with this L1 Node
os (rw, string) – L1 Node os
longitude (rw, float, optional) – L1 Node longitude
latitude (rw, float, optional) – L1 Node latitude
name (rw, string) – L1 Node name

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 1 Port¶

class com.cisco.wae.opm.network.model.l1_port.key.L1PortKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	l1_node (ro, string) – name (ro, string) –

class com.cisco.wae.opm.network.model.l1_port.manager.L1PortManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.l1_port.netobject.L1Port(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

remote_l1_node (ro, L1Node) – L1 node on opposite side of L1 circuit connected to this L1 Port
remote_l1_port (ro, L1Port) – L1 port on opposite side of L1 circuit connected to this L1 Port
protected (rw, bool) – Is this L1 Port protected
active (rw, bool) – Is this L1 Port active
capacity (rw, float, optional) – L1 Port capacity
description (rw, string) – L1 Port description
l1_node (ro, L1Node) – L1 Node containing this L1 Port
name (ro, string) – L1 Port name

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Layer 3 Layer 1 Link¶

class com.cisco.wae.opm.network.model.l3_l1_link.key.L3L1LinkKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	l3_node (ro, string) – l1_node (ro, string) –

class com.cisco.wae.opm.network.model.l3_l1_link.manager.L3L1LinkManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.l3_l1_link.netobject.L3L1Link(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	l3_node (rw, `Node`) – l1_node (rw, `L1Node`) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

LSP¶

class com.cisco.wae.opm.network.model.lsp.key.LSPKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	source (ro, string) – name (ro, string) –

class com.cisco.wae.opm.network.model.lsp.manager.LSPManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.lsp.netobject.LSP(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.Routable

Variables:

destination (rw, Node) – Destination node of LSP
netint_destination_node (rw, string, optional) – The NetInt destination of the LSP
source_ip (rw, string) – The source ip address of the LSP
destination_ip (rw, string) – The destination ip address of the LSP
setup_bandwidth (rw, float, optional) – The setup bandwidth of the LSP
setup_priority (rw, int) – The setup priority of the LSP (1-7)
hold_priority (rw, int) – The hold priority of the LSP (1-7)
active (rw, bool) – Is the LSP active
private (rw, bool) – Is the LSP private
topology (rw, Topology) – The Topology of the LSP
lsp_class (rw, LSPClass) – The LSP Class of the LSP
p2mp_lsp (rw, P2MPLSP) – The P2MP LSP the LSP belongs to
include_affinities (rw, list, optional) – list of long integers
include_any_affinities (rw, list, optional) – list of long integers
exclude_affinities (rw, list, optional) – list of long integers
load_share (rw, float) – The load sharing factor of the LSP
hop_limit (rw, int, optional) – The hop limit of the LSP
active_path (rw, int, optional) – The active path index to a LSP Path of the LSP
lsp_type (rw, string) – Either ‘rsvp’ or ‘segment_routing’
frr_type (rw, string) – Either ‘none’, ‘link’, or ‘node’
frr_interface (rw, Interface) – FRR interface of the LSP
netint_frr_interface (rw, string, optional) – The NetInt FRR interface of the LSP
description (rw, string) – The description of the LSP
uuid (rw, string) –
disjoint_group (rw, string) – The disjoint group of the LSP
disjoint_priority (rw, int) – The disjoint priority of the LSP
pcep (rw, bool) – Whether the LSP is PCE Delegated
auto_bandwidth (rw, bool) – Is autobandwidth enabled on LSP?
include_any_demands_tags (rw, list) – list of strings
netint_type (rw, string) –
netint_index (rw, string) –
netint_admin_status (rw, string) –
netint_oper_status (rw, string) –
netint_active_path (rw, int, optional) –
netint_last_path_change (rw, int, optional) –
netint_tunnel_interface_id (rw, int, optional) –
sid (rw, int, optional) – The SID of the LSP
actual_path (ro, ActualPath) – The Actual Path of the LSP
ordered_lsp_paths (ro, LSPPathManager) – Paths this LSP can take.
source (rw, Node) – Source node of the LSP
name (rw, string) – Name of the LSP
traffic_simulation (ro, LSP, optional) –
simulated_traffic (ro, float, optional) – Simulated traffic on LSP
simulated_setup_bandwidth (ro, float, optional) – Simulated setup BW of the LSP
simulated_setup_priority (ro, int, optional) – Simulated setup priority of the LSP
simulated_hold_priority (ro, int, optional) – Simulated hold priority of the LSP
demands_routed_through (ro, list, optional) – list of Demands routed through this LSP
lsps_routed_through (ro, list, optional) – list of other LSPs routed through this LSP
lsp_paths_routed_through (ro, list, optional) – list of LSPPaths routed through this LSP
measured_traffic (rw, float, optional) – Measured traffic on LSP
color (rw, int, optional) – The color of the SR policy
delegated_pce_address (rw, string) – The IP address of the PCE where this LSP is delegated.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

LSP Class¶

class com.cisco.wae.opm.network.model.lsp_class.key.LSPClassKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.lsp_class.manager.LSPClassManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.lsp_class.netobject.LSPClass(model=None, key=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	name (rw, string) –

__init__(model=None, key=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

LSP Path¶

class com.cisco.wae.opm.network.model.lsp_path.key.LSPPathKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	source (ro, string) – lsp_name (ro, string) – path_option (ro, int) –

class com.cisco.wae.opm.network.model.lsp_path.manager.LSPPathManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.lsp_path.netobject.LSPPath(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.Routable

Variables:

named_path (rw, NamedPath) – Named Path associated with this LSP Path
setup_bandwidth (rw, float, optional) – LSP Path setup bandwidth
setup_priority (rw, int) – LSP Path setup priority
hold_priority (rw, int) – LSP Path hold priority
include_affinities (rw, list, optional) – list of long integers
include_any_affinities (rw, list, optional) – list of long integers
exclude_affinities (rw, list, optional) – list of long integers
hop_limit (rw, int, optional) – LSP Path hop limit
standby_type (rw, string) – Either ‘undefined’, ‘not_standby’, or ‘standby’
active (rw, bool) – Is this LSP Path active
actual_path (ro, ActualPath) – Actual Path for this LSP Path
segment_list (rw, SegmentList) – Segment List configured for this LSP Path
lsp (rw, LSP) – LSP associated with this LSP Path
path_option (rw, int) – LSP path option
preference (rw, int) – LSP path SR preference
protocol_origin (rw, string) – The component or protocol that originates or signals the path, either ‘local’, ‘pce_initiated’, ‘bgp_initiated’ or ‘invalid’
sr_candidate_path_name (rw, string) – The user provided SR candidate path name
optimization_objective (rw, string) – The optimization objective of a dynamic path, either ‘none’, ‘igp_metric’, ‘te_metric’, ‘delay’ or ‘hops’
dynamic (rw, bool) – Is the LSP path dynamic

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Multicast Flow¶

class com.cisco.wae.opm.network.model.multicast_flow.key.MulticastFlowKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	sourceIP (ro, string) – receiverIP (ro, string) –

class com.cisco.wae.opm.network.model.multicast_flow.manager.MulticastFlowManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.multicast_flow.netobject.MulticastFlow(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer

Variables:	hops (rw, `MulticastFlowHopManager`) – Multicast flow hops external_hops (rw, `MulticastFlowExternalHopManager`) – Multicast flow external hops

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Multicast Flow Hop¶

class com.cisco.wae.opm.network.model.multicast_flow_hop.manager.MulticastFlowHopManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.multicast_flow_hop.record_object.MulticastFlowHop(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	source_ip (rw, string) – Source group of the multicast flow receiver_ip (rw, string) – Receiver group of the multicast flow interface (rw, `Interface`) – The hop interface

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Multicast Flow External Hop¶

class com.cisco.wae.opm.network.model.multicast_flow_external_hop.manager.MulticastFlowExternalHopManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.multicast_flow_external_hop.record_object.MulticastFlowExternalHop(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	source_ip (rw, string) – Source group of the multicast flow receiver_ip (rw, string) – Receiver group of the multicast flow direction (rw, string) – Direction of the hop. ingress or egress. node (rw, `Node`) – The hop node interface (rw, string) – The hop interface name index (rw, int) – Index of the hop

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Multicast Flow Destination¶

class com.cisco.wae.opm.network.model.multicast_flow_destination.key.MulticastFlowDestinationKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	sourceIP (ro, string) – receiverIP (ro, string) –

class com.cisco.wae.opm.network.model.multicast_flow_destination.manager.MulticastFlowDestinationManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.multicast_flow_destination.netobject.MulticastFlowDestination(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	destinations (rw, `com.cisco.wae.opm.network.model.demand_endpoint.manager`) – List of destination demand endpoints

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Named Path¶

class com.cisco.wae.opm.network.model.named_path.key.NamedPathKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	source (ro, string) – name (ro, string) –

class com.cisco.wae.opm.network.model.named_path.manager.NamedPathManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.named_path.netobject.NamedPath(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	active (rw, bool) – Is this Named Path active hops (rw, `NamedPathHopManager`) – Named Path hops source (rw, `Node`) – Named Path source node name (rw, string) – Named Path name

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Named Path Hop¶

class com.cisco.wae.opm.network.model.named_path_hop.manager.NamedPathHopManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.named_path_hop.record_object.NamedPathHop(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	node (ro, `Node`, optional) – interface (ro, `Interface`, optional) – hop_type (ro, string) – Either ‘loose’, ‘strict’, or ‘exclude’ netint_hop (ro, string) – NetIntHop hop (ro, `Node` or `Interface` or str) –

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

NetInt Table¶

class com.cisco.wae.opm.network.model.netint_table.key.NetIntTableKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.netint_table.manager.NetIntTableManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.netint_table.netobject.NetIntTable(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	name (ro, string) – The name of the table columns (ro, list) – List of `NetIntTableColumn` objects that make up the columns of this table. rows (ro, list) – List of `NetIntTableRow` objects that make up the rows in the table.

column_index()¶: return the index for a column given by name, record, or object.

Example

for row in network.model.user_tables[‘NetInt::Table’].rows:

for column_name, value in row.items():: print ‘%s: %s’ % (column_name, str(value))

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

column_index(value)

Parameters:	value (string, or ColumnRecord, or NetIntTableColumn) –
Returns:	The index value of the passed value
Return type:	(int)

class com.cisco.wae.opm.network.model.netint_table.netobject.NetIntTableColumn(netint_table, column_record)¶

Bases: com.cisco.wae.opm.network.model.UserColumn

Variables:	name (ro, string) – display_name (ro, string) – column_type (ro, type) – None, bool, int, float, or str decimals (ro, int) – Only relevant if column_type is float description (ro, string) – shown (ro, bool) –

__init__(netint_table, column_record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.model.netint_table.netobject.NetIntTableRow(netint_table, row_record)¶

Bases: object

keys(ro, list)¶: List of column names

values(ro, list)¶: Values for each column

items()¶

iterkeys()¶

itervalues()¶

iteritems()¶

__init__(netint_table, row_record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

Node¶

class com.cisco.wae.opm.network.model.node.key.NodeKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.node.manager.NodeManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.node.netobject.Node(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

configured_srlgs (rw, SRLGManager) –
interfaces (ro, InterfaceManager) – New Interfaces are added by creating new Circuits.
l1_nodes (rw, ManyToManyRelationshipManager) – Manager that maps this Node with related layer 1 Nodes.
vpns (rw, ManyToManyRelationshipManager) – Manager for VPNs that pass through this Node.
lsps (ro, LSPManager) – LSPs that are sourced from this Node.
lsps_routed_through (ro, LSPManager) – LSPs that are either sourced from, destined for, or routed through this Node.
named_paths (ro, NamedPathManager) –
p2mp_lsps (ro, P2MPLSPManager) –
ports (ro, PortManager) –
sids (rw, NodeSIDManager) – Node SIDs.
srv6_sids (rw, SRv6NodeSIDManager) – SRv6 Node SIDs.
loopbacks (rw, LoopbackManager) – Prefix loopbacks.
autonomous_system (rw, AS) –
site (rw, Site) –
node_function (rw, string) – Either ‘core’ or ‘edge’
active (rw, bool) –
protected (rw, bool) –
node_type (rw, string) – Either ‘physical’, ‘psn’, or ‘virtual’
isis_area (rw, string) –
avoid_transit (rw, string) – Either ‘none’ or ‘strict’
description (rw, string) –
vendor (rw, string) –
node_model (rw, string) –
os (rw, string) –
management_ip (rw, string) –
ip_address (rw, string) –
bgp_id (rw, string, optional) –
last_template_update (rw, string) –
initial_cost (rw, float) –
cost_per_period (rw, float) –
netint_snmp_error (rw, string, optional) –
netint_re0_cpu_1m (rw, int, optional) –
netint_re0_cpu_5m (rw, int, optional) –
netint_re1_cpu_1m (rw, int, optional) –
netint_re1_cpu_5m (rw, int, optional) –
netint_re0_mem (rw, int, optional) –
netint_re1_mem (rw, int, optional) –
maximum_sid_depth (rw, int, optional) –
longitude (rw, float, optional) –
latitude (rw, float, optional) –
sid (rw, int, optional) –
uuid (rw, string) –
name (ro, string) –
measured_ingress_traffic (rw, float, optional) –
measured_egress_traffic (rw, float, optional) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Collection of RecordObjects

RecordObjectManager objects are used just like NetworkObjectManager objects, only they contain RecordObject instances instead.

param rpc_getter:
param parent:	object that contains the manager object.
type parent:	`netobjectModel` or `NetworkObject`, optional
	Name of the method on the parent object that returns the object that has the methods listed in the other args.
type rpc_getter:
	string, optional
param size_method:
	Name of the method that returns the number of objects contained.
type size_method:
	string, optional
param getall_method:
	Name of the method that returns all the objects contained.
type getall_method:
	string, optional
param getone_method:
	Name of the method that returns an object identified by its RPC key.
type getone_method:
	string, optional
param addone_method:
	Name of the method that adds an object to the container.
type addone_method:
	string, optional
param addlist_method:
	Name of the method that adds a list of objects to the container.
type addlist_method:
	string, optional
param hasone_method:
	Name of the method that returns whether an object identified by its RPC key exists in the collection.
type hasone_method:
	string, optional
param delone_method:
	Name of the method that removes an object from the collection.
type delone_method:
	string, optional
param dellist_method:
	Name of the method that removes a list of objects from the collection.
type dellist_method:
	string, optional
param clear_method:
	Name of the method that removes all the objects from the collection.
type clear_method:
	string, optional
param objects:	List of instances to inialize the manager’s cache with.
type objects:	list, optional
ivar cache_valid:
	Whether the cached list of objects is valid. Set it to False if changes are made directly via the RPC layer.
vartype cache_valid:
	rw, bool
ivar connected_to_rpc:
	Whether the manager is connected to the RPC API.
vartype connected_to_rpc:
	ro, bool
ivar model:	The Model this manager is associated with.
vartype model:	rw, `Model`
ivar parent:	The manager’s parent object.
vartype parent:	rw, `Model` or `NetworkObject`

com.cisco.wae.opm.network.model.node.loopback_manager.LoopbackManager.__delattr__¶: x.__delattr__(‘name’) <==> del x.name

com.cisco.wae.opm.network.model.node.loopback_manager.LoopbackManager.__getattribute__¶: x.__getattribute__(‘name’) <==> x.name

com.cisco.wae.opm.network.model.node.loopback_manager.LoopbackManager.__new__(S, ...) → a new object with type S, a subtype of T¶

com.cisco.wae.opm.network.model.node.loopback_manager.LoopbackManager.__setattr__¶: x.__setattr__(‘name’, value) <==> x.name = value

com.cisco.wae.opm.network.model.node.loopback_manager.LoopbackManager.__weakref__¶: list of weak references to the object (if defined)

ivar ip_address:

vartype ip_address:
	ro, string
ivar igp_process_id:

vartype igp_process_id:
	ro, string
ivar area:
vartype area:	ro, string
ivar isis_level:
	The ISIS level of the interface. This is a bit set. Level 1 is represented by 1, Level 2 by 2
vartype isis_level:
	rw, int

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__delattr__¶: x.__delattr__(‘name’) <==> del x.name

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__getattribute__¶: x.__getattribute__(‘name’) <==> x.name

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__hash__¶

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__new__(S, ...) → a new object with type S, a subtype of T¶

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__repr__¶

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__setattr__¶: x.__setattr__(‘name’, value) <==> x.name = value

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__str__¶

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

com.cisco.wae.opm.network.model.node.loopback_object.PrefixLoopback.__weakref__¶: list of weak references to the object (if defined)

Collection of RecordObjects

RecordObjectManager objects are used just like NetworkObjectManager objects, only they contain RecordObject instances instead.

param rpc_getter:
param parent:	object that contains the manager object.
type parent:	`netobjectModel` or `NetworkObject`, optional
	Name of the method on the parent object that returns the object that has the methods listed in the other args.
type rpc_getter:
	string, optional
param size_method:
	Name of the method that returns the number of objects contained.
type size_method:
	string, optional
param getall_method:
	Name of the method that returns all the objects contained.
type getall_method:
	string, optional
param getone_method:
	Name of the method that returns an object identified by its RPC key.
type getone_method:
	string, optional
param addone_method:
	Name of the method that adds an object to the container.
type addone_method:
	string, optional
param addlist_method:
	Name of the method that adds a list of objects to the container.
type addlist_method:
	string, optional
param hasone_method:
	Name of the method that returns whether an object identified by its RPC key exists in the collection.
type hasone_method:
	string, optional
param delone_method:
	Name of the method that removes an object from the collection.
type delone_method:
	string, optional
param dellist_method:
	Name of the method that removes a list of objects from the collection.
type dellist_method:
	string, optional
param clear_method:
	Name of the method that removes all the objects from the collection.
type clear_method:
	string, optional
param objects:	List of instances to inialize the manager’s cache with.
type objects:	list, optional
ivar cache_valid:
	Whether the cached list of objects is valid. Set it to False if changes are made directly via the RPC layer.
vartype cache_valid:
	rw, bool
ivar connected_to_rpc:
	Whether the manager is connected to the RPC API.
vartype connected_to_rpc:
	ro, bool
ivar model:	The Model this manager is associated with.
vartype model:	rw, `Model`
ivar parent:	The manager’s parent object.
vartype parent:	rw, `Model` or `NetworkObject`

com.cisco.wae.opm.network.model.node.sid_manager.NodeSIDManager.__delattr__¶: x.__delattr__(‘name’) <==> del x.name

com.cisco.wae.opm.network.model.node.sid_manager.NodeSIDManager.__getattribute__¶: x.__getattribute__(‘name’) <==> x.name

com.cisco.wae.opm.network.model.node.sid_manager.NodeSIDManager.__new__(S, ...) → a new object with type S, a subtype of T¶

com.cisco.wae.opm.network.model.node.sid_manager.NodeSIDManager.__setattr__¶: x.__setattr__(‘name’, value) <==> x.name = value

com.cisco.wae.opm.network.model.node.sid_manager.NodeSIDManager.__weakref__¶: list of weak references to the object (if defined)

vartype protected:
ivar id:
vartype id:	ro, int
ivar type:	Either ‘’, ‘regular’, strict’, ‘flex_algo’, ‘adj’ or ‘bgp_peer_adj’
vartype type:	ro, string
ivar protected:
	ro, bool
ivar sr_algorithm:

vartype sr_algorithm:
	ro, int

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__delattr__¶: x.__delattr__(‘name’) <==> del x.name

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__getattribute__¶: x.__getattribute__(‘name’) <==> x.name

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__hash__¶

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__new__(S, ...) → a new object with type S, a subtype of T¶

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__repr__¶

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__setattr__¶: x.__setattr__(‘name’, value) <==> x.name = value

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__str__¶

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

com.cisco.wae.opm.network.model.node.sid_object.NodeSID.__weakref__¶: list of weak references to the object (if defined)

Collection of RecordObjects

RecordObjectManager objects are used just like NetworkObjectManager objects, only they contain RecordObject instances instead.

param rpc_getter:
param parent:	object that contains the manager object.
type parent:	`netobjectModel` or `NetworkObject`, optional
	Name of the method on the parent object that returns the object that has the methods listed in the other args.
type rpc_getter:
	string, optional
param size_method:
	Name of the method that returns the number of objects contained.
type size_method:
	string, optional
param getall_method:
	Name of the method that returns all the objects contained.
type getall_method:
	string, optional
param getone_method:
	Name of the method that returns an object identified by its RPC key.
type getone_method:
	string, optional
param addone_method:
	Name of the method that adds an object to the container.
type addone_method:
	string, optional
param addlist_method:
	Name of the method that adds a list of objects to the container.
type addlist_method:
	string, optional
param hasone_method:
	Name of the method that returns whether an object identified by its RPC key exists in the collection.
type hasone_method:
	string, optional
param delone_method:
	Name of the method that removes an object from the collection.
type delone_method:
	string, optional
param dellist_method:
	Name of the method that removes a list of objects from the collection.
type dellist_method:
	string, optional
param clear_method:
	Name of the method that removes all the objects from the collection.
type clear_method:
	string, optional
param objects:	List of instances to inialize the manager’s cache with.
type objects:	list, optional
ivar cache_valid:
	Whether the cached list of objects is valid. Set it to False if changes are made directly via the RPC layer.
vartype cache_valid:
	rw, bool
ivar connected_to_rpc:
	Whether the manager is connected to the RPC API.
vartype connected_to_rpc:
	ro, bool
ivar model:	The Model this manager is associated with.
vartype model:	rw, `Model`
ivar parent:	The manager’s parent object.
vartype parent:	rw, `Model` or `NetworkObject`

com.cisco.wae.opm.network.model.node.srv6_sid_manager.SRv6NodeSIDManager.__delattr__¶: x.__delattr__(‘name’) <==> del x.name

com.cisco.wae.opm.network.model.node.srv6_sid_manager.SRv6NodeSIDManager.__getattribute__¶: x.__getattribute__(‘name’) <==> x.name

com.cisco.wae.opm.network.model.node.srv6_sid_manager.SRv6NodeSIDManager.__new__(S, ...) → a new object with type S, a subtype of T¶

com.cisco.wae.opm.network.model.node.srv6_sid_manager.SRv6NodeSIDManager.__setattr__¶: x.__setattr__(‘name’, value) <==> x.name = value

com.cisco.wae.opm.network.model.node.srv6_sid_manager.SRv6NodeSIDManager.__weakref__¶: list of weak references to the object (if defined)

vartype protected:
ivar id:
vartype id:	ro, string
ivar protected:
	ro, bool
ivar sr_algorithm:

vartype sr_algorithm:
	ro, int

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__delattr__¶: x.__delattr__(‘name’) <==> del x.name

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__getattribute__¶: x.__getattribute__(‘name’) <==> x.name

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__hash__¶

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__new__(S, ...) → a new object with type S, a subtype of T¶

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__repr__¶

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__setattr__¶: x.__setattr__(‘name’, value) <==> x.name = value

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__str__¶

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

com.cisco.wae.opm.network.model.node.srv6_sid_object.SRv6NodeSID.__weakref__¶: list of weak references to the object (if defined)

Node Group¶

class com.cisco.wae.opm.network.model.node_group.key.NodeGroupKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.node_group.manager.NodeGroupManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.node_group.netobject.NodeGroup(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	members (rw, `NodeManager`) – Members of this node group

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Point-to-Multipoint LSP¶

class com.cisco.wae.opm.network.model.p2mp_lsp.key.P2MPLSPKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	source (ro, string) – name (ro, string) –

class com.cisco.wae.opm.network.model.p2mp_lsp.manager.P2MPLSPManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.p2mp_lsp.netobject.P2MPLSP(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer

sub_lsps (rw, LSPManager) disjoint_group (rw, string) disjoint_priority (rw, int, optional) source (rw, Node) name (rw, string)

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Port¶

class com.cisco.wae.opm.network.model.port.key.PortKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	node (ro, string) – name (ro, string) –

class com.cisco.wae.opm.network.model.port.manager.PortManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.port.netobject.Port(model, key)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

site (ro, Site) – Site containing the port
interface (rw, Interface) – Interface associated with the port
remote_port (ro, Port) – Remote port on opposite side of port circuit
port_circuit (ro, PortCircuit) – Port circuit connected to port
capacity (rw, float, optional) – Port capacity
mac_address (rw, string) – Port MAC address
description (rw, string) – Port description
protected (rw, bool) – Is this port protected
active (rw, bool) – Is this port active
netint_actor_port_index (rw, int, optional) –
netint_remote_port_index (rw, int, optional) –
l1_port (rw, L1Port) – L1 Port connected to this port
aggregation_port_mux_state (rw, int, optional) – The mux state of the aggregration port
netint_inventory_id (rw, int, optional) –
node (ro, Node) – The node that contains this port
name (ro, string) – Port name
measured_traffic (rw, float, optional) – Measured traffic on port

__init__(model, key)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Port Circuit¶

class com.cisco.wae.opm.network.model.port_circuit.key.PortCircuitKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	node_a (ro, string) – port_a (ro, string) – node_b (ro, string) – port_b (ro, string) –

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__hash__() <==> hash(x)¶

class com.cisco.wae.opm.network.model.port_circuit.manager.PortCircuitManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.port_circuit.netobject.PortCircuit(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

name (rw, string) – Port Circuit name
capacity (rw, float, optional) – Port Circuit capacity
description (rw, string) – Port Circuit description
protected (rw, bool) – Is this port circuit protected
active (rw, bool) – Is this port circuit active
l1_circuit (ro, L1Circuit) – L1 circuit mapped to this port circuit
port_a (ro, Port) – Port connected to this port circuit
port_b (ro, Port) – Port connected to this port circuit

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Queue¶

class com.cisco.wae.opm.network.model.queue.key.QueueKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.queue.manager.QueueManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.queue.netobject.Queue(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	interface_queues (rw, `InterfaceQueueManager`) – name (ro, string) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Report¶

class com.cisco.wae.opm.network.model.report.key.ReportKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.report.manager.ReportManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.report.netobject.Report(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	name (rw, string) – sections (rw, `ReportSections`) – Ordered mapping of sections in the report. text_sections (ro, list) – List of just the text sections. html_sections (ro, list) – List of just the HTML sections. table_sections (ro, list) – List of just the table sections.

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.model.report.netobject.ReportSections(report)¶

Bases: object

This object serves as a container for all the sections within a single report. The object behaves similarly to a NetworkObjectManager in that it implements both list and dict behaviors. While the container does support append(), extend(), and clear(), it does not support delete() or insert() operations. If the sections need to be reordered, the sections property of the parent report should be assigned a list of the sections in the desired order. When iterated, the object yields the report sections contained.

Variables:	report (ro, `Report`) – The report this section belongs to.

keys()¶

values()¶

items()¶

append()¶

extend()¶

clear()¶

index()¶

__init__(report)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.report.netobject.ReportSection(report, section)¶

Bases: object

A section can be instanciated using either: just a string, which will be the section title and content if it contains no newlines or just the content if it does contain newlines; an instance of one of the RPC report section record classes, or a dictionary where the keys are all optional and should be named like the section properties. When using a dict, the supported keys are section_type, title, creation_date, and content (for non-table sections only). Once the section_type is set, it cannot be changed. If the section type is not explicitly defined at initialization, the class will make a best guess at the section_type, most often this results in a text section.

Variables:

section_type (ro, str) – Either ‘text’, ‘HTML’, or ‘table’
index (ro, int) – The section’s position within the report.
title (rw, str) – The title of the section
creation_date (rw, str) –
content (rw, str) – Accessing this property on table sections will raise AttributeError
columns (ro, ReportSectionColumns) – Accessing this property on non-table sections will raise AttributeError
table_interactions (ro, ReportSectionInteractions) – Accessing this property on non-table sections will raise AttributeError
rows (ro, ReportSectionRows) – Accessing this property on non-table sections will raise AttributeError

copy()¶

__init__(report, section)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.report.netobject.TableSectionColumns(section)¶

Bases: object

Collection of columns for a report table section. Behaves like a list of ReportSectionColumn objects. The list can be added to, but cannot have elements removed, nor can they be reordered.

append()¶

extend()¶

index()¶

__init__(section)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.model.report.netobject.TableSectionColumn(section, record)¶

Bases: com.cisco.wae.opm.network.model.UserColumn

Variables:	name (rw, str) – display_name (rw, str) – column_type (rw, type) – Either None, bool, int, float, or str decimals (rw, int) – description (rw, str) – shown (rw, bool) – record (ro) –

__init__(section, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

class com.cisco.wae.opm.network.model.report.netobject.TableSectionInteractions(section)¶

Bases: object

List of TableInteraction objects.

append()¶

extend()¶

__init__(section)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

class com.cisco.wae.opm.network.model.report.netobject.TableSectionRows(section)¶

Bases: object

List of TableSectionRow objects that are the rows in a report table section. The list cannot be re-ordered and inserts before the end of the list are not supported.

append()¶

extend()¶

__weakref__¶: list of weak references to the object (if defined)

__init__(section)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

class com.cisco.wae.opm.network.model.report.netobject.TableSectionRow(section, record)¶

Bases: object

A row of data in a report table section table. The values in the row can be accessed either by the positional index (column order), or by their column name. Columns cannot be added or removed, only the values associated with each column can be changed.

Variables:	record (ro, list of str) –

append()¶

extend()¶

__weakref__¶: list of weak references to the object (if defined)

__init__(section, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

Segment List¶

class com.cisco.wae.opm.network.model.segment_list.key.SegmentListKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) – source (ro, string) –

class com.cisco.wae.opm.network.model.segment_list.manager.SegmentListManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.segment_list.netobject.SegmentList(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	hops (rw, `SegmentListHopManager`) – Segment List Hops for the Segment List name (rw, string) – Name of the Segment List source (rw, `Node`) – Source node for the Segment List

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Segment List Hop¶

class com.cisco.wae.opm.network.model.segment_list_hop.manager.SegmentListHopManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.segment_list_hop.record_object.SegmentListHop(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:

node (ro, Node, optional) – Segment List Hop Node
interface (ro, Interface, optional) – Segment List Hop Interface
anycast_group (ro, AnycastGroup, optional) – Segment List Hop Anycast Group
lsp (ro, LSP, optional) – Segment List Hop LSP
hop_type (ro, string) – Either ‘interface’, ‘node’, ‘anycast_group’ or ‘lsp’
hop (ro, Node or Interface or AnycastGroup or LSP) – Segment List Hop Object
sid (rw, int) – The SID for the hop
srv6_sid (rw, str) – The SRv6 SID for the hop

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Service Class¶

class com.cisco.wae.opm.network.model.service_class.key.ServiceClassKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.service_class.manager.ServiceClassManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.service_class.netobject.ServiceClass(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	queues (rw, `QueueManager`) – lsp_classes (ro, `LSPClassManager`) – name (ro, string) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

SID¶

class com.cisco.wae.opm.network.model.sid.manager.SIDManager(parent=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.RecordObjectManager

class com.cisco.wae.opm.network.model.sid.record_object.SID(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	id (ro, int) – Identifier type (ro, string) – Either ‘strict’, ‘regular’, ‘flex_algo’, ‘adj’ or ‘bgp_peer_adj’ protected (ro, bool) – Whether the sid is protected or not ipv6 (ro, bool) – Is this an IPv6 SID? sr_algorithm (ro, int) – SR Algorithm identifier

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Site¶

class com.cisco.wae.opm.network.model.site.key.SiteKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.site.manager.SiteManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.site.netobject.Site(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:

display_name (rw, string) – Site display name
location_code (rw, string) – Site location
longitude (rw, float, optional) – Site longitude
latitude (rw, float, optional) – Site latitude
active (rw, bool) – Is this Site active
protected (rw, bool) – Is this Site protected
nodes (ro, NodeManager) – Nodes contained by this Site
sub_sites (ro, SiteManager) – Sites contained by this Site
all_sub_sites (ro, SiteManager) – Sites contained by this Site and within subsites
all_nodes (ro, NodeManager) – Nodes contained by this Site and within subsites
l1_nodes (ro, L1NodeManager) – L1 Nodes contained by this Site
all_l1_nodes (ro, L1NodeManager) – L1 Nodes contained by this Site and within sibsites
parent_site (rw, Site, optional) – Parent Site
name (ro, string) – Site name

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

SRLG¶

class com.cisco.wae.opm.network.model.srlg.key.SRLGKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.srlg.manager.SRLGManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.srlg.netobject.SRLG(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.UserPropertyContainer, com.cisco.wae.opm.network.model.FailibleNetobject

Variables:	active (rw, bool) – description (rw, string) – nodes (rw, `NodeManager`) – circuits (rw, `CircuitManager`) – ports (rw, `PortManager`) – port_circuits (rw, `PortCircuitManager`) – external_endpoints (#) – l1_links (rw, `L1LinkManager`) – l1_nodes (rw, `L1NodeManager`) – name (rw, string) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Table Interaction¶

class com.cisco.wae.opm.network.model.table_interaction.record_object.TableInteraction(record=None, model=None)¶

Bases: com.cisco.wae.opm.network.model.RecordObject

Variables:	reference – reference_type – table_name – source_join_columns – destination_join_columns – object_column –

__init__(record=None, model=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Topology¶

class com.cisco.wae.opm.network.model.topology.key.TopologyKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.topology.manager.TopologyManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.topology.netobject.Topology(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	name (rw, string) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Traffic Level¶

class com.cisco.wae.opm.network.model.traffic_level.key.TrafficLevelKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.traffic_level.manager.TrafficLevelManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.traffic_level.netobject.TrafficLevel(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	name (rw, string) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

User Table¶

class com.cisco.wae.opm.network.model.user_table.key.UserTableKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) –

class com.cisco.wae.opm.network.model.user_table.manager.UserTableManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.user_table.netobject.UserTable(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject

Variables:	name (rw, string) – The name of the table columns (ro, `UserTableColumns`) – interactions (ro, `netobjectUserTableInteractions`) – rows (ro, `UserTableRows`) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.model.user_table.netobject.UserTableColumn(user_table, column_record)¶

Bases: com.cisco.wae.opm.network.model.UserColumn

Variables:	name (rw, string) – display_name (rw, string) – column_type (rw, type) – None, bool, int, float, or str decimals (rw, int) – Only relevant if column_type is float description (rw, string) – shown (rw, bool) – record (ro) –

__init__(user_table, column_record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

class com.cisco.wae.opm.network.model.user_table.netobject.UserTableRow(user_table, row, index)¶

Bases: object

keys(ro, list)¶: List of column names

values(ro, list)¶: Values for each column

items()¶

iterkeys()¶

itervalues()¶

iteritems()¶

__init__(user_table, row, index)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__ne__(other)¶: x.__ne__(y) <==> x!=y

__weakref__¶: list of weak references to the object (if defined)

VPN¶

class com.cisco.wae.opm.network.model.vpn.key.VPNKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	name (ro, string) – vpn_type (ro, string) –

class com.cisco.wae.opm.network.model.vpn.manager.VPNManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.vpn.netobject.VPN(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer, com.cisco.wae.opm.network.model.UserPropertyContainer

Variables:

name (ro, string) –
vpn_type (ro, string) –
connectivity (ro, string) –
service_class (rw, ServiceClass) –
nodes (rw, ManyToManyRelationship) –
demands (ro, DemandManager) –
worst_case_utilization (ro, float, optional) – Worst case utilization for the current traffic level
worst_case_simulations (ro, list, optional) – Simulation analsysis cases that result in a worst case
worst_case_failed_objects (ro, list, optional) – Model objects that when failed result in a worst case scenario
current_worst_case_simulations (ro, list, optional) – Simulation analysis cases for the current traffic level that result in the worst case
current_worst_case_failed_objects (ro, list, optional) – Model objects that when failed at the current traffic level result in a worst case scenario
interfaces (ro, list) – All the Interface objects this VPN is routed through

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

VPN Node¶

class com.cisco.wae.opm.network.model.vpn_node.key.VPNNodeKey(value, model=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObjectKey

Variables:	node (ro, string) – name (ro, string) – vpn_type (ro, string) –

class com.cisco.wae.opm.network.model.vpn_node.manager.VPNNodeManager(parent=None, rpc_getter=None, size_method=None, getall_method=None, getone_method=None, addone_method=None, addlist_method=None, hasone_method=None, delone_method=None, dellist_method=None, clear_method=None, objects=None)¶: Bases: com.cisco.wae.opm.network.model.NetworkObjectManager

class com.cisco.wae.opm.network.model.vpn_node.netobject.VPNNode(model=None, key=None, record=None)¶

Bases: com.cisco.wae.opm.network.model.NetworkObject, com.cisco.wae.opm.network.model.TagContainer

Variables:	node (ro, `Node`) – vpn (rw, `VPN`) – imported_route_targets (rw, list) – List of strings exported_route_targets (rw, list) – List of strings route_distinguisher (rw, string) – description (rw, string) – measured_source_traffic (rw, float, optional) – measured_destination_traffic (rw, float, optional) –

__init__(model=None, key=None, record=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Simulations¶

Route Simulations¶

class com.cisco.wae.opm.network.simulation.route.RouteSimulation(model, failures=None, expand_lsps_to_interfaces=True, compute_path_properties=True)¶

Bases: object

OPM API Wrapper to RPC API RouteSimulation

Parameters:

model (Model) –
failures (list, optional) – List of FallibleNetobject) objects. If None, then the model will be searched for any FallibleNetobjects that have their fail property set to True and use that list.
expand_lsps_to_interfaces (bool, optional) – default to False
compute_path_properties (bool, optional) – default to False

Variables:

compute_path_properties (rw, bool) – Whether or not routes should populate their calculated properties. Default True.
expand_lsps_to_interfaces (rw, bool) – Whether or not routes should populate their interface_utilization properties. Default True.
failures (rw, list) – List of FallibleNetobject) objects.
obsolete (ro, bool) – Whether the route need to be recalculated
routes (ro, RouteManager) –
rpc_failure_scenario (ro, com.cisco.wae.design.sim.FailureScenarioRecord) –
rpc_key (ro, com.cisco.wae.design.sim.RouteSimulationKey) –
rpc_plan (ro, com.cisco.wae.design.model.Plan) –
rpc_simulation (ro, com.cisco.wae.design.sim.RouteSimulation) –

__init__(model, failures=None, expand_lsps_to_interfaces=True, compute_path_properties=True)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__str__() <==> str(x)¶

__weakref__¶: list of weak references to the object (if defined)

recompute()¶: Recompute the route simulation.

shortest_path(source_node, destination_node, metric_type)¶

Find the shortest path between two nodes.

Parameters:	source_node (`Node`) – destination_node (`Node`) – metric_type (string) – Either ‘bgp’, ‘igp’, ‘te’, or ‘latency’
Returns:	(`Route`)

class com.cisco.wae.opm.network.simulation.route.manager.RouteManager(route_simulation)¶

Bases: _abcoll.Mapping

Container for the Routes in a RouteSimulation

The RouteManager class keeps track of the routes within a RouteSimulation. The object can be accessed directly like a read-only dict in order to access all the routes in the simulation. Each key is a Routable object in the model, and its corresponding value is the key’s Route in the simulation.

Parameters:

route_simulation (RouteSimulation) –

Variables:

demands (ro, list) – List of Demands routed in this RouteSimulation
lsps (ro, list) – List of LSPs routed in this RouteSimulation
lsp_paths (ro, list) – List of LSPPaths routed in this RouteSimulation
l1_circuits (ro, list) – List of L1Circuits routed in this RouteSimulation
l1_circuit_paths (ro, list) – List of L1CircuitPaths routed in this RouteSimulation

__init__(route_simulation)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__eq__(other)¶: x.__eq__(y) <==> x==y

__hash__() <==> hash(x)¶

__ne__(other)¶: x.__ne__(y) <==> x!=y

__repr__() <==> repr(x)¶

__str__() <==> str(x)¶

get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶

items() → list of D's (key, value) pairs, as 2-tuples¶

iteritems() → an iterator over the (key, value) items of D¶

iterkeys() → an iterator over the keys of D¶

itervalues() → an iterator over the values of D¶

keys() → list of D's keys¶

values() → list of D's values¶

class com.cisco.wae.opm.network.simulation.route.record.Route(route_simulation, record)¶

Bases: object

Data associated with a Route in a RouteSimulation.

Parameters:

route_simulation (RouteSimulation) –
record (com.cisco.wae.design.sim.RouteRecord) –

Variables:

minimum_ecmp_percentage (ro, float, optional) –
minimum_latency (ro, float, optional) –
average_latency (ro, float, optional) –
maximum_latency (ro, float, optional) –
total_path_metric (ro, float, optional) –
interfaces (ro, list) – List of Interfaces this Route passes through
lsps (ro, list) – List of LSPs this Route passes through
interface_usage (ro, InterfaceUsage) –
lsp_usage (ro, LSPUsage) –

__init__(route_simulation, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__str__() <==> str(x)¶

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.simulation.route.record.InterfaceUsage(route_simulation, record)¶

Bases: object

Map of Interfaces to that Interface’s proportion of traffic on the Route.

This object behaves like a read-only dict where the keys are the interfaces through which a route is routed. The associated values is the proportion of the traffic (as a float) for that Interface.

Parameters:	route_simulation (`RouteSimulation`) – record (`com.cisco.wae.design.sim.RouteRecord`) –

__init__(route_simulation, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.simulation.route.record.LSPUsage(route_simulation, record)¶

Bases: object

Map of LSPs to that LSP’s proportion of traffic on the Route.

This object behaves like a read-only dict where the keys are the LSPs through which a route is routed. The associated values is the proportion of the traffic (as a float) for that LSP.

Parameters:	route_simulation (`RouteSimulation`) – record (`com.cisco.wae.design.sim.RouteRecord`) –

__init__(route_simulation, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.simulation.route.record.L1Route(route_simulation, record)¶

Bases: object

Data associated with a Layer 1 Route in a Route Simulation.

Parameters:	route_simulation (`RouteSimulation`) – record (`com.cisco.wae.design.sim.L1RouteRecord`) –
Variables:	delay (ro, float, optional) – distance (ro, float, optional) – feasibility_metric (ro, float, optional) – central_frequency_id (ro, int, optional) – hops (ro, list) – List of `L1HopRecord` objects l1_circuit_path (ro, `L1CircuitPath`) –

__init__(route_simulation, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__str__() <==> str(x)¶

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.simulation.route.record.L1HopRecord(l1_route, record)¶

Bases: object

A hop along a layer 1 route in a route simulation.

Parameters:	l1_route (`L1Route`) – record (`com.cisco.wae.design.sim.L1HopRecord`) –
Variables:	l1_link (ro, `L1Link`) – central_frequency_id (ro, int, optional) –

__init__(l1_route, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

Traffic Simulations¶

class com.cisco.wae.opm.network.simulation.traffic.TrafficSimulation(parent, traffic_level=None, queue=None)¶

Bases: object

OPM API wrapper to an RPC API TrafficSimulation

Parameters:

parent (Model) –
traffic_level (TrafficLevel, optional) – If None, use the parent’s current_traffic_level.
queue (Queue, optional) – If None, use the parent’s current_queue.

Variables:

model (ro, Model) –
rpc_object (ro, com.cisco.wae.design.sim.TrafficSimulation) –
rpc_key (ro, com.cisco.wae.design.sim.TrafficSimulationKey) –
route_simulation (ro, RouteSimulation) –
traffic_level (ro, TrafficLevel) – The TrafficLevel used to generate the simulation
queue (ro, Queue) – The Queue used to generate the simulation
lsps (ro, com.cisco.wae.opm.network.simulation.traffic.lsp.LSPManager) – Map of LSPs to their simulated data.
interfaces (ro, com.cisco.wae.opm.network.simulation.traffic.interface.InterfaceManager) – Map of Interfaces to their simulated data.

__init__(parent, traffic_level=None, queue=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.simulation.traffic.interface.InterfaceManager(traffic_simulation)¶

Bases: object

Read-only map of Interface objects to com.cisco.wae.opm.network.simulation.traffic.interface.Interface objects.

Parameters:	traffic_simulation (`TrafficSimulation`) –

__init__(traffic_simulation)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.simulation.traffic.interface.Interface(simulation, record)¶

Bases: object

Simulated traffic data for an Interface

Parameters:	simulation (`TrafficSimulation`) – record (`com.cisco.wae.design.sim.InterfaceSimulatedTrafficRecord`) –
Variables:	interface (ro, `Interface`) – traffic (ro, float) – utilization (ro, float, optional) – capacity (ro, float, optional) –

__init__(simulation, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.simulation.traffic.lsp.LSPManager(traffic_simulation)¶

Bases: object

Read-only map of LSP objects to com.cisco.wae.opm.network.simulation.traffic.lsp.LSP objects.

Parameters:	traffic_simulation (`TrafficSimulation`) –

__init__(traffic_simulation)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.simulation.traffic.lsp.LSP(simulation, record)¶

Bases: object

Simulated traffic data for an LSP

Parameters:	simulation (`TrafficSimulation`) – record (`com.cisco.wae.design.sim.LSPSimulatedTrafficRecord`) –
Variables:	lsp (ro, `LSP`) – traffic (ro, float) – setup_bandwidth (ro, float) – setup_priority (ro, int, optional) – hold_priority (ro, int, optional) –

__init__(simulation, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

Traffic¶

Demand Traffic¶

class com.cisco.wae.opm.network.traffic.demand.DemandTraffic(model)¶

Bases: object

Container for Traffic and Growth Percent values for Demands in the Model.

This container acts like a Mapping object, in that the keys cannot be changed, but the values can. Each key is a Demand in the model. Each value is a tuple of the Demand’s (traffic, growth_percent). Both values are optional floats. The traffic and growth values can be retrieved, set, and unset independantly using the public helper methods.

__init__(model)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__hash__() <==> hash(x)¶

get_traffic(identifier)¶

Return the traffic value for a specific Demand.

Parameters:	identifier – Some value that can uniquely identify a Demand in the Model.
Returns:	The amount of traffic on the Demand.
Return type:	(float or None)

get_growth_percent(identifier)¶

Return the growth percent value for a specific Demand.

Parameters:	identifier – Some value that can uniquely identify a Demand in the Model.

Return: (float or None): The growth percentage of the Demand.

set_traffic(identifier, value)¶

(Un)set the traffic value for a specific Demand.

Parameters:	identifier – Some value that can uniquely identify a Demand in the Model. value (float or None) – The new traffic value for the Demand or None to unset it altogether.

set_growth_percent(identifier, value)¶

(Un)set the growth percent for a specific Demand.

Parameters:	identifier – Some value that can uniquely identify a Demand in the Model. value (float or None) – The new growth percent for the Demand or None to unset it altogether.

__weakref__¶: list of weak references to the object (if defined)

Measured Traffic¶

class com.cisco.wae.opm.network.traffic.measured.MeasuredTraffic(model)¶

Bases: object

Parameters:	model (`Model`) –
Variables:	rpc_measured_traffic_manager (ro, `MeasuredTrafficManager`) – interfaces (ro, `MeasuredInterfaceTraffic`) – lsps (ro, `MeasuredLSPTraffic`) – nodes (ro, `MeasuredNodeTraffic`) – ports (ro, `MeasuredPortTraffic`) – vpn_nodes (ro, `MeasuredVPNNodeTraffic`) –

__init__(model)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__hash__() <==> hash(x)¶

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.traffic.measured.abstract.NetobjectTrafficManager(traffic_manager)¶

Bases: object

NetobjectTrafficManagers work like mappings where the key is the netobject and the value is a wrapper to the measured traffic record.

Parameters:	traffic_manager (`MeasuredTraffic`) –

__init__(traffic_manager)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__hash__() <==> hash(x)¶

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.traffic.measured.interfaces.MeasuredInterfaceTraffic(measured_traffic_manager)¶

Bases: com.cisco.wae.opm.network.traffic.measured.abstract.NetobjectTrafficManager

Parameters:	measured_traffic_manager –

get_traffic()¶: Get the measured traffic amount for a given interface

set_traffic()¶: Set the measured traffic amount for a given interface

unset_traffic()¶: Mark the measured traffic amount for a given interface as undefined

get_growth_percent()¶: Get the growth rate of traffic for a given interface

set_growth_percent()¶: Set the growth rate of traffic for a given interface

unset_growth_percent()¶: Mark the growth rate of traffic for a given interface as undefined

get_utilization()¶: Get the utilization amount for a given interface

get_qos_bound()¶: Get the quality of service boundary for a given interface

__init__(measured_traffic_manager)¶: x.__init__(…) initializes x; see help(type(x)) for signature

get_traffic(identifier)

Get the measured traffic amount for a given interface

Parameters:	identifier – Some value that uniquely identifies an interface
Returns:	The amount of measured traffic on the identified interface
Return type:	(float)

set_traffic(identifier, value)

Set the measured traffic amount for a given interface

Parameters:	identifier – Some value that uniquely identifies an interface value (float, optional) – The value to set the measured traffic to. If None, then unsets.

unset_traffic(identifier)

Mark the measured traffic amount for a given interface as undefined

Parameters:	identifier – Some value that uniquely identifies an interface

get_growth_percent(identifier)

Get the growth rate of traffic for a given interface

Parameters:	identifier – Some value that uniquely identifies an interface
Returns:	The growth rate (as a percentage) for the interface
Return type:	(float)

set_growth_percent(identifier, value)

Get the growth rate of traffic for a given interface

Parameters:	identifier – Some value that uniquely identifies an interface value (float, optional) – The value to set the measured traffic to. If None, then it unsets.

unset_growth_percent(identifier)

Mark the growth rate of traffic for a given interface as undefined

Parameters:	identifier – Some value that uniquely identifies an interface

get_utilization(identifier)

Get the utilization amount for a given interface

Parameters:	identifier – Some value that uniquely identifies an interface

get_qos_bound(identifier)

Get the quality of service boundary for a given interface

Parameters:	identifier – Some value that uniquely identifies an interface

class com.cisco.wae.opm.network.traffic.measured.lsps.MeasuredLSPTraffic(measured_traffic_manager)¶

Bases: com.cisco.wae.opm.network.traffic.measured.abstract.NetobjectTrafficManager

__init__(measured_traffic_manager)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.traffic.measured.nodes.MeasuredNodeTraffic(measured_traffic_manager)¶

Bases: com.cisco.wae.opm.network.traffic.measured.abstract.NetobjectTrafficManager

Parameters:	measured_traffic_manager –

get_ingress()¶: Get the measured ingress traffic amount for a Node

set_ingress()¶: Set the measured ingress traffic amount for a Node

unset_ingress()¶: Mark the measured ingress traffic amount for a Node as undefined

get_egress()¶: Get the measured egress traffic amount for a Node

set_egress()¶: Set the measured egress traffic amount for a Node

unset_egress()¶: Mark the measured egress traffic amount for a Node as undefined

__init__(measured_traffic_manager)¶: x.__init__(…) initializes x; see help(type(x)) for signature

get_ingress(identifier)

Get the measured ingress traffic amount for a Node

Parameters:	identifier – Some value that uniquely identifies an node
Returns:	The measured amount of ingress traffic on the node
Return type:	(float)

set_ingress(identifier, value)

Set the measured ingress traffic amount for a Node

Parameters:	identifier – Some value that uniquely identifies an node value (float, optional) – The amount to set the traffic to

unset_ingress(identifier)

Mark the measured ingress traffic amount for a Node as undefined

Parameters:	identifier – Some value that uniquely identifies an node

get_egress(identifier)

Get the measured egress traffic amount for a Node

Parameters:	identifier – Some value that uniquely identifies an node
Returns:	The measured amount of egress traffic on the node
Return type:	(float)

set_egress(identifier, value)

Set the measured egress traffic amount for a Node

Parameters:	identifier – Some value that uniquely identifies an node value (float, optional) – The amount to set the traffic to

unset_egress(identifier)

Mark the measured egress traffic amount for a Node as undefined

Parameters:	identifier – Some value that uniquely identifies an node

class com.cisco.wae.opm.network.traffic.measured.ports.MeasuredPortTraffic(measured_traffic_manager)¶

Bases: com.cisco.wae.opm.network.traffic.measured.abstract.NetobjectTrafficManager

__init__(measured_traffic_manager)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Tools¶

SimulationAnalysis¶

class com.cisco.wae.opm.network.tools.simulation_analysis.SimulationAnalysis(model, allow_rebuild=True, failure_types=None, traffic_levels=None, record_fail_boundary=0, max_fail_per_int=10, calculate_worst_case_demand_latencies=True, calculate_worst_case_vpn_latencies=True, num_threads=None)¶

Bases: object

OPM API wrapper to RPC API SimulationAnalysis tool

Parameters:

model (Model) –
allow_rebuild (bool, optional) – Whether or not the simulation analysis should be re-run if changes are made to the model and if the simulation properties can be changed once this object is constructed. In other words, whether or not the simulation analysis is locked once initialized. Default is True.
failure_types (list, optional) – List of failure types to consider during the analysis. If None is passed, the default value will be used, which is all the failure types. Each element of the list can be either one of the elements of the RPC enumeration SAFailureType or a string in the set (nodes, sites, circuits, ports, portcircuits, srlgs, l1_nodes, l1_ports, l1_links, external_endpoint_members, parallel_circuits).
traffic_levels (list, optional) – List of traffic levels in the model to consider when running simulations. If None is passed, the default value will be used, which is all the traffic levels in the model. Each element can be any value that uniquely identifies a traffic level from the model.
record_fail_boundary (int, optional) – Record failures causing interface utilizations within this percent of worst case utilization. Default is 0.
max_fail_per_int (int, optional) – Maximum number of failure scenarios per interface. Default is 10.
calculate_worst_case_demand_latencies (bool, optional) – Calculate the worst case latencies for each demand and the failures that cause them. Default is True.
calculate_worst_case_vpn_latencies (bool, optional) – Calculate the worst case latencies for each VPN and the failures that cause them. Default is True.

Variables:

model (ro, Model) –
allow_rebuild (rw, bool) –
cache_valid (rw, bool) – Whether or not the current simulation analysis if valid. An analysis can be invalid if the model has been changed or if the analysis properties have been changed. Also, the cache can be invalidated manually by setting this property to False. Manually setting this value to true wil re-run the analysis if needed, unless the allow_rebuild property is set to False. This value may return a false positive after the object’s initialization if the model had a saved analysis that didn’t match the model or if the model has been changed through the RPC interface.
failure_types (rw, list) –
traffic_levels (rw, list) –
record_fail_boundary (rw, int) –
max_fail_per_int (rw, int) –
calculate_worst_case_demand_latencies (rw, bool) –
calculate_worst_case_vpn_latencies (rw, bool) –
simulations (ro, SimulationManager) –
interfaces (ro, InterfaceManager) –
vpns (ro, VPNManager) –
l1_nodes (ro, L1NodeManager) –
l1_links (ro, L1LinkManager) –
demands (ro, DemandManager) –
interface_failure_impacts (ro, InterfaceFailureImpactManager) –
rpc_simulation_analysis_tool (ro com.cisco.wae.design.tools.SimAnalysis) – The RPC layer SimulationAnalysis tool instance being wrapped.
rpc_options (ro, com.cisco.wae.design.tools.SimAnalysisOptions) – The RPC layer SimAnalysisOptions record that represents this object’s current settings

__init__(model, allow_rebuild=True, failure_types=None, traffic_levels=None, record_fail_boundary=0, max_fail_per_int=10, calculate_worst_case_demand_latencies=True, calculate_worst_case_vpn_latencies=True, num_threads=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractManager(sa)¶

Bases: object

Generic functionality for SimulationAnalysis member collections.

Managers work like read-only mapping objects. That is, when indexed with a model object, it will return the simulation object that manages the properties for that model object. AbstractManager supports the in and [] operators and the keys, values, and items methods.

Variables:	cache_valid (rw, bool) – Setting to True will reload the records from the RPC object. Setting to False will empty out the cached records. model (ro, `Model`) –

__init__(sa)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractObject(manager, impacted_object)¶

Bases: object

Generic functionality for objects that collect the simulation analysis records for a particular model object.

Parameters:

manager (AbstractManager) –
impacted_object (NetworkObject) –

Variables:

impacted_object (ro, NetworkObject) –
worst_case_simulations (ro, list, optional) – List of (AbstractRecord) objects that represent cases that impact this object’s imacted_object. The members are sorted so that the most impactful simulations are first. So, the first element, if there are any, is always the very worst case for this object regardless of traffic level or service class. Will be None when there is no traffic on the model object.
worst_case_objects (ro, list, optional) – List of com.cisco.wae.opm.network.model.FailibleNetobject objects. Each element is the failed object from the worst_case_simulations object of the same element.
current_worst_case_simulations (ro, list, optional) – List of AbstractRecord objects that are all the worst case for the model object represented for the model’s current_traffic_level. Will be None if the object’s simulation_cases property is also None.
current_worst_case_failed_objects (ro, list, optional) – List of com.cisco.wae.opm.network.model.FailibleNetobject objects. Each element is the failed object from the current_worst_case_simulation object of the same element.

__init__(manager, impacted_object)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractRecord(ao, record)¶

Bases: object

Generic functionality for an OPM API wrapper for a RPC API SimulationAnalysis record.

Parameters:	ao (`AbstractObject`) – record (RPC API SimAnalysis WC record) –
Variables:	impacted_object (ro, `NetworkObject`) – rpc_record (ro, RPC WC record) – simulation (ro, `Simulation`) – The failure scenario that causes the results for this record. traffic_level (ro, `TrafficLevel`) – The traffic level of the scenario. service_class (ro, `ServiceClass`) – The service class of the scenario.

__init__(ao, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.tools.simulation_analysis.simulation.SimulationManager(sa)¶

Bases: object

Read-only mapping collection of Simulation objects.

Each Simulation is uniquely identified by a failed object, a traffic level (which might be None), and a service class (which might be None). Key values can be represented with an encoded string, a dict, a list, a tuple, a Simulation instance, or an RPC SimulationRecord.

Parameters:	sa (`SimulationAnalysis`) –

__init__(sa)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.tools.simulation_analysis.simulation.Simulation(manager, rpc_record)¶

Bases: object

Parameters:

manager (SimulationManager) –
rpc_record (com.cisco.wae.design.tools.SimulationRecord) –

Variables:

key (ro, string) – Encoded string value that can serve as a key value for this Simulation
model (ro, Model) –
traffic_level (ro, traffic_level, optional) –
service_class (ro, service_class, optional) –
failed_object (ro, FailibleNetobject, optional) –
breakpoint (ro, string, optional) –
number_of_unrouted_demands (ro, int, optional) –
unrouted_traffic (ro, float, optional) –
maximum_utilization (ro, float, optional) –
max_qos_bound_pcent (ro, float, optional) –
number_of_qos_violations (ro, int, optional) –
number_of_latency_bound_violations (ro, int, optional) –
number_of_unrouted_lsps (ro, int, optional) –
number_of_unrouted_frr_lsps (ro, int, optional) –
number_of_unrouted_l1_circuits (ro, int, optional) –

__init__(manager, rpc_record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

__weakref__¶: list of weak references to the object (if defined)

class com.cisco.wae.opm.network.tools.simulation_analysis.interface.InterfaceManager(sa)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractManager

__init__(sa)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.interface.Interface(manager, interface)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractObject

Variables:	worst_case_traffic (ro, float, optional) – Worst case traffic for the model’s current traffic level. worst_case_utilization (ro, float, optional) – Worst case utilization for the model’s current traffic level.

__init__(manager, interface)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.interface.InterfaceWorstCase(interface, record)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractRecord

Variables:	worst_case_traffic (ro, float, optional) – worst_case_utilization (ro, float, optional) – worst_case_qos_boundary (ro, float, optional) – diff_wc_qos_bound (ro, float, optional) – diff_wc_qos_bound_pcent (ro, float, optional) – simulated_capacity (ro, float, optional) – service_capacity (ro, float, optional) –

__init__(interface, record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.demand.DemandManager(sa)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractManager

__init__(sa)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.demand.Demand(manager, demand)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractObject

Variables:	worst_case_latency (ro, float, optional) – The worst case latency for the model’s current traffic level.

__init__(manager, demand)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.demand.DemandWorstCase(demand, rpc_record)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractRecord

Variables:	worst_case_latency (ro, float) – The worst case latency for this simulation.

__init__(demand, rpc_record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.l1_link.L1LinkManager(sa)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractManager

__init__(sa)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.l1_link.L1Link(manager, l1_link)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractObject

Variables:	worst_case_utilization (ro, float, optional) – Worst case utilization for the model’s current traffic level.

__init__(manager, l1_link)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.l1_link.L1LinkWorstCase(l1_link, rpc_record)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractRecord

Variables:	worst_case_utilization (ro, float, optional) – number_l1_circuit_paths (ro, int, optional) –

__init__(l1_link, rpc_record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.failure_impact.InterfaceFailureImpactManager(sa)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractManager

__init__(sa)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.failure_impact.InterfaceFailureImpact(manager, interface)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractObject

__init__(manager, interface)¶: x.__init__(…) initializes x; see help(type(x)) for signature

class com.cisco.wae.opm.network.tools.simulation_analysis.failure_impact.FailureImpactRecord(interface_failure_impact, rpc_record)¶

Bases: com.cisco.wae.opm.network.tools.simulation_analysis.abstract.AbstractRecord

Variables:	qos_violation_percent (ro, float, optional) – usage (ro, float, optional) – simulated_capacity (ro, float, optional) – service_capacity (ro, float, optional) – potential_capacity (ro, float, optional) – no_failure_effective_capacity (ro, float, optional) –

__init__(interface_failure_impact, rpc_record)¶: x.__init__(…) initializes x; see help(type(x)) for signature

Object Model¶

Network¶

Model Abstraction Layer¶

Model¶

Actual Layer 1 Circuit Path¶

Actual Layer 1 Circuit Path Hop¶

Actual Path¶

Actual Path Hop¶

Anycast Group¶

Autonomous System¶

Central Frequency ID Excludelist¶

Circuit¶

Demand¶

Demand Endpoint¶

External Endpoint¶

External Endpoint Member¶

Flex Algorithm¶

Flow¶

IGP Protocol¶

Interface¶

Interface Queue¶

Layer 1 Circuit¶

Layer 1 Circuit Path¶

Layer 1 Circuit Path Hop¶

Layer 1 Diversity¶

Layer 1 Link¶

Layer 1 Link Waypoint¶

Layer 1 Node¶

Layer 1 Port¶

Layer 3 Layer 1 Link¶

LSP¶

LSP Class¶

LSP Path¶

Multicast Flow¶

Multicast Flow Hop¶

Multicast Flow External Hop¶

Multicast Flow Destination¶

Named Path¶

Named Path Hop¶

NetInt Table¶

Node¶

Node Group¶

Point-to-Multipoint LSP¶

Port¶

Port Circuit¶

Queue¶

Report¶

Segment List¶

Segment List Hop¶

Service Class¶

SID¶

Site¶

SRLG¶

Table Interaction¶

Topology¶

Traffic Level¶

User Table¶

VPN¶

VPN Node¶

Simulations¶

Route Simulations¶

Traffic Simulations¶

Traffic¶

Demand Traffic¶

Measured Traffic¶

Tools¶

SimulationAnalysis¶

Action¶