Skip to Content

Request Virtual Machine operation

The Request Virtual Machine operation enables you to request a virtual machine.

The following table describes the elements for the Request Virtual Machine operation.


 Adapter request elements for the Request Virtual Machine operation

The following figure illustrates the sample adapter request for the Request Virtual Machine operation.

 XML sample of the adapter request for the Request Virtual Machine operation

<vmware-lifecycle-manager-request>
  <request>
  <operation-name>execute-workflow</operation-name>
  <parameters>
  <workflow-name>Request Virtual Machine</workflow-name>
    <item>
      <name>location</name>
      <type>lcm:ProvisionInfrastructureCriteriaValue</type>
      <value>AMER</value>
    </item>
    <item>
      <name>organization</name>
      <type>lcm:ProvisionInfrastructureCriteriaValue</type>
      <value>Development</value>
    </item>
    <item>
      <name>serverEnvironment</name>
      <type>lcm:ProvisionInfrastructureCriteriaValue</type>
      <value>Dev</value>
    </item>
    <item>
      <name>serviceLevel</name>
      <type>lcm:ProvisionInfrastructureCriteriaValue</type>
      <value>Standard</value>
    </item>
    <item>
      <name>performance</name>
      <type>lcm:ProvisionInfrastructureCriteriaValue</type>
      <value>Low</value>
    </item>
    <item>
      <name>startDate</name>
      <type>Date</type>
      <value>20090225063118-0500</value>
    </item>
    <item>
      <name>endDate</name>
      <type>Date</type>
      <value>20090525063118-0500</value>
      </item>
      <item>
      <name>vmStart</name>
      <type>boolean</type>
      <value>false</value>
    </item>
    <item>
      <name>groupControle</name>
      <type>LdapGroup</type>
      <value>CN=LCM Administrators,CN=Users,DC=rbavmware,DC=bmc,DC=com</value>
    </item>
    <item>
      <name>groupView</name>
      <type>LdapGroup</type>
      <value>CN=LCM Requesters,CN=Users,DC=rbavmware,DC=bmc,DC=com</value>
    </item>
    <item>
      <name>templateProfile</name>
      <type>lcm:TemplateProfile</type>
      <value>template01</value>
    </item>
    <item>
      <name>startDateDefined</name>
      <type>boolean</type>
      <value>true</value>
    </item>
    <item>
      <name>shapingTemplate</name>
      <type>lcm:ShapingTemplate</type>
      <value>1</value>
    </item>
    <item>
      <name>shapingChange</name>
      <type>boolean</type>
      <value>false</value>
    </item>
    <item>
      <name>shapingName</name>
      <type>string</type>
      <value></value>
    </item>
    <item>
      <name>memoryReservation</name>
      <type>number</type>
      <value></value>
    </item>
    <item>
      <name>memoryLimit</name>
      <type>number</type>
      <value></value>
    </item>
    <item>
      <name>memoryShares</name>
      <type>VMware3:SharesLevel</type>
      <value></value>
    </item>
    <item>
      <name>cpuCount</name>
      <type>number</type>
      <value></value>
    </item>
    <item>
      <name>cpuReservation</name>
      <type>number</type>
      <value></value>
    </item>
    <item>
      <name>cpuLimit</name>
      <type>number</type>
      <value></value>
    </item>
    <item>
      <name>cpuShares</name>
      <type>VMware3:SharesLevel</type>
      <value></value>
    </item>
    <item>
      <name>diskShares</name>
      <type>VMware3:SharesLevel</type>
      <value></value>
    </item>
    <item>
      <name>mail</name>
      <type>string</type>
      <value></value>
    </item>
    <item>
      <name>controlGroupMail</name>
      <type>string</type>
      <value></value>
    </item>
    <item>
      <name>viewGroupMail</name>
      <type>string</type>
      <value></value>
    </item>
    <item>
      <name>finiteDate</name>
      <type>boolean</type>
      <value>true</value>
    </item>
    <item>
      <name>controlUser</name>
      <type>LdapUser</type>
      <value>CN=LCM Administrator,CN=Users,DC=rbavmware,DC=bmc,DC=com</value>
    </item>
      <name>techVmName</name>
      <type>string</type>
      <value></value>
    </item>
    <item>
      <name>confirmRequesterEmail</name>
      <type>string</type>
      <value></value>
    </item>
    <item>
      <name>confirmControlEmail</name>
      <type>string</type>
      <value></value>
    </item>
    <item>
      <name>confirmViewerEmail</name>
      <type>string</type>
      <value></value>
    </item>
  </parameters>
  </request>
