Cisco IOS-XR Adapter

Available Languages

Updated:July 24, 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 IOS-XR Adapter

General Information

The Cisco IOS-XR adapter is a CLI adapter that supports discovery of inventory, topology, IGP-ISIS, MPLS tunnels, SR policies, LSP tunnels, optical data, status (ZRs), and PM statistics for the ETH layer, LSPs, and ZRs. The adapter collects the data directly from the routers one-by-one (connecting via SSH), before pushing the data to the Crosswork Hierarchical Controller model.

 

Prerequisites

For the adapter to function optimally, the adapter must access the routers, and each router needs to be manually added in the Device Manager.

 

Version Support

The following table lists the tested devices and their versions supported on the IOS-XR adapter.

 

Table 1.Versions Supported by the IOS-XR Adapter

Supported Devices  

Device Versions

ASR 9K

8201

5.3.4

6.4.2

6.5.3

5.3.4 

6.4.2 

6.5.3 

7.5.2 

 

Discovery

Discovery Summary

Table 2.Network Discovery Details for the IOS-XR Adapter

Category 

Information Type 

Inventory

 

Devices

Full router inventory (power supply, cards, ports, and so on)

Topology

 

Ports

 

IGP ISIS/OSPF

 

RSVP-TE

 

SR

 

Optical Ports (ZR)

 

MPLS Tunnels

 

LLDP

Port adjacencies

Stats

 

ETH Port Statistics

 

Optical Port Statistics

 

 

Inventory

Table 3.Inventory Item Attributes and Accessibility Details for the IOS-XR Adapter

Attribute

Router

Card

Fan

Power Supply

Non-Volatile Memory

Port

Optics Data

access_identifier

No

Yes

Yes

Yes

Yes

Yes

No

card_status

No

Yes

No

No

No

No

No

card_type

No

Yes

No

No

No

No

No

children

Yes

Yes

No

No

No

No

No

date_code

No

No

No

No

No

No

Yes

desc

Yes

Yes

Yes

Yes

Yes

Yes

No

device

No

Yes

Yes

Yes

Yes

Yes

No

device_family

Yes

No

No

No

No

No

No

device_type

Yes

No

No

No

No

No

No

extra

Yes

Yes

Yes

Yes

Yes

No

No

equip_state

No

No

No

No

No

Yes

No

form_factor

No

No

No

No

No

Maybe

(Only for optical ports)

No

management_ip

Yes

No

No

No

No

No

No

model_number

No

Yes

Yes

Yes

Yes

Yes

No

name

Yes

Yes

Yes

Yes

Yes

Yes

Yes

oui

No

No

No

No

No

Maybe

(Only for optical ports)

No

parent

No

Yes

Yes

Yes

Yes

Yes

No

part_number

No

Yes

Yes

Yes

Yes

Yes

No

provider

Yes

Yes

Yes

Yes

Yes

Yes

No

pluggability

No

No

No

No

No

Yes

No

rev_number

No

No

No

No

No

No

Yes

reachability_status

Yes

No

No

No

No

No

No

serial_number

Yes

Yes

Yes

Yes

Yes

Yes

No

site

No

No

No

No

No

No

No

supported_physical_layers

No

No

No

No

No

Maybe

(Only for optical ports)

No

software_version

Yes

No

No

No

No

No

No

tunable_type

No

No

No

No

No

Yes

No

tuned_lambda

No

No

No

No

No

Maybe

(Only for optical ports)

No

Vendor

Yes

Yes

Yes

Yes

Yes

Yes

No

vid

No

No

No

No

No

No

Yes

 

Ports

Table 4.Port Item Attributes and Accessibility Details for the IOS-XR Adapter

Attribute

Router
Physical

Router
Logical

Router
Aggregate

adjacency

Yes

No

No

admin_status

Yes

Yes

Yes

containing_service

Yes

No

No

desc

Yes

Yes

Yes

device

Yes

Yes

Yes

eth_port_type

Yes

No

No

extra

Yes

No

No

has_service_end_point_capability

Yes

Yes

No

if_index

Yes

Yes

Yes

is_loopback

No

Yes

No

is_router_id

No

Yes

No

lower_ports

Yes

Yes

Yes

name

Yes

Yes

Yes

oper_status

Yes

Yes

Yes

parent

Yes

Yes

No

primary_ip

No

Yes

No

physical_address

Yes

No

Yes

provider

Yes

Yes

Yes

rsvp_reserved_bandwidth_bps

No

Yes

No

rsvp_static_bandwidth_bps

