Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

ssldtlsprofile

August 17, 2023
Contributed by: 
C

Configuration for DTLS profile resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
name 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 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 Read-write Maximum size of records that can be sent if PMTU is disabled.
Default value: 1459
Minimum value = 250
Maximum value = 1459
maxretrytime Read-write Wait for the specified time, in seconds, before resending the request.
Default value: 3
helloverifyrequest Read-write Send a Hello Verify request to validate the client.
Default value: DISABLED
Possible values = ENABLED, DISABLED
terminatesession 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 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
__count 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)>/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":<Double_value>,
"maxretrytime":<Double_value>,
"helloverifyrequest":<String_value>,
"terminatesession":<String_value>,
"maxpacketsize":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the error

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/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":<Double_value>,
"maxretrytime":<Double_value>,
"helloverifyrequest":<String_value>,
"terminatesession":<String_value>,
"maxpacketsize":<Double_value>
}}

<!--NeedCopy-->

Response:

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

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/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
}}

<!--NeedCopy-->

Response:

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

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/ssldtlsprofile

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/ssldtlsprofile?view=summary

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "ssldtlsprofile": [ {
"name":<String_value>,
"pmtudiscovery":<String_value>,
"maxrecordsize":<Double_value>,
"maxretrytime":<Double_value>,
"helloverifyrequest":<String_value>,
"terminatesession":<String_value>,
"maxpacketsize":<Double_value>
}]}

<!--NeedCopy-->

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/ssldtlsprofile/name_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/ssldtlsprofile/name_value<String>?view=summary

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "ssldtlsprofile": [ {
"name":<String_value>,
"pmtudiscovery":<String_value>,
"maxrecordsize":<Double_value>,
"maxretrytime":<Double_value>,
"helloverifyrequest":<String_value>,
"terminatesession":<String_value>,
"maxpacketsize":<Double_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
ssldtlsprofile
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.