</vmware-lifecycle-manager-request>

The following figure illustrates the adapter response for the sample Request Virtual Machine operation.

<vmware-lifecycle-manager-response>
  <metadata>
    <status>success</status>
  </metadata>
  <executeWorkflowResponse xmlns="http://webservice.vso.
dunes.ch">
  <executeWorkflowReturn>
    <id>8B8080808080808080808080808080808F808080012343431
042914f33cf44ee2</id>
    <title>Request Virtual Machine</title>
    <workflowId>88808080808080808080808080808080438480800
11839714631461d37ce0bbce</workflowId>
    <currentItemName>__item-undefined__</currentItemName>
    <currentItemState>running</currentItemState>
    <globalState>running</globalState>
    <startDate xmlns:xsi="http://www.w3.org/2001/XMLSchema
-instance" xsi:nil="true" />
    <endDate xmlns:xsi="http://www.w3.org/2001/XMLSchema
-instance" xsi:nil="true" />
    <xmlContent>&lt;token&gt;
    &lt;atts&gt;
    &lt;stack&gt;
    &lt;att n='approvalNeeds' t='boolean' e='n'&gt;&lt;
![CDATA[true]]&gt;&lt;/att&gt;
    &lt;att n='provisioningToken' t='lcm:ProvisioningToken'
 e='n'&gt;&lt;/att
    &lt;att n='counter' t='number' e='n'&gt;&lt;![CDATA[1.0]]
&gt;&lt;/att&gt;
    &lt;att n='currentCriteriaValue' t='lcm:Provision
InfrastructureCriteriaValue' e='n'&gt;&lt;![CDATA[__NULL__]]
&gt;&lt;/att&gt;
    &lt;att n='newElements' t='Array/lcm:CriteriaValueElement'
e='n'&gt;&lt;![CDATA[#{##}#]]&gt;&lt;/att&gt;
    &lt;att n='validCombination' t='Array/Array'e='n'&gt;
&lt;![CDATA[__NULL__]]&gt;&lt;/att&gt;
    &lt;att n='configurationElement' t='ConfigurationElement'
e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/Configuration
Element?id='88808080808080808080808080808080A4858080011839714
631461d37ce0bbce
'&amp;dunesNam     e='ConfigurationElement']]&gt;&lt;/att&gt;
    &lt;att n='tokenName' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='currentData' t='Any'e='n'&gt;&lt;![CDATA[string#]]
&gt;&lt;/att&gt;
    &lt;att n='currentDataName' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='datasCounter' t='number'e='n'&gt;&lt;![CDATA[0.0]]
&gt;&lt;/att&gt;
    &lt;att n='vmFolder' t='VMware3:VmFolder'e='n'&gt;&lt;
![CDATA[__NULL__]]&gt;&lt;/att&gt;
    &lt;att n='vmDatastore' t='VMware3:Datastore'e='n'&gt;&lt;
![CDATA[__NULL__]]&gt;&lt;/att&gt;
    &lt;att n='vmPool' t='VMware3:ResourcePool'e='n'&gt;&lt;
![CDATA[__NULL__]]&gt;&lt;/att&gt;
    &lt;att n='winClientName' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='lifecycleArchive' t='boolean' e='n'&gt;&lt;
![CDATA[false]]&gt;&lt;/att&gt;
    &lt;att n='lifecycleJoinDomainInfo' t='lcm:JoinDomainInfo'
     e='n'&gt;&lt;![CDATA[__NULL__]]&gt;&lt;/att&gt;
    &lt;att n='vmPowerOnKey' t='lcm:TokenDataKeys' e='n'&gt;&lt;
![CDATA[dunes://service.dunes.ch/CustomSDKObject?id=
'vmPowerOn'&amp;dunesName='lcm:TokenDataKeys']]&gt;
&lt;/att&gt;
    &lt;att n='archive' t='boolean' e='n'&gt;&lt;
![CDATA[false]]&gt;&lt;/att
    &lt;att n='archiveKey' t='lcm:TokenDataKeys'e='n'&gt;
&lt;![CDATA[dunes://service.dunes.ch/CustomSDKObject?id=
'lifecycle Archive'&amp;dunesName='lcm:TokenDataKeys']]
&gt;&lt;/att&gt; &lt;att n='winClientNameKey' t='lcm:
TokenDataKeys' e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/
CustomSDKObject? id='winClientName'&amp;dunesName='lcm:Token
DataKeys']]&gt;&lt; /att&gt;
    &lt;att n='currentUser' t='LdapUser' e='n'&gt;&lt;
![CDATA[__NULL__]]&gt;&lt;/att&gt;
    &lt;att n='provisionPrimaryState' t='lcm:PrimaryTokenState'
 e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/CustomSDKObject?
id='provision '&amp;dunesName='lcm:PrimaryTokenState']]&gt;
&lt;/att&gt;
    &lt;att n='financialApproverSecondaryState' t='lcm:
SecondaryTokenState' e='n'&gt;&lt;![CDATA[dunes://service.dunes
.ch/Custom SDKObject?id='provisionFinancialApproval
'&amp;dunesName='lcm:SecondaryTokenState']]&gt;&lt;
/att&gt     ;
    &lt;att n='CheckAutoApprovalTertiaryState' t='lcm:Tertiary
TokenState'e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/Custom
SDKObject?id='checkAutoApproval'&amp;dunesName='lcm:Tertiary
TokenState']]&gt;&lt;/att&gt;
    &lt;att n='waitingForApprovalTertiaryState' t='lcm:Tertiary
TokenState'e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/Custom
SDKObject?id='waitingForApproval'&amp;dunesName='lcm:Tertiary
TokenState']]&gt;&lt;/att&gt;
    &lt;att n='requestEventType' t='lcm:TokenEventType'e='n
'&gt;&lt;![CDATA[dunes://service.dunes.ch/CustomSDKObject?id=
'requestVM '&amp;dunesName='lcm:TokenEventType']]&gt;&lt;
/att&gt;
    &lt;att n='memoryReservationKey' t='lcm:ShapingKeys'
