REST API - scale_out

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 com.vmware.vcenter.ovf.scale_out_group.instance_count.

This is based on the ovf2:ScaleOutSection.

See deploy and filter.

Representations:

JSON
XML

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

<?xml version="1.0" ?>
<ns0:ScaleOutParams xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <groups-array>
    <array-item>
      <id>string</id>
      <description>string</description>
      <instance_count>10</instance_count>
      <minimum_instance_count>10</minimum_instance_count>
      <maximum_instance_count>10</maximum_instance_count>
    </array-item>
    <array-item>
      <id>string</id>
      <description>string</description>
      <instance_count>10</instance_count>
      <minimum_instance_count>10</minimum_instance_count>
      <maximum_instance_count>10</maximum_instance_count>
    </array-item>
  </groups-array>
</ns0:ScaleOutParams>

Attributes:

Name	Type	Required	Description
groups	List<scale_out_group>	Read	The array of scale-out groups.
type	string	Create, Read	Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure.