sslcertfile
Configuration for Imported Certfile resource.
Properties
(click to see Operations)
Name | Data Type | Permissions | Description |
---|---|---|---|
name | <String> | Read-write | Name to assign to the imported certificate file. 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. The following requirement applies only to the NetScaler CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my file" or my file).<br>Minimum length = 1<br>Maximum length = 31 |
src | <String> | Read-write | URL specifying the protocol, host, and path, including file name, to the certificate file to be imported. For example, http://www.example.com/cert_file. NOTE: The import fails if the object to be imported is on an HTTPS server that requires client certificate authentication for access.<br>Minimum length = 1<br>Maximum length = 2047 |
__count | <Double> | Read-only | count parameter |
Operations
(click to see Properties)
IMPORT | DELETE | GET (ALL) | 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>.
Import
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={ "params":{ "warning":<String_value>, "onerror":<String_value>, "action":"Import" }, "sessionid":"##sessionid", "sslcertfile":{ "name":<String_value>, "src":<String_value>, }}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
delete
URL: http://<NSIP>/nitro/v1/config/sslcertfile
Query-parameters:
warning
http://<NS_IP>/nitro/v1/config/sslcertfile/_value<>?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: DELETE
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
get (all)
URL: http://<NSIP>/nitro/v1/config/sslcertfile
Query-parameters:
filter
http://<NSIP>/nitro/v1/config/sslcertfile?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of sslcertfile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<NS_IP>/nitro/v1/config/sslcertfile?view=summary
Use this query-parameter to get the summary output of sslcertfile resources configured on NetScaler.
pagesize=#no;pageno=#no
http://<NS_IP>/nitro/v1/config/sslcertfile?pagesize=#no;pageno=#no
Use this query-parameter to get the sslcertfile resources in chunks.
warning
http://<NS_IP>/nitro/v1/config/sslcertfile?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": <String_value>, "sslcertfile": [ { "name":<String_value>, "src":<String_value> }]}
count
URL: http://<NS_IP>/nitro/v1/config/sslcertfile?count=yes
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done",sslcertfile: [ { "__count": "#no"} ] }