Cisco ASR 9000 Series Aggregation Services Router System Management Command Reference, Release 5.2.x
onePK commands
Downloads: This chapterpdf (PDF - 1.46MB) The complete bookPDF (PDF - 10.2MB) | Feedback

onePK commands

onePK commands

This module describes the OnePK and Open Flow Agent commands.

clear applications

To clear applications for a specific configuration domain, use the clear applications command in onep configuration mode.

clear applications domain

Syntax Description

domain

Specifies the configuration domain.

Command Default

None

Command Modes

OneP configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read,write

Examples

This example shows how to run the clear applications command:

RP/0/0RP0RSP0/CPU0:router (config-onep) # clear applications do1

clear onep statistics

To clear the global statistics being maintained by the onePK infrastructure, use the clear onep statistics command in EXEC mode.

clear onep statistics [ session ]

Syntax Description

session max-no

Specifies the session to be cleared.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to clear the global onePK statistics:

RP/0/0RP0RSP0/CPU0:router# clear onep statistics
    

clear comment

To clear the configuration line comment, use the clear comment command in onep configuration mode.

clear comment

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

OneP configuration

Command History

Release Modification
Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

This command clears all configuration line comments that are entered after the command.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to run the clear comment command:

RP/0/0RP0RSP0/CPU0:router (config-onep) # clear comment

clear history buffer

To clear the audit trail of API history records (in the memory buffer), use the clear history buffer command in onep configuration mode.

clear history buffer { [ size entries ] [ purge { new | old } ] | syslog }

Syntax Description

size entries

Specifies the size of the memory buffer. The entries variable is the number of entries in the audit trail and can range from 100 to 1000.

purge

Configures the behavior of the buffer when it is full.

new

Specifies that when the buffer is full, the newest entries to the buffer are overwritten first.

old

Specifies that when the buffer is full, the oldest entries to the buffer are overwritten first.

Command Default

None

Command Modes

Onep configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to use the clear history buffer command:

RP/0/0RP0RSP0/CPU0:router# configure
RP/0/0RP0RSP0/CPU0:router(config)# onep
RP/0/0RP0RSP0/CPU0:router(config-onep)#  clear history buffer purge new
  

clear history syslog

To clear the history records of a syslog server, use the clear history syslog command in onep configuration mode.

clear history syslog

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

onep configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to run the clear history syslog command:

RP/0/0RP0RSP0/CPU0:router (config-onep) # clear history syslog 

clear session max

To clear simultaneous One Platform Kit (onePK) sessions, use the clear session max command in onep configuration mode.

clear session max sessions

Syntax Description

sessions

Number of permitted simultaneous sessions. The value can range from 1 to 32. The default is 10.

Command Default

None

Command Modes

Onep configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to use the clear session max command:

RP/0/0RP0RSP0/CPU0:router# configure
RP/0/0RP0RSP0/CPU0:router(config)# onep
RP/0/0RP0RSP0/CPU0:router(config-onep)# clear session max 5

datapath

To configure the parameters of the datapath service set on a network device, use the datapath command in onep configuration mode. To remove the datapath, use the no form of this command.

datapath diverted packet { maximum packets| timeoutseconds transport gre sender-id id-number} interface type path-id

no datapath diverted packet

Syntax Description

maximum packets

Specifies the maximum number of packets to be diverted by applications using the Datapath service set. Range is 1000 to 1000000.

timeout seconds

Specifies the number of seconds before timeout occurs. Range is from 1 to 60.

transport gre sender-id id-number

Specifies the sender ID number. Range is 1 to 4294967295.

interface

Specifies the local generic routing encapsulation (GRE) endpoint. Interface type can be - async, auto-template, BVI, CDMA-Ix, Ctunnel, Dialer, GMPLS, GigabitEthernet, Group-Async, LiSP, LongReachEthernet, Loopback, MFR, Multilink, Null, Tunnel, Vif, Virtual-ppp, Virtual-template, VMI.

Command Default

Datapath is disabled.

Command Modes

Onep configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to enable datapath :

RP/0/0RP0RSP0/CPU0:router# configure
RP/0/0RP0RSP0/CPU0:router(config)# onep
RP/0/0RP0RSP0/CPU0:router(config-onep)# datapath transport gre sender-id 23434 interface GigabitEthernet 0/0

This example configures a limit on the number of packets that will be sent to onep applications:

