CreateCampaignRequest

CreateCampaignRequest
CreateCampaignRequest

A new enrollment campaign.

JSON Example
{
    "name": "string",
    "scopeType": "string",
    "vcenterConnectionId": "string",
    "clusterMoRef": "string",
    "concurrencyLimit": 0,
    "hypervisorPks": [
        0
    ],
    "securityGroupId": 0,
    "autoStart": false
}
string
name
Required  

Must not be blank

scopeType
Required  

Which hosts a campaign targets.

  • FLEET: All registered hosts are resolved as targets, but each job fails with 'Fleet-wide enrollment is not supported' and nothing is enrolled; also the default of the stored campaign
  • VCENTER: The hosts of the vCenter connection named in vcenterConnectionId; a job runs only while that vCenter has Auto Enrollment enabled and otherwise fails
  • CLUSTER: The hosts whose parentLocator equals clusterMoRef
  • SELECTION: The hosts named in hypervisorPks
  • AUTO_DISCOVERY: Created by the Console for a vCenter with Auto Enrollment enabled; its jobs wait while automatic enrollment is paused
Enumeration: FLEET, VCENTER, CLUSTER, SELECTION, AUTO_DISCOVERY
string
vcenterConnectionId
Optional

For scopeType VCENTER or CLUSTER

string
clusterMoRef
Optional

For scopeType CLUSTER

integer As int32 As int32
concurrencyLimit
Optional

Most jobs of one vCenter that may be started at the same time for this campaign. 5 when absent or not above 0; the default is fixed and does not follow the configured per-vCenter limit (only automatic campaigns use that setting)

array of integer
hypervisorPks
Optional

For scopeType SELECTION

integer As int64 As int64
securityGroupId
Optional

Identifier of the Security Group to record with the campaign; null when none is given

boolean
autoStart
Optional

Whether the campaign starts at creation; true when omitted, and when false the campaign stays CREATED until it is started