Manual Chapter : Options

Applies To:

Show Versions Show Versions


  • 17.1.0, 17.0.0, 16.1.4, 16.1.3, 16.1.2, 16.1.1, 16.1.0, 16.0.1, 16.0.0, 15.1.10, 15.1.9, 15.1.8, 15.1.7, 15.1.6, 15.1.5, 15.1.4, 15.1.3, 15.1.2, 15.1.1, 15.1.0, 15.0.1, 15.0.0, 14.1.5, 14.1.4, 14.1.3, 14.1.2, 14.1.0, 14.0.1, 14.0.0, 13.1.5, 13.1.4, 13.1.3, 13.1.1, 13.1.0
Manual Chapter


Indicates persistence mode. This option should be used to display or delete persistence records. This is the default mode.
Each record displays the persistence type, persistence key, originating ip:port, destination ip:port, protocol and the time remaining.
The records are grouped by the SIP router profile.
To delete the persistence record the record key has to be specified. Details are given below in the example section
Indicates media mode. This option should be used to perform operations on media records.
The media mode displays the Callid, Origination IP:RTP Port, RTCP Port, Interface name Destination IP: RTP Port, RTCP Port, Interface name.
In ALG-Translation mode, the output displays the translated address for the subscriber.
Indicates register mode. This option should be used to perform operations on register records.
The register mode displays the subscriber private address and translated address and the lifetime of the registration.
Displays the help text.
--router = name
-r name
The sip router profile name. This option is used to filter the output matching records for the specified SIP router profile.
The default partition '/Common' should be specified. For example '/Common/siprouter'
The option can be used for both modes i.e. persist and media modes.
-k value
Specifies the key for the session record. The option is used to filter the display with the specific key or delete a specific key.
For persistence mode the key is either a SIP Call-ID, Source Address or Custom value.
For Media mode the key is SIP Call-ID.
For register mode the key is the subscriber uri.
To delete a particular record.
This option along with the mode and the key details specifies the record to be deleted.
For persistence mode to delete a record the router name, key, persistence type and ip proto values have to be specified.
To delete a media entry the router name and SIP Call-ID needs to be specified.
--type = value
-t value
Type of persistence entry.
The option is applicable when deleting a persistence record.
Following are the applicable values.
For Call-ID id persistence
For Source Address persistence
For Custom type persistence
--ipproto = value
-p value
Either TCP or UDP.
The option is applicable when deleting a persistence record.
This option is applicable in persistence mode.
Displays the destination transport and pool name in addition to the default display.