Preparing to integrate reservations by importing XML files

The Generic - Reservation XML file parser can be used to import data for Reservations from XML files. The following types of Reservation elements can be specified in the XML file that is imported into TrueSight Capacity Optimization using the ETL module:

  • Reservations
  • System Templates
  • Onboardings
  • Offboardings

Reservation XML overview

The following XML provides a high-level overview of the content in the file. All the sections are optional, which allows you to import one or more Reservation elements into TrueSight Capacity Optimization.

<?xml version="1.0" encoding="UTF-8"?>
<rsvData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="rsv_data_etl.xsd">         
	<templates> <!-- Specify the System Templates to be imported (optional) -->
		<systemTemplate>              
		</systemTemplate>   
	</templates> 
	<reservations> <!-- Specify the Reservations to be imported (optional) -->
		<reservation>                 
		</reservation>
	</reservations>  
	<onboardings> <!-- Specify the Onboardings to be imported (optional) -->
		<onboarding> 
		</onboarding>
	</onboardings>               
	<offboardings> <!-- Specify the Offboardings to be imported (optional) -->
		<offboarding> 
		</offboarding> 
	</offboardings>
</rsvData>

Before deploying and configuring the various ETL tasks that impacts the Reservations in your system, it is recommended to go through the following preparatory steps:

  1. Analyze the XML file structure: Analyze the structure of your XML files. Refer to the attached XML Schema Document for reference.
  2. Determine the mandatory fields: Ensure that all mandatory fields are included in the XML files. Refer to the attached XML Schema Document or examples below for details.

Examples

The following sections provide examples for the various Reservation items. You can also refer to the attached sample XML file for reference.

System Templates

You must specify unique lookupName while creating System Templates. If an existing System Template uses the same lookupName, it will be updated.

<templates>
	<!-- You can add multiple System Templates -->
	<systemTemplate>
		<name>VM_Austin_44</name>
		<lookupName>VM_Austin_44_9876</lookupName> 
		<!--If an existing System Template uses the same lookupName,
		it will be updated.-->
		<enttypenm>gm:vmw</enttypenm>
		<cpuCores>8</cpuCores>
		<memTotal>2147483648</memTotal>
		<storageTotal>64424509440</storageTotal>
		<cpuTotalMHz>20000</cpuTotalMHz> <!-- Optional -->
		<os>UNIX</os> <!-- Optional -->
		<cpuUtilization>0.1</cpuUtilization> <!-- Optional -->
		<cpuEntitledCapacity>0.4</cpuEntitledCapacity> <!-- Optional -->
	 	<memUtilization>0.9</memUtilization> <!-- Optional -->
		<storageUtilization>0.6</storageUtilization> <!-- Optional -->
	</systemTemplate>
	<systemTemplate>
	<!-- Enter details similar to the above example -->
	</systemTemplate>
</templates>

Reservations

<reservations>
	<reservation> <!-- Creates a Reservation based on resource specification -->
		<name>Reservation_POC_March</name>
		<startDate>2015-03-25</startDate>
		<endDate>2015-03-31</endDate> <!-- Optional -->
		<description>Reserve resources for POC</description> <!-- Optional -->
		<owner>Alan</owner> <!-- Optional -->
		<priority>HIGH</priority> <!-- Optional -->
		<probability>75</probability> <!-- Optional -->
		<resources>
			<resourceTemplates numItems="1">
				<systemTemplateLookup name="VM_Austin_44_9876"/> 
				<!-- Alternatively, you can specify the System Template by ID-->
			</resourceTemplates>
		</resources>
		<capacityPools>
			<capacityPoolLookup id="2211"/>
		</capacityPools>
	</reservation>
	<reservation> <!-- Creates a Reservation based on item specification -->
		<name>Reservation_BugHunt</name>
		<startDate>2015-02-12</startDate>
		<endDate>2015-02-15</endDate> <!-- Optional -->
		<description>Reserve resources</description> <!-- Optional -->
		<owner>Mary</owner> <!-- Optional -->
		<priority>HIGH</priority> <!-- Optional -->
		<probability>90</probability> <!-- Optional -->
		<items>
			<item>
			<name>My Item</name>
			<systemTemplateLookup id="2383"/>
			<!-- Alternatively, you can specify the System Template by name -->
			</item>
		</items>
		<capacityPools>
			<capacityPoolLookup id="2211"/>
		</capacityPools>
	</reservation>
</reservations>

Reservations with custom resource instances

<reservations>
	<reservation> <!-- Creates a Reservation based on resource specification -->
		<name>Reservation_POC_March</name>
		<startDate>2015-03-25</startDate>
		<endDate>2015-03-31</endDate> <!-- Optional -->
		<description>Reserve resources for POC</description> <!-- Optional -->
		<owner>Alan</owner> <!-- Optional -->
		<priority>HIGH</priority> <!-- Optional -->
		<probability>75</probability> <!-- Optional -->
		<resources>
			<resourceSpecs numItems="1">
				<name>vmware_large_spec</name> <!-- Optional -->
                <enttypenm>gm:vmw</enttypenm>
                <cpuCores>8</cpuCores>
                <memTotal>2147483648</memTotal>
                <storageTotal>64424509440</storageTotal>
                <cpuTotalMHz>20000</cpuTotalMHz> <!-- Optional -->
                <cpuEntitledCapacity>4.0</cpuEntitledCapacity> <!-- Required for AIX -->
                <cpuUtilization>0.1</cpuUtilization> <!-- Optional -->
                <memUtilization>0.9</memUtilization> <!-- Optional -->
                <storageUtilization>0.6</storageUtilization> <!-- Optional -->
			</resourceSpecs>
		</resources>
		<capacityPools>
			<capacityPool id="2211"/>
		</capacityPools>
	</reservation>
	<reservation> <!-- Creates a Reservation based on item specification -->
		<name>Reservation_BugHunt</name>
		<startDate>2015-02-12</startDate>
		<endDate>2015-02-15</endDate> <!-- Optional -->
		<description>Reserve resources</description> <!-- Optional -->
		<owner>Mary</owner> <!-- Optional -->
		<priority>HIGH</priority> <!-- Optional -->
		<probability>90</probability> <!-- Optional -->
		<items>
			<item>
			<name>My Item</name>
			<systemTemplateLookup id="2383"/>
			<!-- Alternatively, you can specify the System Template by name -->
			</item>
		</items>
		<capacityPools>
			<capacityPool id="2211"/>
		</capacityPools>
	</reservation>
