sslfipskey
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.<br><br>The following requirement applies only to the NetScaler CLI:<br>If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my fipskey" or my fipskey).<br>Minimum length = 1 |
| modulus | <Double> | Read-write | Modulus, in multiples of 64, of the FIPS key to be created.<br>Minimum value = 0<br>Maximum value = 4096 |
| exponent | <String> | Read-write | Exponent value for the FIPS key to be created. Available values function as follows:<br> 3=3 (hexadecimal)<br>F4=10001 (hexadecimal).<br>Default value: 3<br>Possible values = 3, F4 |
| key | <String> | Read-write | Name of and, optionally, path to the key file to be imported.<br> /nsconfig/ssl/ is the default path.<br>Minimum length = 1 |
| inform | <String> | Read-write | Input format of the key file. Available formats are:<br>SIM - Secure Information Management; select when importing a FIPS key. If the external FIPS key is encrypted, first decrypt it, and then import it.<br>PEM - Privacy Enhanced Mail; select when importing a non-FIPS key.<br><br>Default value: SIM<br>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.<br>Minimum length = 1 |
| iv | <String> | Read-write | Initialization Vector (IV) to use for importing the key. Required for importing a non-FIPS key.<br>Minimum length = 1 |
| size | <Double> | Read-only | Size. |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties)
CREATE | DELETE | IMPORT | EXPORT | 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>.
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":{
"fipskeyname":<String_value>,
"modulus":<Double_value>,
"exponent":<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
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":{
"fipskeyname":<String_value>,
"key":<String_value>,
"inform":<String_value>,
"wrapkeyname":<String_value>,
"iv":<String_value>,
"exponent":<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
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":{
"fipskeyname":<String_value>,
"key":<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
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
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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "sslfipskey": [ {
"fipskeyname":<String_value>,
"modulus":<Double_value>,
"exponent":<String_value>,
"size":<Double_value>
}]}
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
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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "sslfipskey": [ {
"fipskeyname":<String_value>,
"modulus":<Double_value>,
"exponent":<String_value>,
"size":<Double_value>
}]}
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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "sslfipskey": [ { "__count": "#no"} ] }