vcenter cluster edrs recommendation: recommendation
The
recommendation structure contains the recommend action, and all related details. This structure was added in vSphere API 7.0.1.0.Representation:
{
"hosts_to_remove" : [
"obj-103",
"obj-103"
],
"no_action_reasons" : [
{
"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" : {}
}
}
}
}
}
}
},
{
"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" : {}
}
}
}
}
}
}
}
],
"hosts" : [
"obj-103",
"obj-103"
],
"action" : "SCALE_OUT",
"is_edrs_enabled" : true,
"utilization" : {
"memory_scale_out_threshold" : 1,
"vsan_scale_out_threshold" : 1,
"vsan_scale_out_utilization" : 1,
"cpu_scale_out_utilization" : 1,
"vsan_scale_in_utilization" : 1,
"memory_scale_out_utilization" : 1,
"vsan_scale_in_threshold" : 1,
"cpu_scale_out_threshold" : 1,
"memory_scale_in_threshold" : 1,
"cpu_scale_in_threshold" : 1,
"vsan_utilization" : 1,
"cpu_scale_in_utilization" : 1,
"memory_scale_in_utilization" : 1
}
}
"hosts_to_remove" : [
"obj-103",
"obj-103"
],
"no_action_reasons" : [
{
"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" : {}
}
}
}
}
}
}
},
{
"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" : {}
}
}
}
}
}
}
}
],
"hosts" : [
"obj-103",
"obj-103"
],
"action" : "SCALE_OUT",
"is_edrs_enabled" : true,
"utilization" : {
"memory_scale_out_threshold" : 1,
"vsan_scale_out_threshold" : 1,
"vsan_scale_out_utilization" : 1,
"cpu_scale_out_utilization" : 1,
"vsan_scale_in_utilization" : 1,
"memory_scale_out_utilization" : 1,
"vsan_scale_in_threshold" : 1,
"cpu_scale_out_threshold" : 1,
"memory_scale_in_threshold" : 1,
"cpu_scale_in_threshold" : 1,
"vsan_utilization" : 1,
"cpu_scale_in_utilization" : 1,
"memory_scale_in_utilization" : 1
}
}
{
"hosts_to_remove" : [
"obj-103",
"obj-103"
],
"no_action_reasons" : [
{
"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"
}
]
},
{
"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"
}
]
}
],
"hosts" : [
"obj-103",
"obj-103"
],
"action" : "SCALE_OUT",
"is_edrs_enabled" : true,
"utilization" : {
"memory_scale_out_threshold" : 1,
"vsan_scale_out_threshold" : 1,
"vsan_scale_out_utilization" : 1,
"cpu_scale_out_utilization" : 1,
"vsan_scale_in_utilization" : 1,
"memory_scale_out_utilization" : 1,
"vsan_scale_in_threshold" : 1,
"cpu_scale_out_threshold" : 1,
"memory_scale_in_threshold" : 1,
"cpu_scale_in_threshold" : 1,
"vsan_utilization" : 1,
"cpu_scale_in_utilization" : 1,
"memory_scale_in_utilization" : 1
}
}
"hosts_to_remove" : [
"obj-103",
"obj-103"
],
"no_action_reasons" : [
{
"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"
}
]
},
{
"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"
}
]
}
],
"hosts" : [
"obj-103",
"obj-103"
],
"action" : "SCALE_OUT",
"is_edrs_enabled" : true,
"utilization" : {
"memory_scale_out_threshold" : 1,
"vsan_scale_out_threshold" : 1,
"vsan_scale_out_utilization" : 1,
"cpu_scale_out_utilization" : 1,
"vsan_scale_in_utilization" : 1,
"memory_scale_out_utilization" : 1,
"vsan_scale_in_threshold" : 1,
"cpu_scale_out_threshold" : 1,
"memory_scale_in_threshold" : 1,
"cpu_scale_in_threshold" : 1,
"vsan_utilization" : 1,
"cpu_scale_in_utilization" : 1,
"memory_scale_in_utilization" : 1
}
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.is_edrs_enabled | boolean | This is true if the EDRS is enabled in the cluster. This attribute was added in vSphere API 7.0.1.0. |
| -.action | string | Specifies the recommend action. This attribute was added in vSphere API 7.0.1.0. Defines the recommend action given by EDRS. This enumeration was added in vSphere API 7.0.1.0. Value is one of: SCALE_OUT: Recomend scale out - to add host into the cluster. This constant was added in vSphere API 7.0.1.0. SCALE_IN: Recommend scale in - to remove hosts from the cluster. This constant was added in vSphere API 7.0.1.0. NO_ACTION: No action is needed. It could because either cluster resources are well utilized, or scale in recommendation is supressed since no host can be evacuated. This constant was added in vSphere API 7.0.1.0. |
| -.no_action_reasons[].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. |
| -.no_action_reasons[].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. |
| -.no_action_reasons[].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. |
| -.hosts | string[] | A set of available hosts which were seen by EDRS when the recommendation was made. This attribute was added in vSphere API 7.0.1.0. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem. |
| -.utilization | utilization_info | Contains the cluster resource utilization and corresponding threshold values that EDRS recommendation based on. This attribute was added in vSphere API 7.0.1.0. |
| -.utilization.cpu_scale_in_threshold | long | Threshold to determine whether CPU load is low. This attribute was added in vSphere API 7.0.1.0. |
| -.utilization.cpu_scale_in_utilization | long | Estimate of CPU low utilization. This attribute was added in vSphere API 7.0.1.0. |
| -.utilization.cpu_scale_out_threshold | long | Threshold to determine whether CPU load is high. This attribute was added in vSphere API 7.0.1.0. |
| -.utilization.cpu_scale_out_utilization | long | Estimate of CPU high utilization. This attribute was added in vSphere API 7.0.1.0. |
| -.utilization.memory_scale_in_threshold | long | Threshold to determine whether memory usage is low. This attribute was added in vSphere API 7.0.1.0. |
| -.utilization.memory_scale_in_utilization | long | Estimate of memory low utilization. This attribute was added in vSphere API 7.0.1.0. |
| -.utilization.memory_scale_out_threshold | long | Threshold to determine whether memory usage is high. This attribute was added in vSphere API 7.0.1.0. |
| -.utilization.memory_scale_out_utilization | long | Estimate of memory high utilization. This attribute was added in vSphere API 7.0.1.0. |
| Optional | ||
| -.hosts_to_remove | string[] | Hosts that should be removed from the cluster for a SCALE_IN recommendation. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when action has value SCALE_IN. This field is optional and it is only relevant when the value of action is SCALE_IN.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem. |
| -.no_action_reasons | localizable_message[] | The reasons why NO_ACTION is recommended. The recommendation could be NO_ACTION because all resources are well utilized or because something is preventing recommending SCALE_IN even though resources utilization is low. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when action has value NO_ACTION. This field is optional and it is only relevant when the value of action is NO_ACTION. |
| -.utilization.vsan_scale_in_threshold | long | Threshold to determine whether VSAN usage is low. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
| -.utilization.vsan_scale_in_utilization | long | Estimate of VSAN low utilization. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
| -.utilization.vsan_scale_out_threshold | long | Threshold to determine whether VSAN usage is high. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
| -.utilization.vsan_scale_out_utilization | long | Estimate of VSAN high utilization. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
| -.utilization.vsan_utilization | long | Actual VSAN utilization. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| is_edrs_enabled | boolean | This is true if the EDRS is enabled in the cluster. This attribute was added in vSphere API 7.0.1.0. |
| action | string | Specifies the recommend action. This attribute was added in vSphere API 7.0.1.0. Defines the recommend action given by EDRS. This enumeration was added in vSphere API 7.0.1.0. Value is one of: SCALE_OUT: Recomend scale out - to add host into the cluster. This constant was added in vSphere API 7.0.1.0. SCALE_IN: Recommend scale in - to remove hosts from the cluster. This constant was added in vSphere API 7.0.1.0. NO_ACTION: No action is needed. It could because either cluster resources are well utilized, or scale in recommendation is supressed since no host can be evacuated. This constant was added in vSphere API 7.0.1.0. |
| no_action_reasons[].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. |
| no_action_reasons[].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. |
| no_action_reasons[].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. |
| hosts | string[] | A set of available hosts which were seen by EDRS when the recommendation was made. This attribute was added in vSphere API 7.0.1.0. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem. |
| utilization | utilization_info | Contains the cluster resource utilization and corresponding threshold values that EDRS recommendation based on. This attribute was added in vSphere API 7.0.1.0. |
| utilization.cpu_scale_in_threshold | long | Threshold to determine whether CPU load is low. This attribute was added in vSphere API 7.0.1.0. |
| utilization.cpu_scale_in_utilization | long | Estimate of CPU low utilization. This attribute was added in vSphere API 7.0.1.0. |
| utilization.cpu_scale_out_threshold | long | Threshold to determine whether CPU load is high. This attribute was added in vSphere API 7.0.1.0. |
| utilization.cpu_scale_out_utilization | long | Estimate of CPU high utilization. This attribute was added in vSphere API 7.0.1.0. |
| utilization.memory_scale_in_threshold | long | Threshold to determine whether memory usage is low. This attribute was added in vSphere API 7.0.1.0. |
| utilization.memory_scale_in_utilization | long | Estimate of memory low utilization. This attribute was added in vSphere API 7.0.1.0. |
| utilization.memory_scale_out_threshold | long | Threshold to determine whether memory usage is high. This attribute was added in vSphere API 7.0.1.0. |
| utilization.memory_scale_out_utilization | long | Estimate of memory high utilization. This attribute was added in vSphere API 7.0.1.0. |
| Optional | ||
| hosts_to_remove | string[] | Hosts that should be removed from the cluster for a SCALE_IN recommendation. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when action has value SCALE_IN. This field is optional and it is only relevant when the value of action is SCALE_IN.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem. |
| no_action_reasons | localizable_message[] | The reasons why NO_ACTION is recommended. The recommendation could be NO_ACTION because all resources are well utilized or because something is preventing recommending SCALE_IN even though resources utilization is low. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when action has value NO_ACTION. This field is optional and it is only relevant when the value of action is NO_ACTION. |
| utilization.vsan_scale_in_threshold | long | Threshold to determine whether VSAN usage is low. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
| utilization.vsan_scale_in_utilization | long | Estimate of VSAN low utilization. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
| utilization.vsan_scale_out_threshold | long | Threshold to determine whether VSAN usage is high. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
| utilization.vsan_scale_out_utilization | long | Estimate of VSAN high utilization. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |
| utilization.vsan_utilization | long | Actual VSAN utilization. This attribute was added in vSphere API 7.0.1.0. Optional. If VSAN is not availiable in cluster. |