RP/0/0RP0RSP0/CPU0:router# configure
RP/0/0RP0RSP0/CPU0:router(config)# onep
RP/0/0RP0RSP0/CPU0:router(config-onep)# datapath diverted packet maximum 10000

dataplane-default

To select the appropriate packet forwarding behavior upon loss of connection to the controller, use the dataplane-defaultcommand in the appropriate configuration mode.

dataplane-default [ secure | standalone ]

Syntax Description

secure

Non-matched packets destined to the controller are dropped.

standalone

Non-matched packets destined to the controller are forwarded.

Command Default

Is configured to drop non-matched packets (secure config)

Command Modes

Openflow switch configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

Task ID

Task ID Operation
openflow

read, write

Examples

This example shows how to use the dataplane-default command:

RP/0/0RP0RSP0/CPU0:router (config-openflow-switch) # dataplane-default secure

history buffer

To manage how a network device records API calls, use the history buffer command in onep configuration mode. To , delete the records, use the no form of this command.

history buffer { [ size entries ] [ purge { new | old } ] | syslog }

no history buffer

Syntax Description

syslog

Enables the writing of onep API trails to syslog.

buffer

Configures options related to in-memory buffering of API history trails.

size entries

Specifies the size of the memory buffer. The entries variable is the number of entries in the audit trail and can range from 100 to 1000.

purge

Configures the behavior of the buffer when it is full.

new

Specifies that when the buffer is full, the newest entries to the buffer are overwritten first.

old

Specifies that when the buffer is full, the oldest entries to the buffer are overwritten first.

Command Default

History records are recorded to a memory buffer of size 100 where the newest entries are overwritten first when the buffer is full.

Command Modes

Onep configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The history command configures the audit trail of API history records. The number of history records is tracked per application and optionally can be stored in a memory buffer or logged to a syslog server. When the buffer reaches the specified size, the oldest or newest record is dropped based on the chosen purge option.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to use the history buffer command:

RP/0/0RP0RSP0/CPU0:router# configure
RP/0/0RP0RSP0/CPU0:router(config)# onep
RP/0/0RP0RSP0/CPU0:router(config-onep)# history buffer purge new
  

history buffer disable

To enable or disable the onep history buffer, use the history buffer disable command in the onep configuration mode. To enable the history buffer, use the no form of the command.

history buffer disable

no history buffer disable

Syntax Description

This command has no keywords or arguments.

Command Default

The history buffer is disabled by default.

Command Modes

Onep configuration

Command History

Release Modification

Release 5.1.2

This commands was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation
pkg-mgmt

read, write

Examples

This example shows how to use the history buffer disable command:

RP/0/0RP0RSP0/CPU0:router (config-onep)# history buffer disable 

onep

To enter onep configuration mode to configure attributes and parameters for One Platform Kit (onePK), use the onep command in global configuration mode. To revert to the default onePK configuration, use the no form of this command.

onep

no onep

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Global configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

This command will start the onep process (if it is not already running).

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to enter onep configuration mode and the available suboptions:

RP/0/0RP0RSP0/CPU0:router# configure
RP/0/0RP0RSP0/CPU0:router(config)# onep
RP/0/0RP0RSP0/CPU0:router(config-onep)# ?
  
applications  oneP applications
apply-group   Apply configuration from a group
clear         Clear the uncommitted configuration
commit        Commit the configuration changes to running
cpu           CPU resource
datapath      Onep Datapath
describe      Describe a command without taking real actions
do            Run an exec command
exit          Exit from this submode
history       start or stop history
no            Negate a command or set its defaults
pwd           Commands used to reach current submode
root          Exit to the global configuration mode
session       Onep Platform Session
show          Show contents of configuration
transport     Onep Transport
  

onep stop session

To disconnect and delete, all specified sessions, use the onep stop sessioncommand in EXEC mode.

onep stop session { all | session }

no onep stop session

Syntax Description

all

Stops all sessions.

session

Session name of the session to disconnect.

Command Default

None

Command Modes

Onep configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, execute

Examples

This example shows how to disconnect all sessions:

RP/0/0RP0RSP0/CPU0:router# onep stop session all
  

openflow switch

To enable Open Flow Agent , use the openflow switchcommand in the appropriate mode.

openflow switch logical-swtitch id

Syntax Description

logical-switch id

The logical switch id. Range is from 1 to 65535.

Command Default

None

Command Modes

Global Configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

Task ID

Task ID Operation
openflow

read, write

Examples

This example shows how to run the openflow switchcommand:

RP/0/0RP0RSP0/CPU0:router (config) # openflow switch 100

session max

To restrict the number of simultaneous active One Platform Kit (onePK) sessions, use the session max command in onep configuration mode. To revert to the default number of onePK sessions, use the no form of this command.

session max sessions

no sessions max

Syntax Description

sessions

Number of permitted simultaneous sessions. The value can range from 1 to 32. The default is 10.

Command Default

32 simultaneous sessions are permitted

Command Modes

Onep configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to limit the number of permitted simultaneous active onePK sessions to 5:

RP/0/0RP0RSP0/CPU0:router# configure
RP/0/0RP0RSP0/CPU0:router(config)# onep
RP/0/0RP0RSP0/CPU0:router(config-onep)# session max 5

show onep history

To display the audit trail history record captured, use the show onep history command in EXEC mode.

show onep history { all | session }

Syntax Description

all

Displays the history records for all sessions.

session

Session name of the session for which to display history records.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example sample output from the show onep history command:

RP/0/0RP0RSP0/CPU0:router# show onep history all
Archived Session: [DPSS_ASR9K_Test-asr9k-open-lnx-3077] History Entry Count: [8] 
[03/07/14 06:12:01.622 1][DPSS_ASR9K_Test-asr9k-open-lnx-3077] NetworkElement_getInterfaceByNameIDL('TenGigE0/1/0/0')
[03/07/14 06:12:01.625 2][DPSS_ASR9K_Test-asr9k-open-lnx-3077] InterfaceCreateDeleteEvent_registerIDL(3077,(1,-1,1,1))
[03/07/14 06:12:01.651 3][DPSS_ASR9K_Test-asr9k-open-lnx-3077] Policy_getGlobalCapIDL(3077)
[03/07/14 06:12:01.822 4][DPSS_ASR9K_Test-asr9k-open-lnx-3077] CapabilityMgr_getIntIDL(3077,<LIST>,0)
[03/07/14 06:12:01.824 5][DPSS_ASR9K_Test-asr9k-open-lnx-3077] CapabilityMgr_getStrIDL(3077,<LIST>,0)
[03/07/14 06:12:01.826 6][DPSS_ASR9K_Test-asr9k-open-lnx-3077] DPSS_setupIDL(3077,'type=vpath_udp:2','97.97.97.2:6633',9)
[03/07/14 06:12:04.029 7][DPSS_ASR9K_Test-asr9k-open-lnx-3077] Policy_submitPmapBulkIDL(3077,11,<LIST>)
[03/07/14 06:12:04.146 8][DPSS_ASR9K_Test-asr9k-open-lnx-3077] Policy_submitPmapActivateIDL(3077,0,<LIST>)

Archived Session: [DPSS_ASR9K_Test-asr9k-open-lnx-32346] History Entry Count: [8] 
[03/07/14 06:13:22.802 1][DPSS_ASR9K_Test-asr9k-open-lnx-32346] NetworkElement_getInterfaceByNameIDL('TenGigE0/1/0/0')
[03/07/14 06:13:22.803 2][DPSS_ASR9K_Test-asr9k-open-lnx-32346] InterfaceCreateDeleteEvent_registerIDL(32346,(1,-1,1,1))
[03/07/14 06:13:22.806 3][DPSS_ASR9K_Test-asr9k-open-lnx-32346] Policy_getGlobalCapIDL(32346)
[03/07/14 06:13:22.858 4][DPSS_ASR9K_Test-asr9k-open-lnx-32346] CapabilityMgr_getIntIDL(32346,<LIST>,0)
[03/07/14 06:13:22.860 5][DPSS_ASR9K_Test-asr9k-open-lnx-32346] CapabilityMgr_getStrIDL(32346,<LIST>,0)
[03/07/14 06:13:22.862 6][DPSS_ASR9K_Test-asr9k-open-lnx-32346] DPSS_setupIDL(32346,'type=vpath_udp:2','97.97.97.2:6633',9)
[03/07/14 06:13:24.935 7][DPSS_ASR9K_Test-asr9k-open-lnx-32346] Policy_submitPmapBulkIDL(32346,11,<LIST>)
[03/07/14 06:13:25.003 8][DPSS_ASR9K_Test-asr9k-open-lnx-32346] Policy_submitPmapActivateIDL(32346,0,<LIST>)

    

show onep session

To display the attributes of a particular onePK session or all sessions, use the show onep session command in EXEC mode.

show onep session { all | session }

Syntax Description

all

Displays the attributes for all sessions.

session

Session name of the session for which to display attributes.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to display attributes for all onePK sessions:

RP/0/0RP0RSP0/CPU0:router# show onep session s1
Sun Mar 16 11:16:41.397 UTC
ID         Username State            ReconnectTimer ConnectTime                   ApplicationName
23133      nav12    Connected        100            Sat Mar 15 05:34:47.042 UTC   s1
RP/0/RSP0/CPU0:UUT#show onep session all 
Sun Mar 16 11:16:46.546 UTC
ID         Username State            ReconnectTimer ConnectTime                   ApplicationName
23133      nav12    Connected        100            Sat Mar 15 05:34:47.042 UTC   DPSS_ASR9K_Test

    

show onep statistics

To display onePK application-specific information, use the show onep statistics command in EXEC mode.

show onep statistics [ session { all | session } ]

Syntax Description

sessions

Displays information for the specified session.

all

Displays the history records for all sessions.

session

Session name of the session for which to display history records.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show onep statistics command with no arguments displays the global and session specific statistics being maintained by the onePK infrastructure and the service sets. The global statistics include the total number of successfully connected application sessions, number of active sessions, number of local and remote disconnects and the kinds and numbers of errors encountered including authentication error, duplicate name error, system error and memory error.

Use the sessions keyword to display application-specific information, including application name, CPU and memory resource consumption by the application, number of onePK application programming interfaces (APIs) invoked, the number of bytes transferred in and out of network element, and the errors and the faults encountered during API execution.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to display global onePK statistics:

RP/0/0RP0RSP0/CPU0:router# show onep statistics
Sun Mar 16 11:17:29.895 UTC
Total number of sessions 8
  Active sessions 1
  Local disconnects 0
  Remote disconnects 0
  Error disconnects 8

Total errors 0
  Authentication errors 0
  Duplicate application name error 0
  Memory errors 0
  Internal errors 0

Rate limiting:
  Total TCP connects: 16
  Rejected connects: 0
  Accepted connects: 0
  Unaffected connects: 16

RP/0/RSP0/CPU0:router#show onep statistics session all 
Sun Mar 16 11:17:36.135 UTC

Session ID:       23133
Application Name: DPSS_ASR9K_Test
API In: 9               API Out: 1841
Bytes In: 1644          Bytes Out: 97895
Vty Count: 0





    

show onep status

To display all configuration information regarding onePK, use the show onep status command in EXEC mode.

show onep status

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show onep status command displays information on whether onePK is enabled or disabled, the configured application location, the lists of enabled service sets and the transport information for Thrift.

Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to display the onePK configuration information:

RP/0/0RP0RSP0/CPU0:router# show onep status
Status: enabled
Version: 1.1.0
Transport: tcp; Status: running; Port: 15001
Transport: tls; Status: disabled

Session Max Limit: 10
CPU Interval: 0 seconds
CPU Falling Threshold: 0%
CPU Rising Threshold: 0%
History Buffer: Enabled
History Buffer Purge: Oldest
History Buffer Size: 32768 bytes
History Syslog: Disabled
History Archived Session: 7
History Max Archive: 16

Service Set: Base               State: Enabled     Version 1.1.0
Service Set: Vty                State: Disabled    Version 0.1.0
    

show openflow hardware capabilities

To display the hardware capabilities of a switch , use the show openflow hardware capabilities command in the appropriate mode.

show openflow hardware capabilities pipeline pipeline-id

Syntax Description

pipeline-id

Displays the hardware information for the specified id. Range is from 129 to 132.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation
openflow

read, write

Examples

This example shows how to use the show openflow hardware capabilities command:

RP/0/0RP0RSP0/CPU0:router # show openflow hardware capabilties pipeline 130

show openflow interface switch

To display the interface details for a logical switch, use the show openflow interface switch in the appropriate mode.

show openflow interface switch switch-id

Syntax Description

switch-id

Displays the details for the specified logical switch id. Range for the id is 1 to 65535.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation
openflow

read, write

Examples

The following example shows how to use the show openflow interface switch command:

RP/0/0RP0RSP0/CPU0:router # show openflow interface switch 100

show openflow switch

To display open flow switch details, including the logical switch id, the controller and port information, use the show openflow switch command in the appropriate configuration mode.

show openflow switch { logical switch-id | controllers [ stats ] | ports | flows [ brief | summary ] }

Syntax Description

logical switch-id

Displays open flow details for the specified switch-id.

controllers

Displays open flow details for the specified controllers.

ports

Displays open flow details for the specified ports.

flows

Displays open flow details for the specified flows.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation
openflow

read, write

Examples

This example shows how to use the show openflow switch command:

RP/0/0RP0RSP0/CPU0:router # show openflow switch flows summary

show policy-map transient targets summary

To display the summary of the policy-map transient targets, use the show policy-map transient targets summary command in the EXEC mode.

Syntax Description

This command has no keywords or arguments.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release Modification

Release 5.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

qos

read

Examples

The following example displays the output of the show policy-map transient targets summary command:

RP/0/0RP0RSP0/CPU0:router#show policy-map transient targets summary

show policy-map transient list type pbr

To display the transient list type pbr of all the policy-maps, use the show policy-map transient list type pbr command in the EXEC mode.

show policy-map transient list type pbr [ unused | policy-map-name ]

Syntax Description

unused

Displays the list of policy-maps that are not applied to any interface or targets.

policy-map-name

Specifies the name of the transient policy map.

Command Default

No default behavior or values.

Command Modes

EXEC

Command History

Release Modification

Release 5.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

qos

read

Examples

RP/0/0RP0RSP0/CPU0:router:OFA2# show policy-map transient list type pbr

  PolicyMap: onep-pmap-7416-4    Type: pbr (transient)
    Total Flows : 2 

show policy-map transient type pbr pmap-name

To display the transient list type pbr for a specific policy-map, use the show policy-map transient list type pbr pmap-name command in the EXEC mode.

show policy-map transient pbr pmap-name policy-map-name

Syntax Description

policy-map-name

Name of the policy map.

Command Default

No default behavior or values.

Command Modes

EXEC

Command History

Release Modification

Release 5.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

qos

read

Examples

The following example displays the output of the show policy-map transient targets type pbr pmap-name command:

RP/0/0RP0RSP0/CPU0:router:OFA2#show policy-map transient targets type pbr pmap-name onep-pmap-7416-4
1) Policymap: onep-pmap-7416-4    Type: pbr
     Targets (applied as main policy):
       GigabitEthernet0/1/0/10 input
     Total targets: 1

show table-cap table-type

To display the table capabilities for a specified table type, use the show table-cap table-type command in the appropriate mode.

show table-cap table-type [ all | l2any | l2l3 | l3ds | l3ipv4 | qos-in | qos-out| traffic-in ]

Syntax Description

all

Displays all table types.

l2any

Displays tables with layer2 matches and actions.

l2l3

Displays tables with layer2 and layer3 IPv4 matches and layer2 actions.

l3ds

Displays tables with layer3 IPv4 and IPv6 matches and actions.

l3ipv4

Displays tables with layer3 IPv4 matches and actions.

qos-in

Displays tables with qos ingress matches and actions.

qos-out

Displays tables with qos egress matches and actions.

traffic-in

Displays tables with iosxr traffic ingress matches and actions.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 5.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation
openflow

read, write

Examples

This example shows how to use the show table-cap table-type command with the l3ipv4 keyword:

Table type:  L3 IPv4
    Forward type support list
    =========================
    1) 1
    Stats capability support list
    =============================
    Complete table stats supported                                          : FALSE
    Class statistics aggregated for all targets supported                   : TRUE
    Class statistics for each target supported                              : FALSE
    Per target statistics retrieval supported                               : FALSE
    Per action per target statistics supported                              : FALSE

    Trainsient capability support list
    ==================================
    Per table object transient storage suppo                                : TRUE

    Persistent capability support list
    ================================
    Per table object storage persistence sup                                : FALSE

    Class capability support list
    =============================
    Class-map supported                                                     : FALSE
    Class-map sequence number supported                                     : TRUE
    Class relative ordering supported                                       : TRUE
    Class idle timeout supported                                            : TRUE
    Inline class-map supported                                              : TRUE
    Maximum inline class provision rate                                     : 100
    Maximum inline class per table                                          : 50000

    Match capability support list
    =============================
    1) Match type : ipv4 dscp    Match attribute type mask. Mask attribute type: Wild card 
    2) Match type : ipv4 precedence    Match attribute type mask. Mask attribute type: Wild card 
    3) Match type : ip dscp    Match attribute type mask. Mask attribute type: Wild card 
    4) Match type : ip prec    Match attribute type mask. Mask attribute type: Wild card 
    5) Match type : protocol    Match attribute type mask. Mask attribute type: Wild card 
    6) Match type : source-address-ipv4    Match attribute type mask. Mask attribute type: Subnet mask 
    7) Match type : destination-address-ipv4    Match attribute type mask. Mask attribute type: Subnet mask 
    8) Match type : source-port    Match attribute type mask. Mask attribute type: Wild card 
    9) Match type : destination-port    Match attribute type mask. Mask attribute type: Wild card 
    10) Match type : input-interface-handle    Match attribute type mask. Mask attribute type: Wild card 
    11) Match type : QoS Group    Match attribute type mask. Mask attribute type: Wild card 
    12) Match type : ethertype    Match attribute type mask. Mask attribute type: Wild card 

    Action capability support list
    ==============================
    1) Action type : punt
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    2) Action type : copy
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    3) Action type : transmit
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    4) Action type : drop
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    5) Action type : Mark
       Sub Action attributes
       =====================
        1)Sub action : dscp.  Execution type : immediate.   Num instances : 1
        2)Sub action : qos-group.  Execution type : immediate.   Num instances : 1
        3)Sub action : forward-class.  Execution type : immediate.   Num instances : 1
    6) Action type : Mark
       Sub Action attributes
       =====================
        1)Sub action : ipv4 source address.  Execution type : immediate.   Num instances : 1
        2)Sub action : ipv4 destination address.  Execution type : immediate.   Num instances : 1
        3)Sub action : udp source port.  Execution type : immediate.   Num instances : 1
        4)Sub action : udp destination port.  Execution type : immediate.   Num instances : 1
        5)Sub action : tcp source port.  Execution type : immediate.   Num instances : 1
        6)Sub action : tcp destination port.  Execution type : immediate.   Num instances : 1
        7)Sub action : sctp source port.  Execution type : immediate.   Num instances : 1
        8)Sub action : sctp destination port.  Execution type : immediate.   Num instances : 1
    7) Action type : ipv4-next-hop
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1

This example shows how to use the show table-cap table-type command with the qos-in keyword:

1)  Table type:  QoS Ingress Parameters
    Forward type support list
    =========================
    1) 1
    Stats capability support list
    =============================
    Complete table stats supported                                          : FALSE
    Class statistics aggregated for all targets supported                   : TRUE
    Class statistics for each target supported                              : FALSE
    Per target statistics retrieval supported                               : FALSE
    Per action per target statistics supported                              : FALSE

    Trainsient capability support list
    ==================================
    Per table object transient storage suppo                                : FALSE

    Persistent capability support list
    ================================
    Per table object storage persistence sup                                : TRUE

    Class capability support list
    =============================
    Class-map supported                                                     : FALSE
    Class-map sequence number supported                                     : TRUE
    Class relative ordering supported                                       : TRUE
    Class idle timeout supported                                            : TRUE
    Inline class-map supported                                              : TRUE
    Maximum inline class provision rate                                     : 10
    Maximum inline class per table                                          : 0

    Match capability support list
    =============================
    1) Match type : ipv4 acl    Match attribute type: Value. Value : 0
    2) Match type : ipv6 acl    Match attribute type: Value. Value : 0
    3) Match type : ipv4 dscp    Match attribute type mask. Mask attribute type: Arbitrary 
    4) Match type : ipv4 precedence    Match attribute type: Value. Value : 0
    5) Match type : ipv6 dscp    Match attribute type mask. Mask attribute type: Arbitrary 
    6) Match type : ipv6 prec    Match attribute type: Value. Value : 0
    7) Match type : ip dscp    Match attribute type mask. Mask attribute type: Arbitrary 
    8) Match type : ip prec    Match attribute type: Value. Value : 0
    9) Match type : flow-key    Match attribute type: Value. Value : 0
    10) Match type : MPLS EXP Topmost    Match attribute type: Value. Value : 0
    11) Match type : cos    Match attribute type: Value. Value : 0
    12) Match type : cos inner    Match attribute type: Value. Value : 0
    13) Match type : protocol    Match attribute type mask. Mask attribute type: Arbitrary 
