Available Languages

Updated:August 5, 2024

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Cisco EPN Manager (EPNM) Adapter

General Information

The Cisco EPNM adapter is an adapter that supports:

· Optical: The Routed Optical Network (RON) use case, with layer 0 and L1 (OTN/ETH) network inventory and topology discovery of NCS2K as a ROADM.

· IP: The discovery of inventory, physical and logical topology, IGP-ISIS, and L2 VPN services.

· In all of the above, the adapter uses the raw data received from the EPNM through REST APIs to perform various operations.

APIs Used

The following list comprises APIs utilized by the Cisco EPNM adapter.

Table 1. Endpoint Discovery APIs and Provisioning Overview for the Cisco EPNM Adapter

Endpoint	Additional Information
/restconf/data/v1/cisco-resource-physical:node	equipment, cards, ports, physical-nodes
/restconf/data/v1/cisco-resource-network:topological-link?topo-layer=isis-layer&forkJoin=false	topological-links-isis-layer
/restconf/data/v1/cisco-resource-network:topological-link?topo-layer=physical-link-layer	topological-links-physical-layer
/restconf/data/v1/cisco-resource-network:topological-link?forkJoin=false	topological-links-layer
/restconf/data/v1/cisco-resource-ems:termination-point	termination-points
/webacs/api/v1/data/SegmentRoutingPrefixSidMapping?.full=true	sr-prefix-sids
/restconf/data/v1/cisco-service-network:virtual-connection?type=carrier-ethernet-vpn	vc-ce-vpns
/restconf/data/v1/cisco-resource-network:topological-link?topo-layer=pw-layer	topological-links-pw-layer
/webacs/api/v1/data/ServiceDetails.json?.full=false&technology=Optical	service-details-dto
/webacs/api/v2/op/multilayer/structure.json	service-vc-structure-dto
/webacs/api/v1/data/TopologyLink?.full=true&linkTypeEnum=eq(%22OMS%22)	oms-links-dto
/webacs/api/v1/op/optical/link/oms/{node_fdn_or_ip}/ots	ots-links-list
/restconf/data/v1/cisco-service-network:virtual-connection?type=optical	optical-virtual-connection
/restconf/data/v1/cisco-resource-network:shared-risk-resource-group	srrg-attributes-list

Version Support

The following table lists the tested devices, and their versions supported on the Cisco EPNM adapter.

Table 2. Versions Supported by the Cisco EPNM Adapter

EPNM

Tested Devices

Device Version

6.1 and 7.1

Cisco NCS 1, 2, 4K

6.1 and 7.1

ASR 903

ASR 907

ASR 920

ASR 1002

ASR 9001

ASR 9006

ASR 9010

ASR 9904

ASR 9906

ASR 9910

17.3.3, 17.3.5

17.3.3

15.5(3)S4b

6.4.2, 6.7.3

6.4.2

6.4.2, 6.7.3

6.4.2

6.4.2, 6.7.3, 7.5.2

Table 3. Network Discovery Details for the Cisco EPNM Adapter

Discovery and Visualization

Inventory

IP and Optical

Topology

Optical

Topology

Services

PMs

Devices, Chassis, Cards, Pluggables, Physical Ports, Fans, PSUs, IGP Devices.

OTS, OMS, MC NMC, OCH, OTU, ODU Links between ROADMs and Amplifiers.

Router Physical, Router Logical, IGP IS-IS, L2VPN.

L2VPN (Packet E-Lines: TLDP).

PM counters on physical interfaces.

Discovery Optical

Inventory

Table 4. Inventory Item Attributes and Accessibility Details for the Cisco EPNM Adapter

Attribute	ONE	Card	Port	Shelf	Mux	Backplane	Unclassified	Comments
access_identifier	Yes	Yes	Yes	Yes	Yes	Yes	Yes
card_status	No	Yes	No	No	No	No	No
card_type	No	Yes	No	No	No	No	No
children	Yes	Yes	Yes	Yes	Yes	Yes	Yes
children_ports	No	Yes	Yes	Yes	Yes	Yes	Yes
desc	Yes	Yes	Yes	Yes	Yes	Yes	Yes
device	No	Yes	Yes	Yes	Yes	Yes	Yes
device_family	Yes	No	No	No	No	No	No
device_type	Yes	No	No	No	No	No	No
equip_state	No	No	No	No	No	No	No
extra	Yes	Yes	Yes	Yes	Yes	Yes	Yes
form_factor	No	No	Yes	No	No	No	No
guid	Yes	Yes	Yes	Yes	Yes	Yes	Yes
has_roadm	Yes	No	No	No	No	No	No
management_ip	Yes	No	No	No	No	No	No
model_number	Yes	Yes	Yes	Yes	Yes	Yes	Yes
name	Yes	Yes	Yes	Yes	Yes	Yes	Yes
oui	No	No	Yes	No	No	No	No
parent	Yes	Yes	Yes	Yes	Yes	Yes	Yes
part_number	Yes	Yes	Yes	Yes	Yes	Yes	Yes
pluggability	No	No	Yes	No	No	No	No
ports	Yes	No	No	No	No	No	No	For ONE, yes if no parent card identified for port
provider	Yes	Yes	Yes	Yes	Yes	Yes	Yes
reachability_status	Yes	No	No	No	No	No	No
serial_number	Yes	Yes	Yes	Yes	Yes	Yes	Yes
site	Yes	No	Yes	Yes	Yes	Yes	Yes
software_version	Yes	No	No	No	No	No	No
srlgs	Yes	Yes	No	No	No	No	No
supported_lambdas	No	No	Yes	No	No	No	No
supported_physical_layers	No	Yes	Yes	No	No	No	No
supported_reacability_meters	No	Yes	Yes	No	No	No	No
supported_speeds	No	Yes	Yes	No	No	No	No
tags	Yes	Yes	Yes	No	No	No	No
topology_id	Yes	No	No	No	No	No	No
tunable_type	No	Yes	Yes	No	No	No	No
tuned_lambda	No	Yes	Yes	No	No	No	No
type	Yes	No	Yes	Yes	Yes	Yes	Yes
vendor	Yes	No	Yes	Yes	Yes	Yes	Yes

Ports

Table 5. Port Item Attributes and Accessibility Details for the Cisco EPNM Adapter

Attribute	OTS	OMS	MC	OCH	OTU	ODU	OpticalClient	ETH	Comments
adjacency	No	No	No	No	No	No	No	No
admin_groups	No	No	No	No	No	No	No	No
admin_status	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
child_role	No	No	No	No	No	No	No	No
containing_service	No	No	No	Yes	No	No	No	No
desc	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
device	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
expected_transmit_power_range	No	No	No	No	No	No	No	No
extra	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	FDN
guid	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
has_service_end_point_capability	No	No	No	No	No	No	No	No
if_index	No	No	No	No	No	No	No	No
links	No	No	No	No	No	No	No	No
lower_ports	No	Yes	Yes	Yes	Yes	Yes	Yes	Yes
name	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
oper_status	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
parent	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
provider	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
selected_spectrum	No	No	No	No	No	No	No	No	Filled with None
span_loss	Yes	Yes	No	No	Yes	No	No	No
supported_spectrums	No	No	No	No	No	No	No	No
srlgs	No	No	No	No	No	No	No	No
tags	No	No	No	No	No	Yes	No	No
upper_ports	Yes	Yes	Yes	Yes	Yes	Yes	No	No
port_capibilities	No	No	No	No	No	No	Yes	Yes	Filled with None

Links

Table 6. Link Item Attributes and Accessibility Details for the Cisco EPNM Adapter

Attribute	OTS	OMS	MC	NMC	OCH	OTU	ODU	ETH	Comments
active_protection_priority	No	No	No	No	No	No	No	No
desc	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
distance_meters	Yes	No	No	No	No	No	No	No
extra	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	FDN
guid	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
inverse_link_id	No	No	Yes	Yes	Yes	Yes	Yes	Yes
is_bidi	Yes	Yes	No	No	No	No	No	No
latency_micros	No	No	Yes	Yes	Yes	Yes	Yes	Yes
name	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
oper_status	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
path_group_type	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
paths	No	Yes	Yes	Yes	Yes	Yes	Yes	Yes
port_a	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
port_b	Yes	Yes	No	No	No	No	No	No
protection_status	No	No	Yes	Yes	Yes	Yes	Yes	Yes
provider	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
role	Yes	Yes	No	No	No	No	No	No
srlgs	No	Yes	No	No	No	No	No	No
tags	No	No	No	No	No	No	No	No
used_by_hops	No	No	No	No	No	No	No	No

Discovery IP

IP Inventory

Table 7 IP Inventory Item Attributes and Accessibility Details for the Cisco EPNM Adapter

Attribute	Card	Fan	IGP	Port	Power Supply	Router	Comments
access_identifier	Yes	Yes	Yes	Yes	Yes	No
card_status	Yes	No	No	No	No	No
card_type	Yes	No	No	No	No	No
children	Yes	No	No	No	No	Yes
children_ports	No	No	No	No	No	No
desc	Yes	Yes	No	Yes	Yes	Yes
device	Yes	Yes	No	Yes	Yes	No
device_family	No	No	Yes	No	No	Yes
device_type	No	No	No	No	No	Yes
domain_name	No	No	Yes	No	No	No
equip_state	No	No	No	Yes	No	No
extra	Yes	Yes	No	Yes	Yes	Yes	FDN
form_factor	No	No	No	No	No	No
guid	Yes	Yes	Yes	Yes	Yes	Yes
igp_type	No	No	Yes	No	No	No
isis_info	No	No	Yes	No	No	No
management_ip	No	No	No	No	No	Yes
model_number	No	No	No	Yes	Yes	Yes
name	Yes	Yes	Yes	Yes	Yes	Yes
oui	No	No	No	No	No	Yes
parent	Yes	Yes	Yes	Yes	Yes	No
part_number	Yes	Yes	No	Yes	Yes	No
pluggability	No	No	No	Yes	No	Yes
ports	No	No	No	No	No	No	Ports on the router appear as children.
provider	Yes	Yes	Yes	Yes	Yes	Yes
reachability_status	No	No	Yes	No	No	Yes
router_id	No	No	Yes	No	No	Yes
serial_number	Yes	Yes	No	Yes	Yes	Yes
site	No	No	No	No	No	Yes
software_version	No	No	No	No	No	Yes
sr_capabilities	No	No	Yes	No	No	No
srlgs	Yes	No	No	No	No	Yes
supported_lambdas	No	No	No	No	No	No
supported_physical_layers	No	No	No	No	No	No
supported_reacability_meters	No	No	No	No	No	No
supported_speeds	No	No	No	No	No	No
tags	No	No	No	No	No	Yes
topology_id	No	No	No	No	No	No
tunable_type	No	No	No	No	No	No
tuned_lambda	No	No	No	No	No	No
type						Yes
vendor	Yes	Yes	No	Yes	Yes	Yes

IP Ports

Table 7. IP Port Item Attributes and Accessibility Details for the Cisco EPNM Adapter

