Explore Cisco
How to Buy

Have an account?

  •   Personalized content
  •   Your products and support

Need an account?

Create an account

Cisco ASR 9000 Series Aggregation Services Router System Management Configuration Guide, Release 5.3.x

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.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Cisco ASR 9000 Series Aggregation Services Router System Management Configuration Guide, Release 5.3.x

Chapter Title

Implementing OnePK

Results

Updated:
January 31, 2019

Chapter: Implementing OnePK

Implementing OnePK

One Platform Kit (onePK) is a cross platform API and software development kit that enables the user to develop applications that interact directly with Cisco networking devices, and provides the user with the ability to access networking services using a set of controlled APIs that share the same programming model and style.

This module has details about OnePK - concepts and configurations. For information on the relevant commands, refer the System Management Command Reference for Cisco ASR 9000 Series Routers.

Table 1. Feature History for Implementing OnePKCisco IOS XR Software

Release

Modification

Release 5.1.2

This feature was introduced.

Information About onePK

One Platform Kit (onePK) is a cross platform API and software development kit that enables the user to develop applications that interact directly with Cisco networking devices, and provides the user with the ability to access networking services using a set of controlled APIs that share the same programming model and style.

You can deploy onePK applications on a server in the network, such as a multi-CPU or multi-core server running Linux or Windows, or even a mobile device running Android or iOS. This is referred to as end-node hosting. The other hosting models are also discussed, in the later sections.

The base service set comprises all those services that an application needs to interact with Cisco devices. There are optional service sets that the application can use if it needs a specific service. The goal of onePK is to keep a consistent set of APIs across platforms so that customers can freely use any platform to develop their applications.

OnePK supports the following programming languages:

  • C language API support

  • Java language API support (Data Path service set is not supported in Java)

  • Python API support

Understanding the OnePK system architecture

The onePK framework provides a client side application SDK to access the networking services running on Cisco devices. Enabling onePK on a Cisco platform requires that the platform be enabled to support the onePK abstraction side layer. The onePK enabled platforms make the onePK services accessible on that device when an application interacts with that device through the client side SDK.

This figure shows that applications can be built in multiple languages and can connect to different implementations.

Figure 1. The OnePK system


Supported Platforms and Linecards

The onePK is supported on the following linecards on the Cisco ASR 9000 Series Router:

  • A9K-RSP440-SE RSP3 (for service edge)

  • A9K-RSP440-TR RSP3 (for transport)

  • A9K-2X100GE-SE= ASR 9000 2-port 100GE, Service Edge Optimized LC

  • A9K-2X100GE-TR= ASR 9000 2-port 100GE, Packet Transport Optimized LC

  • A9K-24X10GE-SE= ASR 9000 24-port 10GE, Service Edge Optimized LC

  • A9K-24X10GE-TR= ASR 9000 24-port 10GE, Packet Transport Optimized LC

  • A9K-MOD80-SE= ASR 9000 80G Modular LC, 2x Typhoon NPs, Service Edge Optimized

  • A9K-MOD80-TR= ASR 9000 80G Modular LC, 2x Typhoon NPs, Packet Transport Optimized

  • A9K-MOD160-SE= ASR 9000 160G Modular LC, 4x Typhoon NPs, Service Edge Optimized

  • A9K-MOD160-TR= ASR 9000 160G Modular LC, 4x Typhoon NPs, Packet Transport Optimized

  • A9K-MPA-2X10GE= ASR 9000 2-port 10GE Modular Port Adapter (XFP)

  • A9K-MPA-4X10GE= ASR 9000 4-port 10GE Modular Port Adapter (XFP)

  • A9K-MPA-20X1GE= ASR 9000 20-port 1GE Modular Port Adapter (SFP)

  • A9K-MPA-1X40GE= ASR 9000 1-port 40GE Modular Port Adapter (QSFP)

  • A9K-MPA-2X40GE= ASR 9000 2-port 40GE Modular Port Adapter (QSFP) (only supported in the MOD-160 line cards)

Supported Actions

These are the supported actions for onePK:

  • drop

  • offload

  • redirect (IPv4 only)

  • set next-hop(IPv4 only)

  • Forwarding class mapped to a TE tunnel

  • Rate limit

  • QoS Marking

  • Multiple actions per flow

Service sets

OnePK supports a variety of networking APIs using service sets. The base service set provided includes all of the following:

  • Data Path Service Set:

    • Packet/Flow Classifiers

    • Punt

    • Inject

    • Statistics

  • Policy Service Set:

    • Interface Policy

    • Interface Feature Policy

    • Forwarding Policy

    • Flow Action Policy

  • Routing Service Set:

    • Protocol Change Events

    • RIB Table Queries

    • Performance Routing

  • Discovery Service Set:

    • Network Element Discovery

    • Service Discovery

    • Topology Discovery

  • Element Service Set:

    • Element Capabilities

    • Properties and Status

    • Configuration Management

    • Interfaces and Ports

    • Element Events

    • Location

  • Developer Service Set

    • Debug Capabilities

    • Tracing Interfaces

    • Management Interface

  • Utilities Service Set:

    • Syslog Events and Queries

    • AAA Interface

    • DHCP Events

    • Netflow Events

    • IPFIX Consumer or Producer

Hosting Models

