lsnsipalgprofile¶

Configuration for LSN SIPALG Profile resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
sipalgprofilename	<String>	Read-write	The name of the SIPALG Profile. Minimum length = 1 Maximum length = 127
datasessionidletimeout	<Double>	Read-write	Idle timeout for the data channel sessions in seconds. Default value: 120
sipsessiontimeout	<Double>	Read-write	SIP control channel session timeout in seconds. Default value: 600
registrationtimeout	<Double>	Read-write	SIP registration timeout in seconds. Default value: 60
sipsrcportrange	<String>	Read-write	Source port range for SIP_UDP and SIP_TCP.
sipdstportrange	<String>	Read-write	Destination port range for SIP_UDP and SIP_TCP.
openregisterpinhole	<String>	Read-write	ENABLE/DISABLE RegisterPinhole creation. Default value: ENABLED Possible values = ENABLED, DISABLED
opencontactpinhole	<String>	Read-write	ENABLE/DISABLE ContactPinhole creation. Default value: ENABLED Possible values = ENABLED, DISABLED
openviapinhole	<String>	Read-write	ENABLE/DISABLE ViaPinhole creation. Default value: ENABLED Possible values = ENABLED, DISABLED
openrecordroutepinhole	<String>	Read-write	ENABLE/DISABLE RecordRoutePinhole creation. Default value: ENABLED Possible values = ENABLED, DISABLED
siptransportprotocol	<String>	Read-write	SIP ALG Profile transport protocol type. Possible values = TCP, UDP
openroutepinhole	<String>	Read-write	ENABLE/DISABLE RoutePinhole creation. Default value: ENABLED Possible values = ENABLED, DISABLED
rport	<String>	Read-write	ENABLE/DISABLE rport. Default value: ENABLED Possible values = ENABLED, DISABLED
__count	<Double>	Read-only	count parameter

Operations¶

(click to see Properties )

ADD
UPDATE
UNSET
GET (ALL)
GET
COUNT
DELETE

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

add¶

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lsnsipalgprofile":{
<b>      "sipalgprofilename":<String_value>,
</b>      "datasessionidletimeout":<Double_value>,
      "sipsessiontimeout":<Double_value>,
      "registrationtimeout":<Double_value>,
      "sipsrcportrange":<String_value>,
      "sipdstportrange":<String_value>,
      "openregisterpinhole":<String_value>,
      "opencontactpinhole":<String_value>,
      "openviapinhole":<String_value>,
      "openrecordroutepinhole":<String_value>,
<b>      "siptransportprotocol":<String_value>,
</b>      "openroutepinhole":<String_value>,
      "rport":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created

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

update¶

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lsnsipalgprofile":{
<b>      "sipalgprofilename":<String_value>,
</b>      "datasessionidletimeout":<Double_value>,
      "sipsessiontimeout":<Double_value>,
      "registrationtimeout":<Double_value>,
      "sipsrcportrange":<String_value>,
      "sipdstportrange":<String_value>,
      "openregisterpinhole":<String_value>,
      "opencontactpinhole":<String_value>,
      "openviapinhole":<String_value>,
      "openrecordroutepinhole":<String_value>,
      "siptransportprotocol":<String_value>,
      "openroutepinhole":<String_value>,
      "rport":<String_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/lsnsipalgprofile? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lsnsipalgprofile":{
<b>      "sipalgprofilename":<String_value>,
</b>      "datasessionidletimeout":true,
      "sipsessiontimeout":true,
      "registrationtimeout":true,
      "sipsrcportrange":true,
      "sipdstportrange":true,
      "openregisterpinhole":true,
      "opencontactpinhole":true,
      "openviapinhole":true,
      "openrecordroutepinhole":true,
      "siptransportprotocol":true,
      "openroutepinhole":true,
      "rport":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

delete¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile/ sipalgprofilename_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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/lsnsipalgprofile

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of lsnsipalgprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile? view=summary

Use this query-parameter to get the summary output of lsnsipalgprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile? pagesize=#no;pageno=#no

Use this query-parameter to get the lsnsipalgprofile resources in chunks.

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 Header:

Content-Type:application/json

Response Payload:

{ "lsnsipalgprofile": [ {
      "sipalgprofilename":<String_value>,
      "datasessionidletimeout":<Double_value>,
      "sipsessiontimeout":<Double_value>,
      "registrationtimeout":<Double_value>,
      "sipsrcportrange":<String_value>,
      "sipdstportrange":<String_value>,
      "openregisterpinhole":<String_value>,
      "opencontactpinhole":<String_value>,
      "openviapinhole":<String_value>,
      "openrecordroutepinhole":<String_value>,
      "siptransportprotocol":<String_value>,
      "openroutepinhole":<String_value>,
      "rport":<String_value>
}]}

get¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile/ sipalgprofilename_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile/ sipalgprofilename_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile/ sipalgprofilename_value<String> ? view=summary

Use this query-parameter to get the summary output of lsnsipalgprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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 Header:

Content-Type:application/json

Response Payload:

{  "lsnsipalgprofile": [ {
      "sipalgprofilename":<String_value>,
      "datasessionidletimeout":<Double_value>,
      "sipsessiontimeout":<Double_value>,
      "registrationtimeout":<Double_value>,
      "sipsrcportrange":<String_value>,
      "sipdstportrange":<String_value>,
      "openregisterpinhole":<String_value>,
      "opencontactpinhole":<String_value>,
      "openviapinhole":<String_value>,
      "openrecordroutepinhole":<String_value>,
      "siptransportprotocol":<String_value>,
      "openroutepinhole":<String_value>,
      "rport":<String_value>
}]}

count¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/lsnsipalgprofile? count=yes

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 Header:

Content-Type:application/json

Response Payload:

{ "lsnsipalgprofile": [ { "__count": "#no"} ] }