Xapi Project Docs

Class: Certificate

An X509 certificate used for TLS connections

Published in:

Citrix Hypervisor 8.2 (stockholm)

Enums

certificate_type

Values:	ca	Certificate that is trusted by the whole pool
	host	Certificate that identifies a single host to entities outside the pool
	host_internal	Certificate that identifies a single host to other pool members

Fields

Deprecated

string fingerprint [RO/constructor]

Use fingerprint_sha256 instead

Default value:	""
Published in:	Citrix Hypervisor 8.2 (stockholm)
Deprecated in:	XAPI 24.19.0 (24.19.0)

Prototype

string fingerprint_sha1 [RO/constructor]

The certificate's SHA1 fingerprint / hash

Default value:	""
Prototyped in:	XAPI 24.20.0 (24.20.0)

Prototype

string fingerprint_sha256 [RO/constructor]

The certificate's SHA256 fingerprint / hash

Default value:	""
Prototyped in:	XAPI 24.20.0 (24.20.0)

host ref host [RO/constructor]

The host where the certificate is installed

Default value:	OpaqueRef:NULL
Published in:	Citrix Hypervisor 8.2 (stockholm)

string name [RO/runtime]

The name of the certificate, only present on certificates of type 'ca'

Default value:	""
Published in:	XAPI 1.294.0 (1.294.0)

datetime not_after [RO/constructor]

Date before which the certificate is valid

Default value:	19700101T00:00:00Z
Published in:	Citrix Hypervisor 8.2 (stockholm)

datetime not_before [RO/constructor]

Date after which the certificate is valid

Default value:	19700101T00:00:00Z
Published in:	Citrix Hypervisor 8.2 (stockholm)

enum certificate_type type [RO/runtime]

The type of the certificate, either 'ca', 'host' or 'host_internal'

Default value:	host
Published in:	XAPI 1.294.0 (1.294.0)

string uuid [RO/runtime]

Unique identifier/object reference

Published in:

Citrix Hypervisor 8.2 (stockholm)

Messages

Certificate ref set get_all (session ref)

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

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	references to all objects
Published in:	Citrix Hypervisor 8.2 (stockholm)

(Certificate ref → Certificate record) map get_all_records (session ref)

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

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	records of all objects
Published in:	Citrix Hypervisor 8.2 (stockholm)

Certificate ref get_by_uuid (session ref, string)

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

Parameters:	session ref session_id	Reference to a valid session
	string uuid	UUID of object to return
Minimum role:	read-only
Result:	reference to the object
Published in:	Citrix Hypervisor 8.2 (stockholm)

Deprecated

string get_fingerprint (session ref, Certificate ref)

Get the fingerprint field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	Citrix Hypervisor 8.2 (stockholm)
Deprecated in:	XAPI 24.19.0 (24.19.0)

Prototype

string get_fingerprint_sha1 (session ref, Certificate ref)

Get the fingerprint_sha1 field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 24.20.0 (24.20.0)

Prototype

string get_fingerprint_sha256 (session ref, Certificate ref)

Get the fingerprint_sha256 field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 24.20.0 (24.20.0)

host ref get_host (session ref, Certificate ref)

Get the host field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	Citrix Hypervisor 8.2 (stockholm)

string get_name (session ref, Certificate ref)

Get the name field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XAPI 1.294.0 (1.294.0)

datetime get_not_after (session ref, Certificate ref)

Get the not_after field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	Citrix Hypervisor 8.2 (stockholm)

datetime get_not_before (session ref, Certificate ref)

Get the not_before field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	Citrix Hypervisor 8.2 (stockholm)

Certificate record get_record (session ref, Certificate ref)

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

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	all fields from the object
Published in:	Citrix Hypervisor 8.2 (stockholm)

enum certificate_type get_type (session ref, Certificate ref)

Get the type field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XAPI 1.294.0 (1.294.0)

string get_uuid (session ref, Certificate ref)

Get the uuid field of the given Certificate.

Parameters:	session ref session_id	Reference to a valid session
	Certificate ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	Citrix Hypervisor 8.2 (stockholm)

Class: Certificate

Enums

Fields

Messages Hide implicit

Classes

Messages