Attribute	IGP	RAggregate	RLogical	RPhysical	Uni	VirtualUni	Comments
adjacency	No	No	No	No	No	No
admin_groups	No	No	No	No	No	No
admin_status	No	Yes	Yes	Yes	Yes	Yes
child_role	No	No	No	No	No	No
containing_service	No	No	No	No	Yes	No	v
Desc	No	Yes	Yes	Yes	Yes	Yes
Device	Yes	Yes	Yes	Yes	Yes	Yes
egress_bandwidth_profile	No	No	No	No	Yes	No	Uni: If available
eline_specific	No	No	No	No	Yes	Yes	Uni/VirtualUni: For E-Line service ports
eth_port_type	No	No	No	Yes	No	No
Extra	No	Yes	Yes	Yes	No	No	RAggregate: fdn RPhysical: component_id, fdn, parent_component_id, model_sources
Guid	Yes	Yes	Yes	Yes	Yes	Yes
has_service_end_point_capability	No	No	No	No	Yes	No
if_index	No	No	No	Yes	No	No
igp_instance_name	No	No	No	No	No	No
igp_metric	Yes	No	No	No	No	No
ingress_bandwidth_profile	No	No	No	No	No	No
ip_address	Yes	No	No	No	No	No
is_all_to_one_bundling	No	No	No	No	Yes	No	Uni: Set to true if no VirtualUni port on top of the Uni
is_loopback	No	No	Yes	No	No	No
is_management	No	No	No	No	No	No
is_router_id	No	No	No	No	No	No
is_stats_dummy	No	No	No	No	No	No
isis_info	Yes	No	No	No	No	No
l_2_vpn_specific	No	No	No	No	No	No
l_3_vpn_specific	No	No	No	No	No	No
Links	No	No	No	No	No	No
lower_ports	No	Yes	Yes	No	Yes	Yes
mapped_ce_tags	No	No	No	No	No	Yes
max_link_bandwidth	No	No	No	No	No	No
max_reservable_link_bandwidth	No	No	No	No	No	Yes
mtu_size	No	No	No	No	Yes	Yes
name	Yes	Yes	Yes	Yes	Yes	Yes
non_primary_ips	No	No	Yes	No	No	No
oper_status	Yes	Yes	Yes	Yes	Yes	Yes
ospf_info	No	No	No	No	No	No
parent	Yes	Yes	Yes	Yes	Yes	Yes
physical_address	No	Yes	No	Yes	No	No
primary_ip	No	No	Yes	No	No	No
provider	Yes	Yes	Yes	Yes	Yes	Yes
rsvp_reserved_bandwidth_bps	No	No	Yes	No	No	No	Filled with None
rsvp_static_bandwidth_bps	No	No	Yes	No	No	No	Filled with None
speed_bps	No	No	No	Yes	No	No
sr_prefix_sids	Yes	No	No	No	No	No
srlgs	No	No	No	No	No	No
Tags	No	No	No	No	No	No
te_metric	Yes	No	No	No	No	No
unnumbered_interface_id	No	No	No	No	No	No
unreserved_link_bw_for_priority_index	No	No	No	No	No	No
upper_ports	No	Yes	No	Yes	No	No
vlan	No	No	Yes	No	No	No	Filled with None

IP Links

Table 8. IP Link Item Attributes and Accessibility Details for the Cisco EPNM Adapter

Attribute	E-Line	IGP	PseudoWire	RAggregate	RLogical	RPhysical	Comments
active_protection_priority	No	No	No	No	No	No
desc	Yes	No	No	No	No	No
distance_meters	No	No	No	No	No	No
evc_performance_profile	No	No	No	No	No	No
evpn_instance	No	No	No	No	No	No
extra	No	No	No	Yes	Yes	Yes	Fdn
guid	Yes	Yes	Yes	Yes	Yes	Yes
is_bidi	Yes	Yes	Yes	Yes	Yes	Yes
is_ce_vlan_cos_preservation	No	No	No	No	No	No
latency_micros	No	No	No	No	No	No
mapping_status	No	No	No	No	No	Yes
name	Yes	Yes	Yes	No	Yes	No
oper_status	Yes	Yes	Yes	Yes	Yes	Yes
path_group_type	Yes	Yes	Yes	Yes	Yes	Yes
paths	Yes	No	No	Yes	Yes
port_a	Yes	Yes	Yes	Yes	Yes	Yes
port_b	Yes	Yes	Yes	Yes	Yes	Yes
protection_status	No	No	No	No	No	No
provider	Yes	Yes	Yes	Yes	Yes	Yes
role	Yes	Yes	Yes	Yes	Yes	Yes
rx_label	No	No	No	No	No	No
sr_adjacency_sids	No	No	No	No	No	No
srlgs	No	No	No	No	No	No
tags	No	No	No	No	No	No
tx_label	No	No	No	No	No	No
used_by_hops	No	No	No	No	No	No
vc_id	No	No	Yes	No	No	No

Services IP

Table 9. Service Item Attributes and Accessibility Details for the Cisco EPNM Adapter

Service Item	E-Line Services
admin_status	Yes
contained_ports	Yes
customer_details	No
customer_name	No
deployment_state	Yes
desc	Yes
extra	No
guid	Yes
is_protection_degraded	No
name	Yes
oper_status	Yes
parent	No
provider	Yes
service_health	Yes
service_intent	No
service_intent_relation	Yes
tags	No

Statistics IP

Table 10. IP Statistics Data Collected by the Cisco EPNM Adapter

Type	Is Collected
In Traffic bps	Yes
Out Traffic bps	Yes
In Packets/sec	Yes
Out Packets/sec	Yes

Configuration

Table 11. Configuration Parameters for the Cisco EPNM Adapter

