appliance support bundle: info
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Representation:
{
"downloadable" : true,
"size" : 1,
"expiration_time" : "2015-01-01T22:13:05.651Z",
"description" : "string",
"generation_time" : "2015-01-01T22:13:05.651Z",
"failure_reason" : {
"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" : {}
}
}
}
}
}
}
},
"url" : "http://myurl.com",
"status" : "SUCCEEDED"
}
"downloadable" : true,
"size" : 1,
"expiration_time" : "2015-01-01T22:13:05.651Z",
"description" : "string",
"generation_time" : "2015-01-01T22:13:05.651Z",
"failure_reason" : {
"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" : {}
}
}
}
}
}
}
},
"url" : "http://myurl.com",
"status" : "SUCCEEDED"
}
{
"downloadable" : true,
"size" : 1,
"expiration_time" : "2015-01-01T22:13:05.651Z",
"description" : "string",
"generation_time" : "2015-01-01T22:13:05.651Z",
"failure_reason" : {
"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"
}
]
},
"url" : "http://myurl.com",
"status" : "SUCCEEDED"
}
"downloadable" : true,
"size" : 1,
"expiration_time" : "2015-01-01T22:13:05.651Z",
"description" : "string",
"generation_time" : "2015-01-01T22:13:05.651Z",
"failure_reason" : {
"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"
}
]
},
"url" : "http://myurl.com",
"status" : "SUCCEEDED"
}
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
-.description | string | Support bundle creation description. 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. |
-.status | string | Status of the task. 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. 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: SUCCEEDED: Support bundle creation task succeeded. 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. FAILED: Support bundle creation task Failed. 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. CANCELLED: Support bundle creation task Cancelled. 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. |
-.failure_reason.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. |
-.failure_reason.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. |
-.failure_reason.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 | ||
-.generation_time | date_time | Support bundle generation time. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
-.url | URI | Support bundle downlooad URL. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
-.expiration_time | date_time | Download expiration time. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
-.downloadable | boolean | Support bundle availability for download. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
-.size | long | Support bundle file size in KBs. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
-.failure_reason | localizable_message | Reason for failure. 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. It is only relevant when status has value FAILED. This field is optional and it is only relevant when the value of status is FAILED. |
-.failure_reason.params | object | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
-.failure_reason.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
description | string | Support bundle creation description. 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. |
status | string | Status of the task. 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. 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: SUCCEEDED: Support bundle creation task succeeded. 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. FAILED: Support bundle creation task Failed. 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. CANCELLED: Support bundle creation task Cancelled. 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. |
failure_reason.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. |
failure_reason.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. |
failure_reason.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 | ||
generation_time | date_time | Support bundle generation time. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
url | URI | Support bundle downlooad URL. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
expiration_time | date_time | Download expiration time. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
downloadable | boolean | Support bundle availability for download. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
size | long | Support bundle file size in KBs. 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. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED. |
failure_reason | localizable_message | Reason for failure. 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. It is only relevant when status has value FAILED. This field is optional and it is only relevant when the value of status is FAILED. |
failure_reason.params | list | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
failure_reason.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |