Service Advertisement Framework Configuration Guide, Cisco IOS XE Release 3S (Cisco ASR 1000)
Configuring Capabilities Manager
Downloads: This chapterpdf (PDF - 159.0KB) The complete bookPDF (PDF - 682.0KB) | The complete bookePub (ePub - 823.0KB) | Feedback

Configuring Capabilities Manager

Configuring Capabilities Manager

Last Updated: October 15, 2012

Capabilities Manager is enabled by default at system startup. At startup, it registers as a Service Routing client and proceeds to discover various capabilities of the hardware and software platform.

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest caveats and feature information, see Bug Search Tool and the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the feature information table at the end of this module.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.

Prerequisites for Capabilities Manager

  • To ensure that a device has Capabilities Manager available, enter the show service-routing plugin capman command.

    To enable a device to distribute its capabilities information, configure a SAF forwarder on the device.

  • To view capabilities information present on other devices in the network, configure a SAF forwarder.

Information About Capabilities Manager

Capabilities Discovery

Capabilities Manager discovers only whether a capability is supported on the local system. It does not discover whether the capability is configured or enabled, nor does it discover any other information about the capability for other devices in the network.

Capabilities information will be installed into the local Network Information Base (NIB) as Service Routing data and will be made available for advertisement by any SAF forwarder to the Service Routing network. Capabilities information is passed to the Service Routing infrastructure in XML format and is stored in the local NIB.

Interoperability with SAF Forwarder

Capabilities Manager does not advertise capabilities information to the Service Routing network. A SAF forwarder distributes capabilities information. However, a SAF forwarder is not required in order for Capabilities Manager to function. If a SAF forwarder is not configured, the capabilities information is bound to the local device and is not distributed to other devices in the network. When a SAF forwarder is configured, it will distribute all capabilities information by default.

Capabilities Information

Capabilities information is installed in the Network Information Base (NIB) as Service Routing data. It is identified by a SAF address in the form of:

  • Service ID--Capabilities Manager uses service ID 100.
  • Subservice ID--Capability group ID. The subservice ID indicates the group ID of the capabilities data type.
  • Instance number--Unique identifier for the local device. It is assigned in order of the hardware serial number, default MAC address, IPv4 device ID, or IPv6 device ID.

Capabilities Groups

Capabilities Manager classifies capabilities by group to facilitate query and retrieval, and assigns each group a unique ID. Capabilities Manager provides the following capability groups:

  • 1 (HARDWARE)
  • 2 (SOFTWARE)

Hardware Group Information

Hardware information is designated as group ID 1. Group 1 provides the following capabilities information, when available. All hardware information may not be available on each platform that supports Capabilities Manager.

  • Hostname
  • Platform
  • Main memory size
  • IO memory size

Software Group Information

Software information is designated as group ID 2. Group 2 provides the following capabilities information, when available. All software information may not be available on each platform that supports Capabilities Manager.

  • Hostname
  • Software
  • Image
  • Version
  • Software subsystems:
    • IP Multicast
    • insp_appfw
    • ip_sla_responder
    • eigrp_ipv4
    • eigrp_ipv6
    • ospf
    • ospfv3
    • isis
    • isis_ipv6
    • bgp_ipv4
    • bgp_ipv6
    • service_routing

XML Schema for Capabilities Data

If you have an Extensible Messaging Client Protocol (XMCP) client (external client) connected to a SAF forwarder, you can subscribe to the Capabilities Manager, which is service ID 100. The data can be interpreted using the following XML schema:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema'>
<xs:element name="Capabilities" type="CapabilitiesType" />
<xs:complexType name="CapabilitiesType">
<xs:sequence>
<xs:element ref="Group" minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:element name="Group" type="GroupType" />
<xs:complexType name="GroupType">
<xs:sequence>
<xs:element ref="Capability" minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
<xs:attribute name="Name" type="xs:normalizedString" use="required" />
</xs:complexType>
<xs:element name="Capability" type="CapabilityType" />
<xs:complexType name="CapabilityType">
<xs:sequence>
<xs:element name="Value" type="xs:normalizedString" />
</xs:sequence>
<xs:attribute name="Name" type="xs:normalizedString" use="required" />
</xs:complexType>
</xs:schema>
Example:
<Capabilities>
<Group Name="HARDWARE">
<Capability Name="Hostname">
<Value>R100</Value>
</Capability>
<Capability Name="Platform">
<Value>Solaris Unix (Sparc) processor</Value>
</Capability>
<Capability Name="MainMemorySize">
<Value>63683Kbytes</Value>
</Capability>
</Group>
<Group Name="SOFTWARE">
<Capability Name="HostName">
<Value>R100</Value>
</Capability>
<Capability Name="Software">
<Value>Cisco IOS Software</Value>
</Capability>
<Capability Name="Image">
<Value>Solaris Software (UNIX-ADVENTERPRISE-M)</Value>
</Capability> 
<Capability Name="Version">
<Value>Experimental Version 15.1(20110323:093227)</Value>
</Capability>
<Capability Name="ipmulticast">
<Value>Subsystem loaded</Value>
</Capability>
<Capability Name="eigrp_ipv4">
<Value>Subsystem loaded</Value>
</Capability>
</Group>
</Capabilities>	 

