DeploymentParams Data Type

Parameters for the deployment of a service and component.

Namespace
(Default)
Properties
name data type type namespace min/max occurs description
CustomAttributes list of CustomAttribute element 0/unbounded The custom attributes to apply to the deploy target. The target will inherit attributes from the source if not overriden by these attributes.
approved string element 0/1 Mark the deploy object as approved.
clusterName string element 0/1 The cluster to deploy the target to.
createLinkedClone string element 0/1 If true, a linked clone will be created; If snapshot parameter is null, a new snapshot will be created.
datacenterName string element 0/1 Gets the datacenter name.
datastoreName string element 0/1 The datastore to deploy the target to.
endOfLife string element 0/1 Mark the deploy object as End of Life.
expiryDate string element 0/1 The expiry date of the deploy target. [Null or empty string = No Expiry, 0 = Never Expires, and > 0 = expiry date set].
folderName string element 0/1 The name of the folder.
highAvailability string element 0/1 Indicate whether to deploy the targe to a suitable location meeting high availability criteria. Applicable only for Hyper-V targets.
managementServerName string element 0/1 Gets the management server name.
memoryInMB long element 1/1 The requested memory for the deploy object (in MB).
name string element 0/1 If set, the target will be deployed using the specified name. If not set, a unique name will be generated by the system.
nics list of VirtualMachineNIC element 0/unbounded Gets the nics.
numCPU int element 1/1 The requested number of CPUs.
ownership Ownership element 0/1 The ownership to apply to the deploy target. Only the organization name and user login Ids are required; the rest are optional.
powerOn string element 0/1 Power the target on after it is deployed.
releaseTarget string element 0/1 Release this component (mark it as completed).
releaseTargetComment string element 0/1 If releaseTarget is true, this is the corresponding comment.
resourcePoolName string element 0/1 The resource pool to deploy the target to.
snapshotId string element 0/1 If set, a clone will be created from this snapshot; applicable only if createLinkedClone is true.
suspect string element 0/1 Checks if is suspect.
targetHostName string element 0/1 The host to deploy the target to. This is not needed if deploying to a cluster.
Properties inherited from supportTemplating
xsitype string attribute 0/1  

Example

<DeploymentParams xsitype="...">
  <CustomAttributes>
    <allowedValues>...</allowedValues>
    <portalEditable>...</portalEditable>
    <enumerated>...</enumerated>
    <description>...</description>
    <targetManagedObjectTypes>...</targetManagedObjectTypes>
    <name>...</name>
    <value>...</value>
    <costItems/>
    <regularExpression>...</regularExpression>
    <validationMessage>...</validationMessage>
  </CustomAttributes>
  <expiryDate>...</expiryDate>
  <ownership xsitype="...">
    <organization>
      <displayName>...</displayName>
      <type>...</type>
      <id>...</id>
    </organization>
    <Owners>
      <id>...</id>
      <loginId>...</loginId>
      <displayName>...</displayName>
      <email>...</email>
      <itContact>...</itContact>
      <primary>...</primary>
    </Owners>
  </ownership>
  <memoryInMB>...</memoryInMB>
  <numCPU>...</numCPU>
  <releaseTarget>...</releaseTarget>
  <releaseTargetComment>...</releaseTargetComment>
  <datastoreName>...</datastoreName>
  <targetHostName>...</targetHostName>
  <resourcePoolName>...</resourcePoolName>
  <folderName>...</folderName>
  <snapshotId>...</snapshotId>
  <approved>...</approved>
  <suspect>...</suspect>
  <endOfLife>...</endOfLife>
  <createLinkedClone>...</createLinkedClone>
  <highAvailability>...</highAvailability>
  <powerOn>...</powerOn>
  <name>...</name>
  <clusterName>...</clusterName>
  <managementServerName>...</managementServerName>
  <datacenterName>...</datacenterName>
  <nics>
    <macAddress>...</macAddress>
    <adapterType>...</adapterType>
    <uniqueNetId>...</uniqueNetId>
    <logicalNetwork>...</logicalNetwork>
    <name>...</name>
    <addressType>...</addressType>
    <id>...</id>
    <summary>...</summary>
    <uuid>...</uuid>
    <vmId>...</vmId>
    <key>...</key>
    <label>...</label>
    <connected>...</connected>
    <startConnected>...</startConnected>
  </nics>
</DeploymentParams>