</reservations>

Onboardings

<onboarding>
	<name>Onboarding_ESXHost_33</name>
	<description>Add new ESX host to cluster</description> <!-- Optional -->
	<onboardingDate>2015-03-01</onboardingDate>
	<realizationMode>MANUAL</realizationMode>
	<resources>
		<resourceTemplates numItems="1">
			<systemTemplateLookup id="2216"/>
			<!-- Alternatively, you can specify the System Template by name -->
		</resourceTemplates>
	</resources>
	<!-- You can also specify the Reservation Target by name, id, or lookup field -->
	<!-- This example uses lookup fields -->
	<reservationTargetLookup>
		<lookupFields>
			<lookupField name="VMW_VMREF" value="domain-c23" />
			<lookupField name="NAME" value="cluster23" />
		</lookupFields>
	</reservationTargetLookup>
</onboarding>

Onboardings with custom resource instances

<onboarding>
	<name>Onboarding_ESXHost_33</name>
	<description>Add new ESX host to cluster</description> <!-- Optional -->
	<onboardingDate>2015-03-01</onboardingDate>
	<realizationMode>MANUAL</realizationMode>
		<resources>
            <resourceSpecs numItems="1">
                <name>vmware_large_spec</name> <!-- Optional -->
                <enttypenm>gm:vmw</enttypenm> <!-- Optional -->
                <cpuCores>8</cpuCores>
                <memTotal>2147483648</memTotal>
                <storageTotal>64424509440</storageTotal>
                <cpuTotalMHz>20000</cpuTotalMHz> <!-- Optional -->
                <cpuEntitledCapacity>4.0</cpuEntitledCapacity> <!-- Required for AIX -->
                <cpuUtilization>0.1</cpuUtilization> <!-- Optional -->
                <memUtilization>0.9</memUtilization> <!-- Optional -->
                <storageUtilization>0.6</storageUtilization> <!-- Optional -->
			</resourceSpecs>
        </resources>
	<!-- You can also specify the Reservation Target by name, id, or lookup field -->
	<!-- This example uses lookup fields -->
	<reservationTargetLookup>
		<lookupFields>
			<lookupField name="VMW_VMREF" value="domain-c23" />
			<lookupField name="NAME" value="cluster23" />
		</lookupFields>
	</reservationTargetLookup>
</onboarding>

Offboardings

<offboardings>
	<offboarding>
		<name>Onboarding_ESXHost_55</name>
		<offboardingDate>2015-01-24</offboardingDate>
		<description>Offboarding decommissioned host</description> <!-- Optional -->
		<realizationMode>AUTOMATIC</realizationMode> <!-- Optional -->
		<resources>
			<resourceTemplates numItems="1">
				<systemTemplateLookup id="2314"/> 
				<!-- Alternatively, you can specify the System Template by name -->
			</resourceTemplates>
		</resources>
	<reservationTargetLookup name="Cluster-1"/>
	<!-- Alternatively, you can specify the Reservation Target by id -->
	</offboarding>
</offboardings>

Offboardings with custom resource instances

<offboardings>
	<offboarding>
		<name>Onboarding_ESXHost_55</name>
		<offboardingDate>2015-01-24</offboardingDate>
		<description>Offboarding decommissioned host</description> <!-- Optional -->
		<realizationMode>AUTOMATIC</realizationMode> <!-- Optional -->
        <resources>
            <resourceSpecs numItems="1">
                <name>vmware_large_spec</name> <!-- Optional -->
                <enttypenm>gm:vmw</enttypenm> <!-- Optional -->
                <cpuCores>8</cpuCores>
                <memTotal>2147483648</memTotal>
                <storageTotal>64424509440</storageTotal>
                <cpuTotalMHz>20000</cpuTotalMHz> <!-- Optional -->
                <cpuEntitledCapacity>4.0</cpuEntitledCapacity> <!-- Required for AIX -->
                <cpuUtilization>0.1</cpuUtilization> <!-- Optional -->
                <memUtilization>0.9</memUtilization> <!-- Optional -->
                <storageUtilization>0.6</storageUtilization> <!-- Optional -->
            </resourceSpecs>
        </resources>
	<reservationTargetLookup name="Cluster-1"/>
	<!-- Alternatively, you can specify the Reservation Target by id -->
	</offboarding>
</offboardings>


Related topics

Generic - Reservation XML file parser

Out-of-the-box ETLs

Was this page helpful? Yes No Submitting... Thank you

Comments