Name	Description	Default	Range
Enabled	Enable/disable the adapter.	False	Enable this option once you are ready to run the adapter.
Logging Level	The logging level at which the discovery cycle is reported in the adapter log.	INFO	DEBUG, INFO, WARNING, ERROR, CRITICAL
Adapter Properties
Polling Cycle [sec]	Poll every X seconds.	7200	[30]
Statistics Polling Cycle [sec]	Poll for statistics every X seconds.	3600	[30]
Number of concurrent routers collected (RestConf API)	Number of concurrent routers collected by a RESTCONF API.	25	[30]
Number of concurrent routers collected (REST API)	Number of concurrent routers collected by a REST API.	2	[30]
Max Number of Pages in the single request	Maximum number of pages returned in a single request.	100
Connection Properties
Primary EPNM server URL	(http\|https)://<server>[:<port>]	443 for https 80 for http
Secondary EPNM server URL (Optional)	(http\|https)://<server>[:<port>]
Credentials	Credentials of type HTTP are defined in the “Credentials” tab of Device Manager.
Timeout [sec]	The connection timeout.	60
Verify SSL	Whether or not to verify using SSL.	False
Request Retries	The number of request retries in the event of a timeout.	3
Server Timezone	The EPNM server timezone.	UTC/GMT +00:00	TC offset format +-HH:MM For example: +05:30 for Indian Standard Time.
Collection Properties	Used to customize the collection of parameters that the adapter will use in a specific installation.
Enable topology and inventory collections	Whether the inventory and topology collection are enabled or disabled.	True
Enable Optical topology and inventory	Whether or not to enable optical topology and inventory.	True
Enable IGP IS-IS Collection	Whether the IGP IS-IS collection is enabled or disabled.	True
IS-IS Priority	The IGP IS-IS priority.	1	Min: 1
Enable IS-IS SR Collection	Whether the SR policy collection is enabled or disabled.	True
Enable L2 VPN Services Collection	Whether the L2VPN collection is enabled or disabled.	True
Enable Statistics	Whether or not statistics collection is enabled.	True
Statistics Template File	If enabled, create an EPNM template file.	HCO_Interface_Statistics_File
File Bringers Properties	Used to feed the adapter with local collection files instead of polling the CNC server.
Enabled	Should the file-bringer be enabled or not? If the file-bringer is enabled, the adapter will ignore the server’s configuration and will try to fetch static files using the file-bringer configuration.	False
Remote address with file pattern	For local files, use “file://<PATH-STARTING-IN-THE-ARCHIVE-DIRECTORY>”		Pattern: ^(ftp\|sftp\|file\|https):\\/\\/(([a-z0-9A-Z\\.\\-_]+)(:(\\d+))?)?(\\/?[^:]+)$
Credentials	Credentials are defined in the “Credentials” tab of Device Manager.
Same Risk Resource Group (SRRG) Configuration
EPNM SRRG Pool Name for Fiber SRLG	The EPNM SRRG pool name for the Fiber SRLG app.	HCO_SRRG_Pool_Name	If in use, this pool must be created in the EPNM Controller.

Limitations

· Hybrid – IP and Optical using NCS1|2|4K are not supported. NCS devices are modeled as ONE devices. IP networking is not calculated. As part of EPNM IP only Cisco ASR devices are supported.

· Cisco EPNM does not have the ARP support, so IP links are discovered using the subnet match. Enable Sedo setting “persistor.logical.create_by_subnets”. Cisco EPNM populates Logical links using the Logical ports.

· IGP collection is supported only for IS-IS.

· As part of ISIS-SR, only Prefix/Node SIDs and IGP Metrics are collected. Adjacency SIDs are not populated.

· SR Links will not be modelled.

· In Service discovery, only E-Lines are supported.

· Service underlay and QoS is not supported.

· RSVP-TE and SR-TE (including SR Policy) are not supported.

Was this Document Helpful?

Feedback

Contact Cisco

Open a Support Case
(Requires a Cisco Service Contract)

Cisco EPN Manager (EPNM) Adapter

Available Languages

Bias-Free Language

General Information

APIs Used

Version Support

Discovery Optical

Inventory

Ports

Links

Discovery IP

IP Inventory

IP Ports

IP Links

Services IP

Statistics IP

Configuration

Limitations

Was this Document Helpful?

Contact Cisco

This Document Applies to These Products