REST API - scale_out

vcenter ovf: scale out params

The scale_out_params structure contains information about the scale-out groups described in the OVF package.

When deploying an OVF package, a deployment specific instance count can be specified (see vcenter.ovf.scale_out_group.instance_count.

This is based on the ovf2:ScaleOutSection.

See deploy and filter.

Representation:

JSON

{
    "groups" : [
        {
            "maximum_instance_count" : 1,
            "description" : "string",
            "minimum_instance_count" : 1,
            "id" : "string",
            "instance_count" : 1
        },
        {
            "maximum_instance_count" : 1,
            "description" : "string",
            "minimum_instance_count" : 1,
            "id" : "string",
            "instance_count" : 1
        }
    ],
    "type" : "string"
}

Attributes:

Name	Type	Description
Optional
groups	scale_out_group[]	The array of scale-out groups. Optional. This field is optional in the input parameters when deploying an OVF package. If unset there are no scale-out groups. This field will always be present in the result when retrieving information about an OVF package.
groups[].id	string	The identifier of the scale-out group. 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.
groups[].description	string	The description of the scale-out group. 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.
groups[].instance_count	long	The scaling factor to use. It defines the number of replicas of the prototypical virtual system or virtual system collection. 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.
groups[].minimum_instance_count	long	The minimum scaling factor. 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. This will be 1 if there is no explicit limit.
groups[].maximum_instance_count	long	The maximum scaling factor. Optional. This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. This will be unset if there is no explicit limit.
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.