vcenter ovf: certificate params
The
certificate_params structure contains information about the public key certificate used to sign the OVF package. This structure will only be returned if the OVF package is signed. Representation:
{
"x509" : "string",
"subject" : "string",
"is_valid" : true,
"warnings" : [
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"is_self_signed" : true,
"type" : "string",
"issuer" : "string"
}
"x509" : "string",
"subject" : "string",
"is_valid" : true,
"warnings" : [
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"is_self_signed" : true,
"type" : "string",
"issuer" : "string"
}
{
"x509" : "string",
"subject" : "string",
"is_valid" : true,
"warnings" : [
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"is_self_signed" : true,
"type" : "string",
"issuer" : "string"
}
"x509" : "string",
"subject" : "string",
"is_valid" : true,
"warnings" : [
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"is_self_signed" : true,
"type" : "string",
"issuer" : "string"
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.warnings[].type | string | The warning type raised during the OVF package deployment. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines the warnings which can be raised during the OVF package deployment. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: SELF_SIGNED_CERTIFICATE: The certificate used for signing the OVF package content is self-signed. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. EXPIRED_CERTIFICATE: The certificate used for signing the OVF package content is expired. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. NOT_YET_VALID_CERTIFICATE: The certificate used for signing the OVF package content is not yet valid. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. UNTRUSTED_CERTIFICATE: The certificate used for signing the OVF package content is not trusted. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.warnings[].message | localizable_message | The message specifying more details about the warning. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.warnings[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.warnings[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.warnings[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| Optional | ||
| -.issuer | string | Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| -.subject | string | Certificate subject. For example: /C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| -.is_valid | boolean | Is the certificate chain validated. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| -.is_self_signed | boolean | Is the certificate self-signed. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| -.x509 | string | The X509 representation of the certificate. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| -.warnings | warning_info[] | The list of warnings raised for the OVF certificate used in this OVF package deployment. Any warning that is not ignored by the client will cause the OVF package deployment to fail. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. This field is set only if the certificate has warnings when retrieving information about an OVF package by filter. When the field is set, the vcenter.ovf.warning_info.ignored field can be updated before the OVF parameter is passed to deploy to deploy the OVF package. |
| -.type | string | Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. Optional. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| warnings[].type | string | The warning type raised during the OVF package deployment. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines the warnings which can be raised during the OVF package deployment. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: SELF_SIGNED_CERTIFICATE: The certificate used for signing the OVF package content is self-signed. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. EXPIRED_CERTIFICATE: The certificate used for signing the OVF package content is expired. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. NOT_YET_VALID_CERTIFICATE: The certificate used for signing the OVF package content is not yet valid. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. UNTRUSTED_CERTIFICATE: The certificate used for signing the OVF package content is not trusted. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| warnings[].message | localizable_message | The message specifying more details about the warning. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| warnings[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| warnings[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| warnings[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| Optional | ||
| issuer | string | Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| subject | string | Certificate subject. For example: /C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| is_valid | boolean | Is the certificate chain validated. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| is_self_signed | boolean | Is the certificate self-signed. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| x509 | string | The X509 representation of the certificate. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| warnings | warning_info[] | The list of warnings raised for the OVF certificate used in this OVF package deployment. Any warning that is not ignored by the client will cause the OVF package deployment to fail. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. This field is set only if the certificate has warnings when retrieving information about an OVF package by filter. When the field is set, the vcenter.ovf.warning_info.ignored field can be updated before the OVF parameter is passed to deploy to deploy the OVF package. |
| type | string | Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. Optional. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |