sslcrl
Configuration for Certificate Revocation List resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| crlname | <String> | Read-write | Name for the Certificate Revocation List (CRL). 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 CRL is created. 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 crl" or my crl).<br>Minimum length = 1 |
| crlpath | <String> | Read-write | Path to the CRL file. /var/netscaler/ssl/ is the default path.<br>Minimum length = 1 |
| inform | <String> | Read-write | Input format of the CRL file. The two formats supported on the appliance are: PEM - Privacy Enhanced Mail. DER - Distinguished Encoding Rule.<br>Default value: PEM<br>Possible values = DER, PEM |
| refresh | <String> | Read-write | Set CRL auto refresh.<br>Possible values = ENABLED, DISABLED |
| cacert | <String> | Read-write | CA certificate that has issued the CRL. Required if CRL Auto Refresh is selected. Install the CA certificate on the appliance before adding the CRL.<br>Minimum length = 1 |
| method | <String> | Read-write | Method for CRL refresh. If LDAP is selected, specify the method, CA certificate, base DN, port, and LDAP server name. If HTTP is selected, specify the CA certificate, method, URL, and port. Cannot be changed after a CRL is added.<br>Possible values = HTTP, LDAP |
| server | <String> | Read-write | IP address of the LDAP server from which to fetch the CRLs.<br>Minimum length = 1 |
| url | <String> | Read-write | URL of the CRL distribution point. |
| port | <Integer> | Read-write | Port for the LDAP server.<br>Minimum value = 1 |
| basedn | <String> | Read-write | Base distinguished name (DN), which is used in an LDAP search to search for a CRL. Citrix recommends searching for the Base DN instead of the Issuer Name from the CA certificate, because the Issuer Name field might not exactly match the LDAP directory structures DN.<br>Minimum length = 1 |
| scope | <String> | Read-write | Extent of the search operation on the LDAP server. Available settings function as follows: One - One level below Base DN. Base - Exactly the same level as Base DN.<br>Default value: One<br>Possible values = Base, One |
| interval | <String> | Read-write | CRL refresh interval. Use the NONE setting to unset this parameter.<br>Possible values = MONTHLY, WEEKLY, DAILY, NONE |
| day | <Integer> | Read-write | Day on which to refresh the CRL, or, if the Interval parameter is not set, the number of days after which to refresh the CRL. If Interval is set to MONTHLY, specify the date. If Interval is set to WEEKLY, specify the day of the week (for example, Sun=0 and Sat=6). This parameter is not applicable if the Interval is set to DAILY.<br>Minimum value = 0<br>Maximum value = 31 |
| time | <String> | Read-write | Time, in hours (1-24) and minutes (1-60), at which to refresh the CRL. |
| binddn | <String> | Read-write | Bind distinguished name (DN) to be used to access the CRL object in the LDAP repository if access to the LDAP repository is restricted or anonymous access is not allowed.<br>Minimum length = 1 |
| password | <String> | Read-write | Password to access the CRL in the LDAP repository if access to the LDAP repository is restricted or anonymous access is not allowed.<br>Minimum length = 1 |
| binary | <String> | Read-write | Set the LDAP-based CRL retrieval mode to binary.<br>Default value: NO<br>Possible values = YES, NO |
| cacertfile | <String> | Read-write | Name of and, optionally, path to the CA certificate file. /nsconfig/ssl/ is the default path.<br>Maximum length = 63 |
| cakeyfile | <String> | Read-write | Name of and, optionally, path to the CA key file. /nsconfig/ssl/ is the default path.<br>Maximum length = 63 |
| indexfile | <String> | Read-write | Name of and, optionally, path to the file containing the serial numbers of all the certificates that are revoked. Revoked certificates are appended to the file. /nsconfig/ssl/ is the default path.<br>Maximum length = 63 |
| revoke | <String> | Read-write | Name of and, optionally, path to the certificate to be revoked. /nsconfig/ssl/ is the default path.<br>Maximum length = 63 |
| gencrl | <String> | Read-write | Name of and, optionally, path to the CRL file to be generated. The list of certificates that have been revoked is obtained from the index file. /nsconfig/ssl/ is the default path.<br>Maximum length = 63 |
| flags | <Integer> | Read-only | CRL status flag. |
| lastupdatetime | <Integer> | Read-only | Last CRL refresh time. |
| version | <Integer> | Read-only | CRL version. |
| signaturealgo | <String> | Read-only | Signature algorithm. |
| issuer | <String> | Read-only | Issuer name. |
| lastupdate | <String> | Read-only | Last update time. |
| nextupdate | <String> | Read-only | Next update time. |
| daystoexpiration | <Integer> | Read-only | Number of days remaining for the CRL to expire. |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties)
ADD | CREATE | 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://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>
},
"sessionid":"##sessionid",
"sslcrl":{
"crlname":<String_value>,
"crlpath":<String_value>,
"inform":<String_value>,
"refresh":<String_value>,
"cacert":<String_value>,
"method":<String_value>,
"server":<String_value>,
"url":<String_value>,
"port":<Integer_value>,
"basedn":<String_value>,
"scope":<String_value>,
"interval":<String_value>,
"day":<Integer_value>,
"time":<String_value>,
"binddn":<String_value>,
"password":<String_value>,
"binary":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
create
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"create"
},
"sessionid":"##sessionid",
"sslcrl":{
"cacertfile":<String_value>,
"cakeyfile":<String_value>,
"indexfile":<String_value>,
"revoke":<String_value>,
"gencrl":<String_value>,
"password":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
delete
URL: http://<NSIP>/nitro/v1/config/sslcrl/crlname_value<String>
Query-parameters:
warning
http://<NS_IP>/nitro/v1/config/sslcrl/crlname_value<String>?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":
update
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: PUT
Request Payload:
{
"params": {
"warning":<String_value>,
"onerror":<String_value>"
},
sessionid":"##sessionid",
"sslcrl":{
"crlname":<String_value>,
"refresh":<String_value>,
"cacert":<String_value>,
"server":<String_value>,
"method":<String_value>,
"url":<String_value>,
"port":<Integer_value>,
"basedn":<String_value>,
"scope":<String_value>,
"interval":<String_value>,
"day":<Integer_value>,
"time":<String_value>,
"binddn":<String_value>,
"password":<String_value>,
"binary":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
unset
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"unset"
},
"sessionid":"##sessionid",
"sslcrl":{
"crlname":<String_value>,
"refresh":true,
"cacert":true,
"server":true,
"method":true,
"url":true,
"port":true,
"basedn":true,
"scope":true,
"interval":true,
"day":true,
"time":true,
"binddn":true,
"password":true,
"binary":true,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
get (all)
URL: http://<NSIP>/nitro/v1/config/sslcrl
Query-parameters:
filter
http://<NSIP>/nitro/v1/config/sslcrl?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of sslcrl resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<NS_IP>/nitro/v1/config/sslcrl?view=summary
Use this query-parameter to get the summary output of sslcrl resources configured on NetScaler.
pagesize=#no;pageno=#no
http://<NS_IP>/nitro/v1/config/sslcrl?pagesize=#no;pageno=#no
Use this query-parameter to get the sslcrl resources in chunks.
warning
http://<NS_IP>/nitro/v1/config/sslcrl?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>, "sslcrl": [ {
"crlname":<String_value>,
"crlpath":<String_value>,
"inform":<String_value>,
"cacert":<String_value>,
"refresh":<String_value>,
"scope":<String_value>,
"server":<String_value>,
"port":<Integer_value>,
"url":<String_value>,
"method":<String_value>,
"basedn":<String_value>,
"interval":<String_value>,
"day":<Integer_value>,
"time":<String_value>,
"binddn":<String_value>,
"password":<String_value>,
"flags":<Integer_value>,
"lastupdatetime":<Integer_value>,
"version":<Integer_value>,
"signaturealgo":<String_value>,
"issuer":<String_value>,
"lastupdate":<String_value>,
"nextupdate":<String_value>,
"binary":<String_value>,
"daystoexpiration":<Integer_value>
}]}
get
URL: http://<NS_IP>/nitro/v1/config/sslcrl/crlname_value<String>
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "sslcrl": [ {
"crlname":<String_value>,
"crlpath":<String_value>,
"inform":<String_value>,
"cacert":<String_value>,
"refresh":<String_value>,
"scope":<String_value>,
"server":<String_value>,
"port":<Integer_value>,
"url":<String_value>,
"method":<String_value>,
"basedn":<String_value>,
"interval":<String_value>,
"day":<Integer_value>,
"time":<String_value>,
"binddn":<String_value>,
"password":<String_value>,
"flags":<Integer_value>,
"lastupdatetime":<Integer_value>,
"version":<Integer_value>,
"signaturealgo":<String_value>,
"issuer":<String_value>,
"lastupdate":<String_value>,
"nextupdate":<String_value>,
"binary":<String_value>,
"daystoexpiration":<Integer_value>
}]}
count
URL: http://<NS_IP>/nitro/v1/config/sslcrl?count=yes
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done",sslcrl: [ { "__count": "#no"} ] }