com.citrix.sdx.nitro.resource.config.ns

Class ns_ssl_certkey

java.lang.Object

com.citrix.sdx.nitro.resource.base.base_resource

com.citrix.sdx.nitro.resource.config.ns.ns_ssl_certkey

public class ns_ssl_certkey
extends base_resource

Configuration for SSL certificate on NetScaler resource

Field Summary

Fields inherited from class com.citrix.sdx.nitro.resource.base.base_resource

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
ns_ssl_certkey()

Method Summary

Methods

Modifier and Type	Method and Description
static ns_ssl_certkey	add(nitro_service client, ns_ssl_certkey resource) Use this operation to install certificates on NetScaler Instance(s).
static ns_ssl_certkey[]	add(nitro_service client, ns_ssl_certkey[] resources) Use this operation to install certificates on NetScaler Instance(s) in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of ns_ssl_certkey resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of ns_ssl_certkey resources.
static long	count(nitro_service service) Use this API to count the ns_ssl_certkey resources configured on NetScaler SDX.
static ns_ssl_certkey	delete(nitro_service client, ns_ssl_certkey resource) Use this operation to delete certificates on NetScaler Instance(s).
static ns_ssl_certkey[]	delete(nitro_service client, ns_ssl_certkey[] resources) Use this operation to delete certificates on NetScaler Instance(s) in bulk.
static ns_ssl_certkey	gen_csr(nitro_service client, ns_ssl_certkey resource) Use this operation to generate CSR for the certificate.
static ns_ssl_certkey[]	gen_csr(nitro_service client, ns_ssl_certkey[] resources) Use this operation to generate CSR for the certificate in bulk.
String	get_cert_format() Certificate Format
String	get_certkeypair_name() Cert Key Pair Name
String	get_csr() Certificate Signing Request
Integer	get_days_to_expiry() Days before SSL certificate expires
String	get_device_name() Name of the device
static ns_ssl_certkey[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of ns_ssl_certkey resources.
static ns_ssl_certkey[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of ns_ssl_certkey resources.
String	get_id() Id is system generated key for all ssl cert-keys entries
String	get_issuer() Issuer
protected base_resource[]	get_nitro_bulk_response(nitro_service service, String response) Converts API response of bulk operation into object and returns the object array in case of get request.
protected base_resource[]	get_nitro_response(nitro_service service, String response) Converts API response into object and returns the object array in case of get request.
Boolean	get_no_domain_check() Specify this option to override the check for matching domain names during certificate update operation
String[]	get_ns_ip_address_arr() List of NetScaler IP Address
String	get_ns_ip_address() List of NetScaler IP Address
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
String	get_password() The pass-phrase that was used to encrypt the private-key.
String	get_public_key_algorithm() Public Key Algorithm
Integer	get_public_key_size() Public Key Size
Boolean	get_save_config() true, if save config is required
Integer	get_serial_number() Serial Number
String	get_signature_algorithm() Signature Algorithm
String	get_ssl_certificate() Certificate
String	get_ssl_key() Key
String	get_status() Tells whether the certificate is still valid or not
String	get_subject() Subject
String	get_valid_from() Valid From
String	get_valid_to() Valid To
String	get_version() Version
static ns_ssl_certkey[]	get(nitro_service client) Use this operation to get certificates on NetScaler Instance(s).
static ns_ssl_certkey	get(nitro_service client, ns_ssl_certkey resource) Use this operation to get certificates on NetScaler Instance(s).
static ns_ssl_certkey	modify(nitro_service client, ns_ssl_certkey resource) Use this operation to modify certificates on NetScaler Instance(s).
static ns_ssl_certkey[]	modify(nitro_service client, ns_ssl_certkey[] resources) Use this operation to modify certificates on NetScaler Instance(s) in bulk.
void	set_cert_format(String cert_format) Certificate Format
void	set_certkeypair_name(String certkeypair_name) Cert Key Pair Name
void	set_id(String id) Id is system generated key for all ssl cert-keys entries
void	set_no_domain_check(Boolean no_domain_check) Specify this option to override the check for matching domain names during certificate update operation
void	set_ns_ip_address_arr(String[] ns_ip_address_arr) List of NetScaler IP Address
void	set_ns_ip_address(String ns_ip_address) List of NetScaler IP Address
void	set_password(String password) The pass-phrase that was used to encrypt the private-key.
void	set_save_config(Boolean save_config) true, if save config is required
void	set_ssl_certificate(String ssl_certificate) Certificate
void	set_ssl_key(String ssl_key) Key
protected void	validate(String operationType) Performs generic data validation for the operation to be performed

Methods inherited from class com.citrix.sdx.nitro.resource.base.base_resource

add_resource, add_resource, delete_bulk_request, delete_resource, get_resource, get_resource, get_resources, get_resources, getfiltered, perform_operation_bulk_request, perform_operation, perform_operation, perform_operation, resource_to_string, resource_to_string, update_bulk_request, update_resource, update_resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ns_ssl_certkey

public ns_ssl_certkey()

Method Detail

get_object_type

protected String get_object_type()

Description copied from class: base_resource

Gets the resource type.

Overrides:

get_object_type in class base_resource

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Specified by:

get_object_id in class base_resource

get_status

public String get_status()

 Tells whether the certificate is still valid or not
 

get_days_to_expiry

public Integer get_days_to_expiry()

 Days before SSL certificate expires
 

set_ns_ip_address

public void set_ns_ip_address(String ns_ip_address)

 List of NetScaler IP Address
 

get_ns_ip_address

public String get_ns_ip_address()

 List of NetScaler IP Address
 

set_ssl_certificate

public void set_ssl_certificate(String ssl_certificate)

 Certificate
 

get_ssl_certificate

public String get_ssl_certificate()

 Certificate
 

set_certkeypair_name

public void set_certkeypair_name(String certkeypair_name)

 Cert Key Pair Name
 

get_certkeypair_name

public String get_certkeypair_name()

 Cert Key Pair Name
 

get_device_name

public String get_device_name()

 Name of the device
 

set_ssl_key

public void set_ssl_key(String ssl_key)

 Key
 

get_ssl_key

public String get_ssl_key()

 Key
 

set_cert_format

public void set_cert_format(String cert_format)

 Certificate Format
 

get_cert_format

public String get_cert_format()

 Certificate Format
 

set_id

public void set_id(String id)

 Id is system generated key for all ssl cert-keys entries
 

get_id

public String get_id()

 Id is system generated key for all ssl cert-keys entries
 

get_valid_to

public String get_valid_to()

 Valid To
 

get_serial_number

public Integer get_serial_number()

 Serial Number
 

set_save_config

public void set_save_config(Boolean save_config)

 true, if save config is required
 

get_save_config

public Boolean get_save_config()

 true, if save config is required
 

get_signature_algorithm

public String get_signature_algorithm()

 Signature Algorithm
 

get_subject

public String get_subject()

 Subject
 

get_valid_from

public String get_valid_from()

 Valid From
 

get_version

public String get_version()

 Version
 

get_public_key_algorithm

public String get_public_key_algorithm()

 Public Key Algorithm
 

get_issuer

public String get_issuer()

 Issuer
 

set_no_domain_check

public void set_no_domain_check(Boolean no_domain_check)

 Specify this option to override the check for matching domain names during certificate update operation
 

get_no_domain_check

public Boolean get_no_domain_check()

 Specify this option to override the check for matching domain names during certificate update operation
 

set_ns_ip_address_arr

public void set_ns_ip_address_arr(String[] ns_ip_address_arr)

 List of NetScaler IP Address
 

get_ns_ip_address_arr

public String[] get_ns_ip_address_arr()

 List of NetScaler IP Address
 

set_password

public void set_password(String password)

 The pass-phrase that was used to encrypt the private-key.
 

get_password

public String get_password()

 The pass-phrase that was used to encrypt the private-key.
 

get_public_key_size

public Integer get_public_key_size()

 Public Key Size
 

get_csr

public String get_csr()

 Certificate Signing Request
 

add

public static ns_ssl_certkey add(nitro_service client,
                 ns_ssl_certkey resource)
                          throws Exception

 Use this operation to install certificates on NetScaler Instance(s).
 

Throws:

Exception

add

public static ns_ssl_certkey[] add(nitro_service client,
                   ns_ssl_certkey[] resources)
                            throws Exception

 Use this operation to install certificates on NetScaler Instance(s) in bulk.
 

Throws:

Exception

delete

public static ns_ssl_certkey delete(nitro_service client,
                    ns_ssl_certkey resource)
                             throws Exception

 Use this operation to delete certificates on NetScaler Instance(s).
 

Throws:

Exception

delete

public static ns_ssl_certkey[] delete(nitro_service client,
                      ns_ssl_certkey[] resources)
                               throws Exception

 Use this operation to delete certificates on NetScaler Instance(s) in bulk.
 

Throws:

Exception

get

public static ns_ssl_certkey[] get(nitro_service client)
                            throws Exception

 Use this operation to get certificates on NetScaler Instance(s).
 

Throws:

Exception

get

public static ns_ssl_certkey get(nitro_service client,
                 ns_ssl_certkey resource)
                          throws Exception

Use this operation to get certificates on NetScaler Instance(s).

Throws:

Exception

modify

public static ns_ssl_certkey modify(nitro_service client,
                    ns_ssl_certkey resource)
                             throws Exception

 Use this operation to modify certificates on NetScaler Instance(s).
 

Throws:

Exception

modify

public static ns_ssl_certkey[] modify(nitro_service client,
                      ns_ssl_certkey[] resources)
                               throws Exception

 Use this operation to modify certificates on NetScaler Instance(s) in bulk.
 

Throws:

Exception

gen_csr

public static ns_ssl_certkey gen_csr(nitro_service client,
                     ns_ssl_certkey resource)
                              throws Exception

 Use this operation to generate CSR for the certificate.
 

Throws:

Exception

gen_csr

public static ns_ssl_certkey[] gen_csr(nitro_service client,
                       ns_ssl_certkey[] resources)
                                throws Exception

 Use this operation to generate CSR for the certificate in bulk.
 

Throws:

Exception

get_filtered

public static ns_ssl_certkey[] get_filtered(nitro_service service,
                            String filter)
                                     throws Exception

Use this API to fetch filtered set of ns_ssl_certkey resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

get_filtered

public static ns_ssl_certkey[] get_filtered(nitro_service service,
                            filtervalue[] filter)
                                     throws Exception

Use this API to fetch filtered set of ns_ssl_certkey resources. set the filter parameter values in filtervalue object.

Throws:

Exception

count

public static long count(nitro_service service)
                  throws Exception

Use this API to count the ns_ssl_certkey resources configured on NetScaler SDX.

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  String filter)
                           throws Exception

Use this API to count the filtered set of ns_ssl_certkey resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  filtervalue[] filter)
                           throws Exception

Use this API to count the filtered set of ns_ssl_certkey resources. set the filter parameter values in filtervalue object.

Throws:

Exception

get_nitro_response

protected base_resource[] get_nitro_response(nitro_service service,
                                 String response)
                                      throws Exception

 Converts API response into object and returns the object array in case of get request.
 

Specified by:

get_nitro_response in class base_resource

Throws:

Exception

get_nitro_bulk_response

protected base_resource[] get_nitro_bulk_response(nitro_service service,
                                      String response)
                                           throws Exception

 Converts API response of bulk operation into object and returns the object array in case of get request.
 

Specified by:

get_nitro_bulk_response in class base_resource

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class base_resource

Parameters:

operationType - : add,delete,modify,get etc.

Throws:

Exception