e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/CustomSDKObject?
id='memory.reservation'&amp;dunesName='lcm:ShapingKeys']]&gt;
&lt;/att&gt;
    &lt;att n='memoryLimitKey' t='lcm:ShapingKeys' e='n'&gt;
&lt; ![CDATA[dunes://service.dunes.ch/CustomSDKObject?id=
'memory.size'&amp;dunesName='lcm:ShapingKeys']]&gt;&lt;
/att&gt;
    &lt;att n='memorySharesKey' t='lcm:ShapingKeys'e='n'&gt;
&lt; ![CDATA[dunes://service.dunes.ch/CustomSDKObject?id=
'memory.shares'&amp;dunesName='lcm:ShapingKeys']]&gt;
&lt;/att&gt;
    &lt;att n='cpuCountKey' t='lcm:ShapingKeys' e='n'&gt;
&lt; ![CDATA[dunes://service.dunes.ch/CustomSDKObject?id=
'cpu.count '&amp;dunesName='lcm:ShapingKeys']]&gt;&lt;/att&gt;
    &lt;att n='cpuReservationKey' t='lcm:ShapingKeys'
      e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/Custom
SDKObject?id='cpu.reservation'&amp;dunesName='lcm:Shaping
Keys']] &gt;&lt;/att&gt;
    &lt;att n='cpuLimitKey' t='lcm:ShapingKeys' e='n'&gt;&lt;
