Onboard virtual cluster
This topic lists the XML samples and node element descriptions required for configuring the request and response of the VMware_Integration module for onboarding a virtual cluster.
The following table lists the workflow names used for onboarding a virtual cluster in the VMware and BMC Cloud Lifecycle Management integration:
Workflow type | Name |
|---|---|
CLM_Integration | Virtual Cluster Onboard |
VMware_Integration | Virtual Cluster Onboard Implementation |
Request to VMware_Integration module
All of the following node elements are required for configuring the request:
Element | Description | Sample values |
|---|---|---|
<server-name> | Specifes the name of the management server on which the cluster exists. | MICRO-CSM-VC01.bmc.com |
<cluster-cname> | Specifies the name of the cluster to be onboarded. | field-cluster |
Response from VMware_Integration module
XML sample for configuring the response
<server-ip>10.128.79.2</server-ip>
<server-name>MICRO-CSM-VC01.bmc.com</server-name>
<name>field-cluster</name>
<total-memory>32756</total-memory>
<vcpus>4</vcpus>
<hosts-in-cluster>1</hosts-in-cluster>
<virtual-datastores>
<virtual-datastore>
<id>datastore-2491</id>
<name>Storage1 (5)</name>
<capacity>1197759004672</capacity>
<free-space>101751717888</free-space>
<type>VMFS</type>
<multiple-host-access>false</multiple-host-access>
</virtual-datastore>
</virtual-datastores>
<switches>
<switch>
<switch-name>vSwitch0</switch-name>
<switch-type>EXTERNAL_CLOUD_SIMULATED_SWITCH</switch-type>
</switch>
</switches>
</virtual-cluster>
All of the following node elements are required for configuring the response:
Element | Description | Required |
|---|---|---|
<virtual-cluster> | Contains a virtual cluster entry | Yes |
<server-ip> | Specifies the IP address of the vCenter server | Yes |
<server-name> | Specifies the vCenter server name to which the cluster belongs | Yes |
<name> | Specifies the cluster name | Yes |
<total-memory> | Specifies the size, in MB, of the aggregated memory resources of all hosts in the cluster Recommended value: 32576 | Yes |
<total-memory-unit> | Specifies the unit for total-memory Valid value: MB | Yes |
<vcpus> | Specifies the aggregate number of CPUs from all hosts | Yes |
<switches> | Defines switches aggregated in the cluster | Only if at least one valid virtual switch is present in the cluster |
<switch> | Contains one switch entry | Only if a valid virtual switch is present in the cluster |
<switch-name> | Specifies the name of a switch | Only if a valid virtual switch entry is returned |
<switch-type> | Specifies the type of a switch:
| Only if a valid virtual switch entry is returned |
<virtual-datastores> | Defines datastores in this cluster | Only if at least one valid virtual datastore is present in the cluster |
<virtual-datastore> | Defines one virtual datastore entry | Only if a valid virtual datastore is present in the cluster |
<id> | Specifies the datastore ID | Only if a valid virtual datastore entry is returned |
<name> | Specifies the datastore name | Only if a valid virtual datastore entry is returned |
<capacity> | Specifies the maximum datastore capacity, in bytes | Only if a valid virtual datastore entry is returned |
<free-space> | Specifies the datastore free space, in bytes | Only if a valid virtual datastore entry is returned |
<type> | Specifies the type of datastore Recommended value: VMFS | Only if a valid virtual datastore entry is returned |
<multiple-host-access> | Specifies whether multiple host access is enabled for the datastore Valid values: true, false | Only if a valid virtual datastore entry is returned |
If an error occurs during execution, error XML code is returned in the following format:
<error>Error Message</error>
</value>