PolicyApiInputDTO

Description

Model to describe a Placement Policy

Required Parameters

policyName
  • type: string

  • description: Name of the policy

type
  • type: string

  • description: Placement Policy Type

  • enum: ['AT_MOST_N', 'BIND_TO_GROUP', 'BIND_TO_COMPLEMENTARY_GROUP', 'MUST_RUN_TOGETHER', 'AT_MOST_N_BOUND', 'MERGE', 'BIND_TO_GROUP_AND_LICENSE', 'MUST_NOT_RUN_TOGETHER', 'EXCLUSIVE_BIND_TO_GROUP']

Optional Parameters

sellerUuid
  • type: string

  • description: Uuid of the provider Group in a Placement Policy

buyerUuid
  • type: string

  • description: Uuid of the consumer Group in a Placement Policy

mergeUuids
  • type: array

  • description: Uuids of the Groups in a Merge Policy

    • type: string

mergeType
  • type: string

  • description: Group Type in a Merge Policy

  • enum: ['Cluster', 'StorageCluster', 'DataCenter', 'DesktopPool']

capacity
  • type: integer

  • format: int32

  • description: For an AT_MOST_N or AT_MOST_N_BOUND policy, the number of consumers to allow on a provider entity

enableCreateResourcePool
  • type: boolean

  • description: Enable create resource pool during cross VM moves, used when type is any but MERGE.When enabled resource pool, of which VM is part of at source , is created in destination if it does not exists in destination during a cross cluster or vcenter VM move.By default this is disabled(false)

enabled
  • type: boolean

  • description: Whether to enable the policy

providerEntityType
  • type: string

  • description: The entity type for the provider. This property is only applicable when the policy type is set to MUST_RUN_TOGETHER or MUST_NOT_RUN_TOGETHER. This field is set with the provider type (for example, PhysicalMachine) the policy should respect.

  • enum: ['Application', 'ApplicationComponent', 'ApplicationServer', 'AvailabilityZone', 'BusinessAccount', 'BusinessApplication', 'BusinessTransaction', 'BusinessUser', 'Chassis', 'CloudService', 'ComputeTier', 'Container', 'ContainerPod', 'ContainerSpec', 'Database', 'DatabaseServer', 'DatabaseServerTier', 'DatabaseTier', 'DataCenter', 'DesktopPool', 'DiskArray', 'DPod', 'HCIPhysicalMachine', 'HypervisorServer', 'Internet', 'IOModule', 'LoadBalancer', 'LogicalPool', 'Namespace', 'Network', 'PhysicalMachine', 'ProcessorPool', 'Region', 'ReservedInstance', 'Service', 'ServiceProvider', 'Storage', 'StorageController', 'StorageTier', 'Switch', 'Unknown', 'ViewPod', 'VirtualApplication', 'VirtualDataCenter', 'VirtualMachine', 'VirtualVolume', 'VPod', 'WorkloadController', 'ContainerPlatformCluster', 'CloudCommitment', 'ApplicationComponentSpec', 'VirtualMachineSpec', 'DocumentCollection', 'NodeGroup', 'PowerVMPhysicalMachine', 'DataWarehouse', 'DataWarehouseTier']