14) Match type : vlan    Match attribute type mask. Mask attribute type: Arbitrary 
    15) Match type : vlan inner    Match attribute type mask. Mask attribute type: Arbitrary 
    16) Match type : Source MAC Address    Match attribute type: Value. Value : 0
    17) Match type : Destination MAC Address    Match attribute type: Value. Value : 0
    18) Match type : QoS Group    Match attribute type: Value. Value : 0
    19) Match type : Discard class    Match attribute type: Value. Value : 0
    20) Match type : dei    Match attribute type: Value. Value : 0
    21) Match type : Frame relay DLCI    Match attribute type mask. Mask attribute type: Arbitrary 
    22) Match type : Frame relay DE    Match attribute type: Value. Value : 0
    23) Match type : cac admit local    Match attribute type: Value. Value : 0
    24) Match type : cac unadmit local    Match attribute type: Value. Value : 0

    Action capability support list
    ==============================
    1) Action type : Mark
       Sub Action attributes
       =====================
        1)Sub action : Unknown.  Execution type : immediate.   Num instances : 1
        2)Sub action : dscp.  Execution type : immediate.   Num instances : 1
        3)Sub action : precedence.  Execution type : immediate.   Num instances : 1
        4)Sub action : mpls experimental topmost.  Execution type : immediate.   Num instances : 1
        5)Sub action : mpls experimental imposition.  Execution type : immediate.   Num instances : 1
        6)Sub action : qos-group.  Execution type : immediate.   Num instances : 1
        7)Sub action : discard-class.  Execution type : immediate.   Num instances : 1
        8)Sub action : cos.  Execution type : immediate.   Num instances : 1
        9)Sub action : cos inner.  Execution type : immediate.   Num instances : 1
        10)Sub action : srp priority.  Execution type : immediate.   Num instances : 1
        11)Sub action : atm clp.  Execution type : immediate.   Num instances : 1
        12)Sub action : fr-de.  Execution type : immediate.   Num instances : 1
    2) Action type : WRED
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    3) Action type : Encapsulation sequence
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    4) Action type : Priority queuing
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    5) Action type : Compress Header IP
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    6) Action type : Minimum Bandwidth
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
 7) Action type : Police
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    8) Action type : Queue Limit
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    9) Action type : Shape
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    10) Action type : Bandwidth Remaining
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    11) Action type : Hierarchical Policy
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1
    12) Action type : admit cac
       Action attributes
       =================
       Execution type : immediate.   Num instances : 1





shutdown

To disable a logical switch, use the shutdown command in the appropriate mode.

shutdown logical-switch-id

Syntax Description

logical-switch-id

The logical switch that needs to be shutdown.

Command Default

None

Command Modes

Openflow configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

Task ID

Task ID Operation
openflow

read, write

Examples

This example shows how to use the shutdown command:

RP/0/0RP0RSP0/CPU0:router (config-openflow-switch) # shutdown 20

transport

To define the transport type used for onePK, use the transport command in onep configuration mode. To revert to the default transport type, use the no form of this command.

transport { tcp | tls [ disable-remotecert-validation | localcert trustpoint | remotecert trustpoint ] } [ port port-no ]

no transport

Syntax Description

tcp

Specifies to use transmission control protocol (TCP) for the communications channel established between a connected onePK application and the onePK server.

tls

Specifies to use transport layer security (TLS) for the transport for thrift IPC.

disable-remotecert-validation

Disables remote certification validation.

localcert

Enables local certification validation.

trustpoint

The trustpoint for local or remote certification validation.

remotecert

Enables remote certification validation. This is the default behavior.

port port-no

Specifies the port number to use for the specified transport.

Command Default

The default TCP port is 15001; the default TLS port is 15002. When TLS is selected, the default is remote certification validation. If no trustpoints are configured, the default behavior is to use globally configured trustpoints.

Command Modes

Onep configuration

Command History

Release Modification

Release 5.1.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Both the TLS and the regular TCP sockets can be configured at the same time on the network element. TLS communication is similar to using SSH for router administration and therefore should be used for production deployments of onePK or in any development or test environment where traffic between the onePK application and the router may be intercepted.


Note


TLS communication should be used with onePK applications whenever possible.


Task ID

Task ID Operation

pkg-mgmt

read, write

Examples

This example shows how to disable remote certification validation:

RP/0/0RP0RSP0/CPU0:router# configure
RP/0/0RP0RSP0/CPU0:router(config)# onep
RP/0/0RP0RSP0/CPU0:router(config-onep)# transport tls disable-remotecert-validation