REST API - set

vcenter cluster edrs algo parameter: set

Sets EDRS algorithm parameters for a given cluster. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Request:

HTTP request

PUT https://{server}/rest/vcenter/cluster/{cluster}/edrs/algo-parameter

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier of cluster whose EDRS need to be configured.

Request Body Structure:

{
    "params" : {
        "memory_scale_out_threshold" : 1,
        "vsan_scale_out_threshold" : 1,
        "vsan_scale_out_ewma_weight_percent" : 1,
        "vsan_scale_in_threshold" : 1,
        "min_hosts" : 1,
        "storage_scale_out_max_hosts" : 1,
        "cpu_scale_out_threshold" : 1,
        "memory_scale_out_ewma_weight_percent" : 1,
        "use_vsan_whatif30_api" : true,
        "generate_recommendation_event" : true,
        "storage_scale_out_only" : true,
        "cpu_scale_in_ewma_weight_percent" : 1,
        "cpu_scale_out_ewma_weight_percent" : 1,
        "memory_scale_in_threshold" : 1,
        "vsan_scale_in_ewma_weight_percent" : 1,
        "vsan_space_hard_limit" : 1,
        "cpu_scale_in_threshold" : 1,
        "max_hosts" : 1,
        "memory_scale_in_ewma_weight_percent" : 1
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
params	param	EDRS algorithm parameters need to be set.
params.generate_recommendation_event	boolean	Generate periodical EDRS recommendation event. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.max_hosts	long	Maximum number of hosts allowed in the cluster. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.min_hosts	long	Minimum number of hosts allowed in the cluster. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.cpu_scale_in_threshold	long	CPU low threshold to trigger scale in. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.cpu_scale_out_threshold	long	CPU high threshold to trigger scale out. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.cpu_scale_in_ewma_weight_percent	long	Weight to compute CPU usage EWMA to trigger scale in. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.cpu_scale_out_ewma_weight_percent	long	Weight to compute CPU usage EWMA to trigger scale out. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.memory_scale_in_threshold	long	Memory low threshold to trigger scale in. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.memory_scale_out_threshold	long	Memory high threshold to trigger scale out. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.memory_scale_in_ewma_weight_percent	long	Weight to compute memory usage EWMA to trigger scale in. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.memory_scale_out_ewma_weight_percent	long	Weight to compute memory usage EWMA to trigger scale out. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.vsan_scale_in_threshold	long	vSAN storage low threshold to trigger scale in. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.vsan_scale_out_threshold	long	vSAN storage high threshold to trigger scale out. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.vsan_scale_in_ewma_weight_percent	long	Weight to compute vSAN storage usage EWMA to trigger scale in. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.vsan_scale_out_ewma_weight_percent	long	Weight to compute vSAN storage usage EWMA to trigger scale out. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.storage_scale_out_only	boolean	Only vSAN storage scale out recommendation event can be generated. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.storage_scale_out_max_hosts	long	Maximum number of hosts allowed in the cluster when scale out for storage reason. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.vsan_space_hard_limit	long	vSAN storage space hard limit to trigger scale out. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.
params.use_vsan_whatif30_api	boolean	Use vSAN 3.0 What-if decommission api. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset, parameter will not be updated.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code	Type	Description
500	error	if input parameters have issues.
404	not_found	if the cluster is unknown.
403	unauthorized	if the user doesn't have the required privileges.