content library item updatesession: preview info
The
preview_info structure contains information about the files being uploaded in the update session. This structure was added in vSphere API 6.8.Representation:
{
"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" : {}
}
}
}
}
}
}
}
}
],
"state" : "UNAVAILABLE",
"certificate_info" : {
"x509" : "string",
"subject" : "string",
"self_signed" : true,
"issuer" : "string"
}
}
"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" : {}
}
}
}
}
}
}
}
}
],
"state" : "UNAVAILABLE",
"certificate_info" : {
"x509" : "string",
"subject" : "string",
"self_signed" : true,
"issuer" : "string"
}
}
{
"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"
}
]
}
}
],
"state" : "UNAVAILABLE",
"certificate_info" : {
"x509" : "string",
"subject" : "string",
"self_signed" : true,
"issuer" : "string"
}
}
"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"
}
]
}
}
],
"state" : "UNAVAILABLE",
"certificate_info" : {
"x509" : "string",
"subject" : "string",
"self_signed" : true,
"issuer" : "string"
}
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.state | string | Indicates the state of the preview of the update session. This attribute was added in vSphere API 6.8. Defines the state of the update session's preview. This enumeration was added in vSphere API 6.8. Value is one of: UNAVAILABLE: There are no files in the update session OR a preview is not possible for the files currently in the update session. However, preview may be possible after metadata files such as OVF descriptor are added to the session. In this case the state will transition to PREPARING. This constant was added in vSphere API 6.8.NOT_APPLICABLE: Preview is not possible for this update session. This state is reached when there are no metadata files in the update session and user invokes a session complete operation. This constant was added in vSphere API 6.8. PREPARING: A preview is being prepared for the files currently in the update session. This state is reached when the applicable metadata files are added to the update session but their content is not fully uploaded yet. For OVF item type, this state indicates that the OVF descriptor file is currently being uploaded. This constant was added in vSphere API 6.8. AVAILABLE: Preview is available for this update session. It is possible to review certificate details and warnings, if any. This state is reached when the applicable metadata files in the session have been fully uploaded. This constant was added in vSphere API 6.8. |
| -.certificate_info.issuer | string | Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. This attribute was added in vSphere API 6.8. |
| -.certificate_info.subject | string | Certificate subject. For example: C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. This attribute was added in vSphere API 6.8. |
| -.certificate_info.self_signed | boolean | Whether the certificate is self-signed. This attribute was added in vSphere API 6.8. |
| -.certificate_info.x509 | string | The X509 representation of the certificate. This attribute was added in vSphere API 6.8. |
| -.warnings[].type | string | The warning type raised during preview of the update session. This attribute was added in vSphere API 6.8. Defines the warnings which can be raised during the update session. This enumeration was added in vSphere API 6.8. Value is one of: SELF_SIGNED_CERTIFICATE: The certificate used for signing the content is self-signed. This constant was added in vSphere API 6.8. EXPIRED_CERTIFICATE: The certificate used for signing the content is expired. This constant was added in vSphere API 6.8. NOT_YET_VALID_CERTIFICATE: The certificate used for signing the content is not yet valid. This constant was added in vSphere API 6.8. UNTRUSTED_CERTIFICATE: The certificate used for signing the content is not trusted. This constant was added in vSphere API 6.8. |
| -.warnings[].message | localizable_message | The message specifying more details about the warning. This attribute was added in vSphere API 6.8. |
| -.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 | ||
| -.certificate_info | certificate_info | The certificate information of the signed update session content. This attribute was added in vSphere API 6.8. Optional. It is only relevant when state has value AVAILABLE. This field is unset if the update session content is not signed. |
| -.warnings | preview_warning_info[] | The list of warnings raised for this update session. Any warning which is not ignored by the client will, by default, fail the update session during session complete operation. This attribute was added in vSphere API 6.8. Optional. It is only relevant when state has value AVAILABLE. This field is optional and it is only relevant when the value of state is AVAILABLE. |
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| state | string | Indicates the state of the preview of the update session. This attribute was added in vSphere API 6.8. Defines the state of the update session's preview. This enumeration was added in vSphere API 6.8. Value is one of: UNAVAILABLE: There are no files in the update session OR a preview is not possible for the files currently in the update session. However, preview may be possible after metadata files such as OVF descriptor are added to the session. In this case the state will transition to PREPARING. This constant was added in vSphere API 6.8.NOT_APPLICABLE: Preview is not possible for this update session. This state is reached when there are no metadata files in the update session and user invokes a session complete operation. This constant was added in vSphere API 6.8. PREPARING: A preview is being prepared for the files currently in the update session. This state is reached when the applicable metadata files are added to the update session but their content is not fully uploaded yet. For OVF item type, this state indicates that the OVF descriptor file is currently being uploaded. This constant was added in vSphere API 6.8. AVAILABLE: Preview is available for this update session. It is possible to review certificate details and warnings, if any. This state is reached when the applicable metadata files in the session have been fully uploaded. This constant was added in vSphere API 6.8. |
| certificate_info.issuer | string | Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. This attribute was added in vSphere API 6.8. |
| certificate_info.subject | string | Certificate subject. For example: C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. This attribute was added in vSphere API 6.8. |
| certificate_info.self_signed | boolean | Whether the certificate is self-signed. This attribute was added in vSphere API 6.8. |
| certificate_info.x509 | string | The X509 representation of the certificate. This attribute was added in vSphere API 6.8. |
| warnings[].type | string | The warning type raised during preview of the update session. This attribute was added in vSphere API 6.8. Defines the warnings which can be raised during the update session. This enumeration was added in vSphere API 6.8. Value is one of: SELF_SIGNED_CERTIFICATE: The certificate used for signing the content is self-signed. This constant was added in vSphere API 6.8. EXPIRED_CERTIFICATE: The certificate used for signing the content is expired. This constant was added in vSphere API 6.8. NOT_YET_VALID_CERTIFICATE: The certificate used for signing the content is not yet valid. This constant was added in vSphere API 6.8. UNTRUSTED_CERTIFICATE: The certificate used for signing the content is not trusted. This constant was added in vSphere API 6.8. |
| warnings[].message | localizable_message | The message specifying more details about the warning. This attribute was added in vSphere API 6.8. |
| 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 | ||
| certificate_info | certificate_info | The certificate information of the signed update session content. This attribute was added in vSphere API 6.8. Optional. It is only relevant when state has value AVAILABLE. This field is unset if the update session content is not signed. |
| warnings | preview_warning_info[] | The list of warnings raised for this update session. Any warning which is not ignored by the client will, by default, fail the update session during session complete operation. This attribute was added in vSphere API 6.8. Optional. It is only relevant when state has value AVAILABLE. This field is optional and it is only relevant when the value of state is AVAILABLE. |