Develop for XenServer

Class: Certificate

An X509 certificate used for TLS connections

Fields for class: Certificate

Field Type Qualifier Description
fingerprint string RO/constructor Deprecated. Use fingerprint_sha256 instead
fingerprint_sha1 string RO/constructor The certificate’s SHA1 fingerprint / hash
fingerprint_sha256 string RO/constructor The certificate’s SHA256 fingerprint / hash
host host ref RO/constructor The host where the certificate is installed
name string RO/runtime The name of the certificate, only present on certificates of type ‘ca’
not_after datetime RO/constructor Date before which the certificate is valid
not_before datetime RO/constructor Date after which the certificate is valid
type certificate_type RO/runtime The type of the certificate, either ‘ca’, ‘host’ or ‘host_internal’
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: Certificate

RPC name: get_all

Overview:

Return a list of all the Certificates known to the system.

Signature:

Certificate ref set get_all (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session

Minimum Role: read-only

Return Type: Certificate ref set

references to all objects

RPC name: get_all_records

Overview:

Return a map of Certificate references to Certificate records for all Certificates known to the system.

Signature:

(Certificate ref -> Certificate record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session

Minimum Role: read-only

Return Type: (Certificate ref -> Certificate record) map

records of all objects

RPC name: get_by_uuid

Overview:

Get a reference to the Certificate instance with the specified UUID.

Signature:

Certificate ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return

Minimum Role: read-only

Return Type: Certificate ref

reference to the object

RPC name: get_fingerprint

This message is deprecated.

Overview:

Get the fingerprint field of the given Certificate.

Signature:

string get_fingerprint (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_fingerprint_sha1

Overview:

Get the fingerprint_sha1 field of the given Certificate.

Signature:

string get_fingerprint_sha1 (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_fingerprint_sha256

Overview:

Get the fingerprint_sha256 field of the given Certificate.

Signature:

string get_fingerprint_sha256 (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_host

Overview:

Get the host field of the given Certificate.

Signature:

host ref get_host (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: host ref

value of the field

RPC name: get_name

Overview:

Get the name field of the given Certificate.

Signature:

string get_name (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_not_after

Overview:

Get the not_after field of the given Certificate.

Signature:

datetime get_not_after (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_not_before

Overview:

Get the not_before field of the given Certificate.

Signature:

datetime get_not_before (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_record

Overview:

Get a record containing the current state of the given Certificate.

Signature:

Certificate record get_record (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: Certificate record

all fields from the object

RPC name: get_type

Overview:

Get the type field of the given Certificate.

Signature:

certificate_type get_type (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: certificate_type

value of the field

RPC name: get_uuid

Overview:

Get the uuid field of the given Certificate.

Signature:

string get_uuid (session ref session_ref, Certificate ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field