-
XenServer Software Development Kit
-
-
-
Class: Certificate
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
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 |
purpose |
certificate_purpose set |
RO/constructor | The purposes of the certificate |
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_purpose
Overview:
Get the purpose field of the given Certificate.
Signature:
certificate_purpose set get_purpose (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_purpose set
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
Share
Share
In this article
- 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_purpose
- RPC name: get_record
- RPC name: get_type
- RPC name: get_uuid
This Preview product documentation is Cloud Software Group Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Cloud Software Group Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Cloud Software Group product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.