Application developers can deploy their applications in three different hosting models. Each model is designed to be source code portable. These are the three models:

  • Process hosting enables application developers to install and run applications within a network element. This provides low latency communication and a single footprint for applications. All ONE-P applications are run in a process container.

  • Blade hosting enables an application to run close to the control and data planes and have dedicated resources to perform tasks.

  • End node hosting enables applications to take advantage of industry platforms ranging from large compute intensive devices such as multi-cpu/multi-core servers running to compact mobile devices.

OnePK Transport

You can either use, Secure Sockets Layer (SSL) or Transport Layer Security (TLS) with onep applications to secure communication between your applications and connected devices to avoid onep credentials being sent over the network unencrypted.

For details about SSL, refer the Implementing SSL chapter in the System Security Configuration Guide for Cisco ASR 9000 Series Routers.

To use TLS:

Figure 2.


This image is not available in preview/cisco.com

Use the transport type tls disable-remotecert-validation command for device authentication. For bidirectional device support and oneP application authentication (client authentication), use thetransport type tls command.

When using TLS, the network device is the TLS server and is authenticated with a certificate. The certificate must be issued by a Certification Authority (CA). It can be a private or a public certificate.

Data Path Service Set

The ONE-P Data Path Service Set (DPSS) presents a set of APIs to the end-developer. The user can work with packets that are diverted or copied from the forwarding path of a network element, such as a switch or router. It also enables the end-developer to re-inject diverted packets to the forwarding path of the network element after (optional) modification or synthesize new packets and inject them.

With this service set, your application can perform the following operations on packets:

  • Divert— The packet is sent to the application and does not continue on its way until the packet is returned to the data path by the application. While the application is examining the packet and deciding what to do, no other application, including the host platform itself, can do anything with the packet. The application can modify the packet in any way it sees fit, including dropping it.

Note
IPv6 is not supported on DPSS for the Cisco ASR 9000 series routers.

Data Path Service Set Components

The Data Path Service Set (DPSS) is the service set used by developers to get access to packets punted or copied from the host platform's data path. The main DPSS components are:

  • The Common Flow Table (CFT), is a shared memory implementation of a flow table that provides flow mapping, flow status and ways to manage application-specific flow feature objects. The CFT functionality can be accessed by any 1P(oneP) application through the flow awareness part of the presentation layer. The Main Process Packet handling initially populates the CFT entry for a specific flow. The CFT is also responsible for propagating flow state changes initiated by a 1P application, back to the host platform’s CFT (if there are changes).

  • The Packet Manager is a shared memory component that provides the infrastructure to allow the DPSS to move packets between the platform and 1P applications while minimizing the number of copies, etc. Main Process Packet Processing will initially create the shared buffers for incoming packets. These will be accessed by various end-developer applications.

DPSS flows

The available flow actions are (in that order):

  1. Drop flow

  2. Redirected flow

  3. Bypass flow

Developing OnePK applications

This procedure guides you to develop onep applications using linux. You will need to use a sample application to connect to a network device and verify your installation. The sample applications are:

  • HelloElement—an application that connects to a network element, obtains the host name, then terminates.

  • HelloNetwork—an application that connects to a network, obtains the host name, then terminates.

  • SyslogDemo—an application that connects to a network element and discovers further network elements using Cisco Discovery Protocol (CDP).

Figure 3. Developing OnePK applications with Linux


Enabling onePK

Perform this task to enable onePK.


Note
Once the onep session is up, DPSS configuration is done from the application on the controller end.

SUMMARY STEPS

  1. configure
  2. onep
  3. commit

DETAILED STEPS

  Command or Action Purpose
Step 1

configure

Step 2

onep

Example:

RP/0/RSP0/CPU0:router (config) # onep

Enters the onep configuration mode and enables onep. All onePK attributes and parameters are configured in this submode.

Step 3

commit

Configuring onePK

This procedure describes the steps involved in configuring the various onePK parameters.

The onePK commands used in this configuration procedure, are discussed in detail in the System Management Command Reference for Cisco ASR 9000 Series Routers.

SUMMARY STEPS

  1. configure
  2. onep
  3. Use one of these commands:
    • session max value
    • service set name
    • transport
    • logging
    • cpu threshold rising
    • history size
  4. exit
  5. commit

DETAILED STEPS

  Command or Action Purpose
Step 1

configure

Step 2

onep

Example:

RP/0/RSP0/CPU0:router (config) # onep

Enables and enters the onePK configuration mode.
Step 3

Use one of these commands:

  • session max value
  • service set name
  • transport
  • logging
  • cpu threshold rising
  • history size

Example:

RP/0/RSP0/CPU0:router(config-onep) # session max 10

Configures the limit for the selected onePK parameter.

Note 

This step can be repeated to configure all the required parameters.
Step 4

exit

Example:

RP/0/RSP0/CPU0:router(config-onep) # exit

Exits from the current mode.
Step 5

commit

Example: 1P Data Path configuration

This example shows the Data Path configuration details: 

onep
   transport tcp port 15001
   datapath transport vpathudp sender-id 1

To check for the running service node:

show run int gigEth 0/0/0/0
   service-policy type pbr input onep-pmap-1

service-node ONEP_1
  destination-port 19999            ==> LOCAL_PORT from dpss.conf
  encapsulation udp
  source-port 6633
  service-endpoint-ip 192.168.2.102 ==> LOCAL_IP from dpss.conf
  my-sender-id 1
  endpoint-sender-id 1

Was this Document Helpful?

FeedbackFeedback

Contact Cisco