ssldtlsprofile

Last published : Oct 30, 2026
Configuration for DTLS profile resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
name <String> Read-write Name for the DTLS profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@),equals sign (=), and hyphen (-) characters. Cannot be changed after the profile is created.
Minimum length = 1
Maximum length = 127
pmtudiscovery <String> Read-write Source for the maximum record size value. If ENABLED, the value is taken from the PMTU table. If DISABLED, the value is taken from the profile.
Default value: DISABLED
Possible values = ENABLED, DISABLED
maxrecordsize <Integer> Read-write Maximum size of records that can be sent if PMTU is disabled.
Default value: 1459
Minimum value = 250
Maximum value = 1459
maxretrytime <Integer> Read-write Wait for the specified time, in seconds, before resending the request.
Default value: 3
helloverifyrequest <String> Read-write Send a Hello Verify request to validate the client.
Default value: ENABLED
Possible values = ENABLED, DISABLED
terminatesession <String> Read-write Terminate the session if the message authentication code (MAC) of the client and server do not match.
Default value: DISABLED
Possible values = ENABLED, DISABLED
maxpacketsize <Integer> Read-write Maximum number of packets to reassemble. This value helps protect against a fragmented packet attack.
Default value: 120
Minimum value = 0
Maximum value = 86400
maxholdqlen <Integer> Read-write Maximum number of datagrams that can be queued at DTLS layer for processing.
Default value: 32
Minimum value = 32
Maximum value = 65535
maxbadmacignorecount <Integer> Read-write Maximum number of bad MAC errors to ignore for a connection prior disconnect. Disabling parameter terminateSession terminates session immediately when bad MAC is detected in the connection.
Default value: 100
Minimum value = 1
Maximum value = 65535
initialretrytimeout <Integer> Read-write Initial time out value to retransmit the last flight sent from the NetScaler.
Default value: 3
Minimum value = 1
Maximum value = 3
builtin <String[]> Read-only Flag to determine whether dtls profile is built-in or not.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature <String> Read-only The feature to be checked while applying this config.
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • COUNT
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/ssldtlsprofile HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"ssldtlsprofile":{
<b>"name":<String_value>,
</b>"pmtudiscovery":<String_value>,
"maxrecordsize":<Integer_value>,
"maxretrytime":<Integer_value>,
"helloverifyrequest":<String_value>,
"terminatesession":<String_value>,
"maxpacketsize":<Integer_value>,
"maxholdqlen":<Integer_value>,
"maxbadmacignorecount":<Integer_value>,
"initialretrytimeout":<Integer_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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/ssldtlsprofile/ name_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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/ssldtlsprofile HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"ssldtlsprofile":{
<b>"name":<String_value>,
</b>"pmtudiscovery":<String_value>,
"maxrecordsize":<Integer_value>,
"maxretrytime":<Integer_value>,
"helloverifyrequest":<String_value>,
"terminatesession":<String_value>,
"maxpacketsize":<Integer_value>,
"maxholdqlen":<Integer_value>,
"maxbadmacignorecount":<Integer_value>,
"initialretrytimeout":<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/ssldtlsprofile? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"ssldtlsprofile":{
<b>"name":<String_value>,
</b>"pmtudiscovery":true,
"maxrecordsize":true,
"maxretrytime":true,
"helloverifyrequest":true,
"terminatesession":true,
"maxpacketsize":true,
"maxholdqlen":true,
"maxbadmacignorecount":true,
"initialretrytimeout":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/ssldtlsprofile Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/ssldtlsprofile? 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/ssldtlsprofile? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of ssldtlsprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/ssldtlsprofile? view=summary
Use this query-parameter to get the summary output of ssldtlsprofile 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/ssldtlsprofile? pagesize=#no;pageno=#no
Use this query-parameter to get the ssldtlsprofile 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:
{ "ssldtlsprofile": [ {
"name":<String_value>,
"pmtudiscovery":<String_value>,
"maxrecordsize":<Integer_value>,
"maxretrytime":<Integer_value>,
"helloverifyrequest":<String_value>,
"terminatesession":<String_value>,
"maxpacketsize":<Integer_value>,
"initialretrytimeout":<Integer_value>,
"maxholdqlen":<Integer_value>,
"maxbadmacignorecount":<Integer_value>,
"builtin":<String[]_value>,
"feature":<String_value>,
"_nextgenapiresource":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/ssldtlsprofile/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/ssldtlsprofile/ name_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/ssldtlsprofile/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of ssldtlsprofile 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:
{  "ssldtlsprofile": [ {
"name":<String_value>,
"pmtudiscovery":<String_value>,
"maxrecordsize":<Integer_value>,
"maxretrytime":<Integer_value>,
"helloverifyrequest":<String_value>,
"terminatesession":<String_value>,
"maxpacketsize":<Integer_value>,
"initialretrytimeout":<Integer_value>,
"maxholdqlen":<Integer_value>,
"maxbadmacignorecount":<Integer_value>,
"builtin":<String[]_value>,
"feature":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/ssldtlsprofile? 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:
{ "ssldtlsprofile": [ { "__count": "#no"} ] }