Develop for XenServer

Class: Certificate

October 11, 2024

Contributed by:

X X

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: Certificate

October 11, 2024

Contributed by:

X X

October 11, 2024

Contributed by:

X X

Class: Certificate

Fields for class: Certificate

RPCs associated with class: Certificate

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_fingerprint

RPC name: get_fingerprint_sha1

RPC name: get_fingerprint_sha256

RPC name: get_host

RPC name: get_name

RPC name: get_not_after

RPC name: get_not_before

RPC name: get_record

RPC name: get_type

RPC name: get_uuid

In this article