No

Yes

No

speed_bps

Yes

No

No

upper_ports

Yes

Yes

Yes

vlan

No

Yes

No

 

Topology – Optical Discovery Ports

 

For optical ports, the following ports are created (in addition to the physical and logical ports):

·       ZR/ZR+: Eth Port, ZR Channel Port, ZR Media Port, OCH Port

·       ZR/ZR+ (muxponders, 4x1): 4xEth Port, 4xZR Channel Port, 1xZR Media Port, 1xOCH Port

 

Table 5.Optical Discovery Port Item Attributes and Accessibility Details for the IOS-XR Adapter

Attribute

Eth

ZR Channel

ZR Media

OTU

OCH

admin_status

Yes

Yes

Yes

Yes

Yes

channel_time_slot

No

Yes

(Only for muxponders)

No

No

No

desc

Yes

Yes

Yes

Yes

Yes

device

Yes

Yes

Yes

Yes

Yes

eth_port_type

Yes

No

No

No

No

extra.fec_mode

No

No

Yes

Yes

No

extra.modulation_type

No

No

No

No

Yes

extra.tx_power

No

No

No

No

Yes

if_index

No

No

Yes

Yes

Yes

lambda_nm

No

No

No

No

Yes

lower_ports

Yes

Yes

Yes

Yes

Yes

mapping_type

No

Yes

No

No

No

media_frame_type

No

No

Yes

No

No

name

Yes

Yes

Yes

Yes

Yes

odu_type

No

No

No

No

No

oper_status

Yes

Yes

Yes

Yes

Yes

parent

Yes

Yes

Yes

No

Yes

provider

Yes

Yes

Yes

Yes

Yes

speed_bps

Yes

No

No

No

No

upper_ports

Yes

Yes

Yes

Yes

Yes

 

UNI Port

 

UNI ports are created for L3VPN and for E-Lines.

Table 6.Attributes of L3VPN UNI Port Services for the IOS-XR Adapter

Attribute

Is Filled

Additional Information

admin_status

Yes

 

desc

Yes

 

device

Yes

 

egress_bandwidth_profile

No

 

extra

No

 

guid

Yes

 

is_all_to_one_bundling

Yes

 

eline_specific

Maybe

Only one of these (depending on the VPN type), and only if the UNI port has no Virtual UNI ports.

l_2_vpn_specific

No

l_3_vpn_specific

Maybe

lower_ports

Yes

 

mtu_size

Yes

 

name

Yes

 

oper_status

Yes

 

parent

Yes

 

provider

Yes

 

upper_ports

Yes

 

 

SR Policy Link

Table 7.Attributes of SR Policy Links for the IOS-XR Adapter

Attribute

Is Filled

Additional Information

binding_sid

Yes

 

candidate_paths

Yes

 

color

Yes

 

desc

Yes

 

extra.TUNNEL_PERSISTOR

Yes

 

guid

Yes

 

name

Yes

 

oper_status

Yes

 

path_group_type

Yes

 

paths

Yes

 

port_a

Yes

 

port_b

Yes

 

provider

Yes

 

role

Yes

 

 

Statistics

To collect statistics data, you need to enable NETCONF agent over SSH connection.

Table 8.Optical Statistics Data Collected by the IOS-XR Adapter

Name

Enabled By

Description

Min tx power

 

 

 

 

Enable collection of optics and coherent DSP statistics

 

 

 

 

These values are all collected in 15-minute buckets.

 

Average tx power

Maximum tx power

Min rx power

Average rx power

Max rx power

Min postfec ber

Average postfec ber

Max postfec ber

Min prefec ber

Average postfec ber

Max postfec ber

Min q factor

Average q factor

Max q factor

Min q margin

Average q margin

Max q margin

Packet in

 

Enable Interface Stats Collection

 

Packet out (port)

 

Octet in

 

Octet out (port)

 

Packet out (Router)

Enable LSP Stats Collection

 

Octet out (Router)

 

 

Configuration

Table 9.Configuration Parameters for IOS-XR Adapter

Name

Description

Default

Range/Note

Adapter Properties

 

 

 

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

Polling Cycle [sec]

Poll every X seconds.

300

Min: 0

Number of concurrent routers collected

 

10

 

Timeout for data persisting [sec]

 

Timeout for the process of recording the data into the model.

100

Min: 0

SSH Configuration Parameters

General parameters regarding router communication, as well as tunnels.

 

 

Enable Tunnel

Enable/disable the tunnel.

 

