REST API - scale_out

vcenter ovf: scale out group

The scale_out_group structure contains information about a scale-out group.

It allows a virtual system collection to contain a set of children that are homogeneous with respect to a prototypical virtual system or virtual system collection. It shall cause the deployment function to replicate the prototype a number of times, thus allowing the number of instantiated virtual systems to be configured dynamically at deployment time.

This is based on the ovf2:ScaleOutSection.

See deploy and filter.

Representation:

JSON

{
    "description": "string",
    "id": "string",
    "instance_count": 1,
    "maximum_instance_count": 1,
    "minimum_instance_count": 1
}

Attributes:

Name	Type	Description
Optional
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.
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.
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.
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.
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.