5.3. Common Commands

5.3.1. status

Show the number of connected primary and secondary processes. It also show a list of secondary IDs

spp > status
Soft Patch Panel Status :
primary: 1
secondary count: 4
Connected secondary id: 1
Connected secondary id: 2

5.3.2. record

Start recording user’s input and create a history file for playback commnad. Recording is stopped by executing exit or playback command.

spp > record 2nfv_uni.config

Note

It is not supported to stop recording without exit or playback command. It is planned to support stop command for stopping record in next relase.

5.3.3. playback

Restore configuration from a config file. Content of config file is just a series of SPP commnad. You prepare a config file by using record command or editing a text file by hand.

It is recommended to use extension .config to be self-sxplanatory as a config, although you can use any of extensions such as .txt or .log.

spp> playback 2nfv_uni.config

5.3.4. bye

bye command is for terminating SPP processes. It supports two types of termination as sub commands.

• sec
• all

First one is for terminating only secondary processes at once.

spp > bye sec
closing:<socket._socketobject object at 0x105750910>
closing:<socket._socketobject object at 0x105750a60>

Second one is for all SPP processes other than controller.

spp > bye all
closing:<socket._socketobject object at 0x10bd95910>
closing:<socket._socketobject object at 0x10bd95a60>
closing:('127.0.0.1', 53620)

5.3.5. help

Show help message for SPP commands.

spp > help

Documented commands (type help <topic>):
========================================
bye  help  playback  pri  record  sec  status

spp > help status
Display Soft Patch Panel Status
spp > help sec
Send command to secondary process