Product Documentation

lbsipparameters

Sep 07, 2016

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.
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 destination port number, and CALL-ID based persistence is implemented for the responses received by the virtual server.
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.
Default value: 120
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.
Default value: ENABLED
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.
Default value: 100
rnatsecuresrcport
<Integer>
Read-write
Port number with which to match the source port in server-initiated SIP over SSL 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.
Default value: 0
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
rnatsecuredstport
<Integer>
Read-write
Port number with which to match the destination port in server-initiated SIP over SSL traffic. The rport parameter is added, without a value, to SIP packets that have a matching destination port number, and CALL-ID based persistence is implemented for the responses received by the virtual server.
Default value: 0
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API

Operations (click to see Properties)

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>

메모

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

update

URL: http://<netscaler-ip-address>/nitro/v1/config/lbsipparameters

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"lbsipparameters":{
      "rnatsrcport":<Integer_value>,
      "rnatdstport":<Integer_value>,
      "retrydur":<Integer_value>,
      "addrportvip":<String_value>,
      "sip503ratethreshold":<Double_value>,
      "rnatsecuresrcport":<Integer_value>,
      "rnatsecuredstport":<Integer_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/lbsipparameters?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"lbsipparameters":{
      "rnatsrcport":true,
      "rnatdstport":true,
      "retrydur":true,
      "addrportvip":true,
      "sip503ratethreshold":true,
      "rnatsecuresrcport":true,
      "rnatsecuredstport":true
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/lbsipparameters

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "lbsipparameters": [ {
      "rnatsrcport":<Integer_value>,
      "rnatdstport":<Integer_value>,
      "retrydur":<Integer_value>,
      "addrportvip":<String_value>,
      "sip503ratethreshold":<Double_value>,
      "rnatsecuresrcport":<Integer_value>,
      "rnatsecuredstport":<Integer_value>
}]}