How to Configure Capabilities Manager

Disabling and Enabling Capabilities Manager

Capabilities Manager is enabled by default. You can disable and reenable Capabilities Manager at any time.

  • Disabling Capabilities Manager will remove all the capabilities information that is installed in the local Network Information Base (NIB) and unregister the information from Service Routing.
  • Reenabling Capabilities Manager will rediscover capabilities and provide information to the local NIB and to the Service Routing network.

Perform this task to disable and reenable Capabilities Manager.

SUMMARY STEPS

1.    enable

2.    configure terminal

3.    no service-routing capabilities-manager

4.    service-routing capabilities-manager


DETAILED STEPS
  Command or Action Purpose
Step 1
enable


Example:

Device> enable

 

Enables privileged EXEC mode. Enter your password if prompted.

 
Step 2
configure terminal


Example:

Device# configure terminal

 

Enters global configuration mode.

 
Step 3
no service-routing capabilities-manager


Example:

Device(config)# no service-routing capabilities-manager

 

Disables Capabilities Manager.

 
Step 4
service-routing capabilities-manager


Example:

Device(config)# service-routing capabilities-manager

 

Enables Capabilities Manager.

 

Displaying Capabilities Manager Information

SUMMARY STEPS

1.    enable

2.    show service-routing plugins capman

3.    show service-routing capabilities-manager internal

4.    show service-routing capabilities-manager [group value] [local]


DETAILED STEPS
  Command or Action Purpose
Step 1
enable


Example:

Device> enable

 

Enables privileged EXEC mode. Enter your password if prompted.

 
Step 2
show service-routing plugins capman


Example:

Device# show service-routing plugins capman

 

Displays information about Capabilities Manager plugins.

 
Step 3
show service-routing capabilities-manager internal


Example:

Device# show service-routing capabilities-manager internal

 

Displays information about Capabilities Manager.

 
Step 4
show service-routing capabilities-manager [group value] [local]


Example:

Device# show service-routing capabilities-manager group 1 local

 

Displays information about registered capabilities.

 

Clearing Registered Capabilities Information

Perform this task to clear current capabilities information from the NIB. Once the NIB is cleared, Capabilities Manager will automatically rediscover new capabilities.

SUMMARY STEPS

1.    enable

2.    clear service-routing capabilities-manager


DETAILED STEPS
  Command or Action Purpose
Step 1
enable


Example:

Device> enable

 

Enables privileged EXEC mode.

  • Enter your password if prompted.
 
Step 2
clear service-routing capabilities-manager


Example:

Device# clear service-routing capabilities-manager

 

Clears the current capabilities information from the NIB database. Capabilities Manager will automatically rediscover new capabilities.

 

Additional References

Related Documents

Related Topic Document Title

Cisco IOS commands

Cisco IOS Master Command List, All Releases

Service Advertisement Framework commands

Cisco IOS Service Advertisement Framework Technology Command Reference

Cisco EIGRP stub routing

"Configuring EIGRP" module in the IP Routing: EIGRP Configuration Guide

Technical Assistance

Description Link

The Cisco Support and Documentation website provides online resources to download documentation, software, and tools. Use these resources to install and configure the software and to troubleshoot and resolve technical issues with Cisco products and technologies. Access to most tools on the Cisco Support and Documentation website requires a Cisco.com user ID and password.

http://www.cisco.com/cisco/web/support/index.html

Feature Information for Capabilities Manager

The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.

Table 1 Feature Information for Capabilities Manager
Feature Name Releases Feature Information

Capabilities Manager

15.1(1)SG

15.1(1)SY

15.2(2)S

15.2(3)T

Cisco IOS XE Release 3.6S

Cisco IOS XE Release 3.3SG

Capabilities Manager is enabled by default at system startup. At startup, it registers as a Service Routing Client and proceeds to discover various capabilities of the hardware and software platform.

The following commands were introduced or modified:

  • clear service-routing capabilities- manager
  • service-routing capabilities-manager
  • show service-routing plugins capman
  • show service-routing capabilities-manager internal
  • show service-routing capabilities-manager group

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

© 2012 Cisco Systems, Inc. All rights reserved.