![CDATA[dunes://service.dunes.ch/CustomSDKObject?id='cpu.limit
'&amp;dunesName='lcm:ShapingKeys']]&gt;&lt;/att&gt;
    &lt;att n='cpuSharesKey' t='lcm:ShapingKeys' e='n'&gt;&lt;
![CDATA[dunes://service.dunes.ch/CustomSDKObject?id='cpu.share
'&amp;dunesName='lcm:ShapingKeys']]&gt;&lt;/att&gt;
    &lt;att n='diskSharesKey' t='lcm:ShapingKeys' e='n'&gt;&lt;
![CDATA[dunes://service.dunes.ch/CustomSDKObject?id='disk.shares'
&amp;dunesName='lcm:ShapingKeys']]&gt;&lt;/att&gt;
    &lt;att n='levelList' t='Array/VMware3:SharesLevel' e='n'
&gt;&lt;![CDATA[#{#VMware3:SharesLevel#dunes://service.dunes.ch
/CustomSDKObject?id='1'&amp;dunesName='VMware3:SharesLevel'#;
#VMware3:SharesLevel# dunes://service.dunes.ch/CustomSDKObject?
id='2'&amp;dunesName='VMware3:Shar     esLevel'#;#VMware3:Shares
Level#dunes://service.dunes.ch/CustomSDKObject?id= '3'&amp;dunes
Name='VMware3:SharesLevel'#}#]]&gt;&lt;/att&gt;
    &lt;att n='errorCode' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='endDate2' t='Date' e='n'&gt;&lt;/att&gt;
    &lt;att n='startDate2' t='Date' e='n'&gt;&lt;![CDATA
[__NULL__]]&gt;&lt;/att&gt;
    &lt;att n='mailConfiguration' t='ConfigurationElement'
e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/Configuration
Element?id='0C8080808080808080808080808080809E8080800119064
2808250dcf7376883b'&amp;dunesName='ConfigurationElement']]&gt
;&lt;/att&gt;
    &lt;att n='notifsActivated' t='boolean' e='n'&gt;&lt;
![CDATA[false]]&gt;&lt;/att&gt
    &lt;att n='waitingForApprovalNotif' t='lcm:NotificationType'
e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/CustomSDKObject?id
='waitingForApprovalNotif'&amp;dunesName='lcm:NotificationType']]
&gt;&lt;/att&gt;
    &lt;att n='automaticallyApprovedComment' t='string' e='n
'&gt;&lt;![CDATA[Automatically Approved]]&gt;&lt;/att&gt;
&lt;att n='linClientNameKey' t='lcm:TokenDataKeys' e='n'&gt;
&lt;![CDATA[dunes://service.dunes.ch/CustomSDKObject?id=
'linClient Name'&amp;dunesName='lcm:TokenDataKeys']]&gt;&lt;
/att&gt;
    &lt;att n='sendNotifErrorCode' t='string' e='n'&gt;
&lt;/att&gt;
    &lt;att n='basicConfigCriteria' t='Array/lcm:Provision
InfrastructureCriteria'e='n'&gt;&lt;![CDATA[#{#lcm:ProvisionI
nfrastructureCriteria#dunes://service.dunes.ch/CustomSDKObject?
id='1'&amp;dunesName='lcm:ProvisionInfrastructureCriteria'
#;#lcm:ProvisionInfrastructureCriteria#dunes://service
.dunes.ch/CustomSDKObject?id='2'&amp;dunesName='lcm:
ProvisionInfrastructureCriteria'#;# lcm:ProvisionInfrastructure
Criteria#dunes://service.dunes.ch/CustomSDKObject?id='3'&amp;
dunesName='lcm:ProvisionInfrastructureCriteria'#;#lcm:
ProvisionInfrastructureCriteria#dunes://service.dunes.ch/
CustomSDKObject?id='4'&amp;dunesName='lcm:Provision
InfrastructureCriteria'#;#lcm:ProvisionInfrastructure
Criteria#dunes://service.dunes.ch/CustomSDKObject?id='5'
&amp;dunesName=' lcm:ProvisionInfrastructureCriteria'
#}#]]&gt;&lt;/att&gt;
     &lt;att n='cpuCountList' t='Array/number' e='n
'&gt;&lt;![CDATA[#{#number#1.0#;#number#2.0#;#number#4.0#}
#]]&gt;&lt;/att&gt;
     &lt;att n='itMustChooseVmName' t='boolean' e='n'&gt;
&lt;![CDATA[false]]&gt;&lt;/att&gt;
    &lt;att n='location' t='lcm:ProvisionInfrastructure
CriteriaValue' e='n'&gt;&lt;![CDATA[dunes://service.dunes.
ch/CustomSDKObject?id='2'&amp;dunesName='lcm:Provision
InfrastructureCriteriaValue']]&gt;&lt;/att&gt;
    &lt;att n='organization' t='lcm:ProvisionInfrastructure
CriteriaValue' e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/
CustomSDKObject?id='4'&amp;dunesName='lcm:Provision
InfrastructureCriteriaValue']]&gt;&lt;/att&gt;
    &lt;att n='serverEnvironment' t='lcm:Provision
InfrastructureCriteriaValue' e='n'&gt;&lt;
![CDATA[dunes://service.dunes.ch/CustomSDKObject?id='11'
&amp;d     unesName='lcm:ProvisionInfrastructureCriteria
Value']]&gt;&lt;/att&gt;
    &lt;att n='serviceLevel' t='lcm:ProvisionInfrastructure
CriteriaValue'e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/
CustomSDKObject?id='16'&amp;dunesName='lcm:Provision
InfrastructureCriteriaValue']]&gt;&lt;/att&gt;
    &lt;att n='performance' t='lcm:ProvisionInfrastructure
CriteriaValue'e='n'&gt;&lt;![CDATA[dunes://service.dunes.ch/
CustomSDKObject?id='19'&amp;dunesName='lcm:Provision
InfrastructureCriteriaValue']]&gt;&lt;/att&gt;
    &lt;att n='startDate' t='Date' e='n'&gt;&lt;
![CDATA[20090425063118-0500]]&gt;&lt;/att&gt;
    &lt;att n='endDate' t='Date' e='n'&gt;&lt;
![CDATA[20090528063118-0500]]&gt;&lt;/att&gt;
    &lt;att n='vmStart' t='boolean' e='n'&gt;&lt;
![CDATA[false]]&gt;&lt;/att&gt; &lt;att n='groupControle'
 t='LdapGroup' e='n'&gt;&lt;![CDATA[CN=Administrators,
CN=Builtin,DC=vmware1,DC=abc,DC=com]]&gt;&lt;/att&gt;
    &lt;att n='groupView' t='LdapGroup' e='n'&gt;&lt;
![CDATA[CN=Administrators,CN=Builtin,DC=vmware1,DC=abc,DC=com]]
&gt;&lt;/att&gt;
    &lt;att n='templateProfile' t='lcm:TemplateProfile'e='n'
&gt;&lt;![CDATA[dunes://service.dunes.ch/CustomSDKObject?id='6'
&amp;dunesName='lcm:TemplateProfile']]&gt;&lt;/att&gt;
    &lt;att n='startDateDefined' t='boolean' e='n'&gt;&lt;
![CDATA[true]]&gt;&lt;/att&gt;
    &lt;att n='shapingTemplate' t='lcm:ShapingTemplate'
 e='n'&gt;&lt;/att&gt
    &lt;att n='shapingChange' t='boolean' e='n'&gt;&lt;
/att&gt;
    &lt;att n='shapingName' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='memoryReservation' t='number' e='n'&gt;&lt;
/att&
    &lt;att n='memoryLimit' t='number' e='n'&gt;&lt;/att&gt;
    &lt;att n='memoryShares' t='VMware3:SharesLevel' e='n'&gt;
&lt;/att&gt;
    &lt;att n='cpuCount' t='number' e='n'&gt;&lt;/att&gt;
    &lt;att n='cpuReservation' t='number' e='n'&gt;&lt;/att&gt;
    &lt;att n='cpuLimit' t='number' e='n'&gt;&lt;/att&gt;
    &lt;att n='cpuShares' t='VMware3:SharesLevel' e='n'&gt;&lt;
/att&gt;
    &lt;att n='diskShares' t='VMware3:SharesLevel' e='n'&gt;&lt;
/att&gt;
    &lt;att n='mail' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='controlGroupMail' t='string' e='n'&gt;&lt;
/att&gt;
    &lt;att n='viewGroupMail' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='finiteDate' t='boolean' e='n'&gt;&lt;
![CDATA[true]]&gt;&lt;/att&gt;
    &lt;att n='controlUser' t='LdapUser' e='n'&gt;&lt;
/att&gt;
    &lt;att n='viewUser' t='LdapUser' e='n'&gt;&lt;
![CDATA[CN=Administrators,CN=Builtin,DC=vmware1,DC=abc,DC=comm]]
&gt;&lt;/att&gt;
    &lt;att n='comment' t='string' e='n'&gt;&lt;
![CDATA[req for virtual machine]]&gt;&lt;/att&gt;
    &lt;att n='userOrGroupView' t='string' e='n'&gt;&lt;
/att&gt;
    &lt;att n='userOrGroupControl' t='string' e='n'&gt;&lt;
/att&gt;
    &lt;att n='techVmName' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='confirmRequesterEmail' t='string' e='n'&gt;&lt;
/att&gt;
    &lt;att n='confirmControlEmail' t='string' e='n'&gt;&lt;
/att&gt;
    &lt;att n='confirmViewerEmail' t='string' e='n'&gt;&lt;
/att&gt;
    &lt;att n='token' t='lcm:ProvisioningToken' e='n'&gt;&lt;
/att&gt;
    &lt;att n='urlParameter' t='string' e='n'&gt;&lt;/att&gt;
    &lt;att n='label' t='string' e='n'&gt;&lt;/att&gt;
    &lt;/stack&gt;
    &lt;/atts&gt;
    &lt;exception&gt;&lt;/exception&gt;
    &lt;/token&gt;</xmlContent>
    </executeWorkflowReturn>
    </executeWorkflowResponse>
    </vmware-lifecycle-manager-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 20.19.02