Download full document:

lbsipparameters

Configuration for SIP parameters resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
rnatsrcport	<Integer>	Read-write	Port number with which to match the source port in server-initiated SIP traffic. The rport parameter is added, without a value, to SIP packets that have a matching source port number, and CALL-ID based persistence is implemented for the responses received by the virtual server.<br>Default value: 0
rnatdstport	<Integer>	Read-write	Port number with which to match the destination port in server-initiated SIP traffic. The rport parameter is added, without a value, to SIP packets that have a matching source port number, and CALL-ID based persistence is implemented for the responses received by the virtual server.<br>Default value: 0
retrydur	<Integer>	Read-write	Time, in seconds, for which a client must wait before initiating a connection after receiving a 503 Service Unavailable response from the SIP server. The time value is sent in the "Retry-After" header in the 503 response.<br>Default value: 120<br>Minimum value = 1
addrportvip	<String>	Read-write	Add the rport parameter to the VIA headers of SIP requests that virtual servers receive from clients or servers.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
sip503ratethreshold	<Double>	Read-write	Maximum number of 503 Service Unavailable responses to generate, once every 10 milliseconds, when a SIP virtual server becomes unavailable.<br>Default value: 100

Operations

(click to see Properties)

UPDATE | UNSET | GET (ALL)

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"lbsipparameters":{
      "rnatsrcport":<Integer_value>,
      "rnatdstport":<Integer_value>,
      "retrydur":<Integer_value>,
      "addrportvip":<String_value>,
      "sip503ratethreshold":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"lbsipparameters":{
      "rnatsrcport":true,
      "rnatdstport":true,
      "retrydur":true,
      "addrportvip":true,
      "sip503ratethreshold":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/lbsipparameters

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "lbsipparameters": [ {
      "rnatsrcport":<Integer_value>,
      "rnatdstport":<Integer_value>,
      "retrydur":<Integer_value>,
      "addrportvip":<String_value>,
      "sip503ratethreshold":<Double_value>

}]}