ADC NITRO APIs

sslfipskey

August 17, 2023

Contributed by:

Configuration for FIPS key resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
fipskeyname	<String>	Read-write	Name for the FIPS key. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the FIPS key is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my fipskey" or 'my fipskey'). Minimum length = 1
keytype	<String>	Read-write	Only RSA key and ECDSA Key are supported. Default value: RSA Possible values = RSA, ECDSA
exponent	<String>	Read-write	Exponent value for the FIPS key to be created. Available values function as follows: 3=3 (hexadecimal) F4=10001 (hexadecimal). Default value: 3 Possible values = 3, F4
modulus	<Double>	Read-write	Modulus, in multiples of 64, of the FIPS key to be created. Minimum value = 0 Maximum value = 4096
curve	<String>	Read-write	Only p_256 (prime256v1) and P_384 (secp384r1) are supported. Default value: P_256 Possible values = P_256, P_384
key	<String>	Read-write	Name of and, optionally, path to the key file to be imported. /nsconfig/ssl/ is the default path. Minimum length = 1
inform	<String>	Read-write	Input format of the key file. Available formats are: SIM - Secure Information Management; select when importing a FIPS key. If the external FIPS key is encrypted, first decrypt it, and then import it. PEM - Privacy Enhanced Mail; select when importing a non-FIPS key. Default value: SIM Possible values = SIM, DER, PEM
wrapkeyname	<String>	Read-write	Name of the wrap key to use for importing the key. Required for importing a non-FIPS key. Minimum length = 1
iv	<String>	Read-write	Initialization Vector (IV) to use for importing the key. Required for importing a non-FIPS key. Minimum length = 1
size	<Double>	Read-only	Size.
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties )

CREATE
DELETE
GET (ALL)
GET
COUNT
IMPORT
EXPORT

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

create

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"sslfipskey":{
<b>      "fipskeyname":<String_value>,
</b><b>      "keytype":<String_value>,
</b>      "exponent":<String_value>,
      "modulus":<Double_value>,
      "curve":<String_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 NetScaler-specific errors). The response payload provides details of the error

delete

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

Import

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"sslfipskey":{
<b>      "fipskeyname":<String_value>,
</b><b>      "key":<String_value>,
</b>      "inform":<String_value>,
      "wrapkeyname":<String_value>,
      "iv":<String_value>,
      "exponent":<String_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 NetScaler-specific errors). The response payload provides details of the error

export

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"sslfipskey":{
<b>      "fipskeyname":<String_value>,
</b><b>      "key":<String_value>
</b>}}

<!--NeedCopy-->

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

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/sslfipskey? 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/sslfipskey? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of sslfipskey 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/sslfipskey? pagesize=#no;pageno=#no

Use this query-parameter to get the sslfipskey 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:

{ "sslfipskey": [ {
      "fipskeyname":<String_value>,
      "modulus":<Double_value>,
      "exponent":<String_value>,
      "curve":<String_value>,
      "keytype":<String_value>,
      "size":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslfipskey/ fipskeyname_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/sslfipskey/ fipskeyname_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/sslfipskey/ fipskeyname_value<String> ? view=summary

Use this query-parameter to get the summary output of sslfipskey 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:

{  "sslfipskey": [ {
      "fipskeyname":<String_value>,
      "modulus":<Double_value>,
      "exponent":<String_value>,
      "curve":<String_value>,
      "keytype":<String_value>,
      "size":<Double_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

sslfipskey

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

sslfipskey

Properties

Operations

create

delete

Import

export

get (all)

get

count

In this article