Unnecessary in the common IOS-XR use case.

Tunnel Host

IP of the tunnel.

 

 

Tunnel Port

Port to be used to connect to the tunnel.

 

 

Tunnel Credentials Key

The credentials to use with the router (SSH credentials).

 

 

Router Connect timeout

Timeout to connect to the router.

30

 

Router Command timeout

Timeout for each router command (for larger networks with big ISIS databases or for slow routers, it may be necessary to increase this value).

90

 

Router Command retries

Number of retries for failed commands.

1

 

File bringer Configuration

Used to feed the adapter with local collection files instead of polling the routers directly.

 

 

Enable File Bringer

Should the File Bringer (FB) be enabled or not.

If the FB is enabled, the adapter ignores the server’s configuration and tries to fetch static files using the FB configuration.

These files must be provided by another service.

False

Unnecessary in the common IOS-XR use case

File Server Location

SFTP or a file folder on your machine.

 

"[sftp|file]://<server>:<port>/<absolute path>"

File Type

File type.

Dash-and-Pound

 

Authentication

Authentication for the file server.

 

 

Backup File Server Location (optional)

SFTP or a file folder on your machine.

 

 

Backup_server_
authentication

Authentication for the backup file server.

 

 

HCO Collection Cycle Files

For internal use only

 

 

Enable HCO cycle mode

 

 

 

Cycle Directories Location

 

 

Root directory with ISO formatted directories ('archive/<collection_dir>')

Collection Parameters

Used to customize the adapter collection in the specific installation, according to the server it works with and the customer’s requirements.

 

 

Enable Topology Collection

Whether the topology collection is enabled or disabled.

False

 

Enable IGP IS-IS Collection

Whether the IGP IS-IS collection is enabled or disabled.

False

 

Enable IGP OSPF Collection

Whether the IGP OSPF collection is enabled or disabled.

False

 

Enable Interface Stats Collection

Whether the Interface Stats collection is enabled or disabled.

False

 

Enable VRF Collection

Whether the VRF/L3VPN collection is enabled or disabled.

False

 

Enable LLDP Collection

Whether the LLDP collection is enabled or disabled.

False

 

Enable MPLS Tunnels Collection

Whether the MLPS Tunnels collection is enabled or disabled.

False

 

Enable LSP Stat Collection

Whether the LSP Stat collections is enabled or disabled.

False

 

Enable SNMP Collection

Whether the SNMP collections is enabled or disabled.

False

 

IGP IS-IS Priority

The priority of all IS-IS data obtained from this adapter

1

 

Collect only IGP IS-IS seed routers

If enabled, only IS-IS databases from seed routers will be collected, lowering the collection time, as most IS-IS databases are duplicates.

 

Note that you need to configure IS-IS seed routers at the Crosswork Hierarchical Controller-level, otherwise this parameter will essentially disable all IS-IS collection.

True

 

Allow to use loopback IP as management IP

Allow the loopback IP to be used as the management IP.

False

 

Enable RSVP Collection

Whether the RSVP collection is enabled or disabled.

False

 

Enable collection of optics and coherent DSP

Whether the optics and coherent DSP collection is enabled or disabled.

False

 

Enable Segment Routing Collection

whether the segment routing collection is enabled or disabled.

False

 

Enable collection of optics and coherent DSP statistics

Whether the optics and coherent DSP statistics collection is enabled or disabled. Maximum period for statistics collection is 8 hours. If the polling time is greater than 28800 (8 hours) statistics are only collected for the previous 8 hours, resulting in incomplete statistics.

False

 

Use host_name.domain_name device ID format

By default, IOS-XR represents a router with hostname. In specific cases other adapters may use a different format, and in these specific cases it may be necessary to enable this configuration value.

False

 

 

Device Configuration

Each router needs to be added manually and assigned to the IOS-XR adapter on the Managed Devices tab of Device Manager.

Table 10.Device Configuration Parameters for the IOS-XR Adapter

Name

Description

Default

Range

Host

IP of the router.

 

 

Port

Connection port to the router.

22

 

Direct Connect (void tunnel if configured)

If checked and a tunnel is configured, the tunnel is ignored.

 

 

Authentication

The credentials to use with the router (SSH credentials).

 

 

Enabled

Enable/disable the adapter for that specific device.

False

 

 

Limitations

Discovery

·       Each IOS-XR router needs to be configured manually.

·       Only IPv4 ports are collected.

 

 

Was this Document Helpful?

FeedbackFeedback

Contact Cisco

This Document Applies to These Products