Citrix - XenServer extractor
This topic describes how to integrate TrueSight Capacity Optimization with Citrix XenServer. The supported versions for Citrix - XenServer are 5.x, 6.0.x, 6.1, and 6.2.
This extractor supports both single server and pool master XenServers.
For more information, refer to the following sections:
To integrate TrueSight Capacity Optimization with the Citrix Xen server Extractor, perform the following task:
- Navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
- In the ETL tasks page, click Add > Add ETL under the Last run tab.
In the Add ETL page, set values for the following properties under each expandable tab.
Basic properties are displayed by default in the Add ETL page. These are the most common properties that you can set for an ETL, and it is acceptable to leave the default selections for each as is.
ETL module Select Citrix - XenServer extractor. ETL task name Default name is already filled out for you. Run configuration name Default name is already filled out for you. Deploy status Select Production. Description (Optional) Enter a brief description. Log level Select how detailed you want the log to be:
- 1 - Light: Add bare minimum activity logs to the log file.
- 5 - Medium: Add medium-detailed activity logs to the log file.
- 10 - Verbose: Add detailed activity logs to the log file.
Execute in simulation mode Select Yes.
When set to Yes, the ETL will not store actual data into the data warehouse. This option is useful while testing a new ETL task.
Ensure that the Based on datasource option is selected.
If you select Based on Open ETL template, TrueSight Capacity Optimization is integrated with a Generic extractor based on the selected Open ETL template. For more information, see
Module description A link that points you to technical documentation for this ETL. Data type Select any one:
- Metrics at Pool, Host, Datastore and Virtual Machine level: metrics are collected from all levels.
- Metrics at Pool, Host and Datastore level: metrics at VM level are not retrieved.
The second option generates a lightweight version of the Citrix XenServer ETL, which can be useful for use cases that do not require to gather metrics at virtual machine level (for example, for some use cases related to TrueSight Capacity Optimization integration to Cloud Lifecycle Management).
Sharing status Select any one:
- PRIVATE: Select this option if this is the only ETL that extracts data from the given set of resources and the lookup table is not shared with the specified ETL task.
- SHARED: Select this option if more than one ETL extracts data from the given set of resources and the lookup table is shared with the specified ETL task.
Associate new entities to
Specify the domain where you want to add the entities created by the ETL. You can select an existing domain or create a new one.
Select any one of the following options:
- New domain: Create a new domain. Specify the following properties under New domain:
- Parent: Select a parent domain for your new domain from the domain selector control.
- Name: Specify a name for your new domain.
- Existing domain: Select an existing domain. Make a selection for the following property:
- Domain: Select an existing domain from the domain selector control.
Xen Server ETL configuration
Xen Server host
Specify the Xen Server host name.
To import data for a particular host from XenServer and Cloud Lifecycle Management, the DNS hostname and hostname in XenServer should be same. If the names are different the same host will show up as a different entity.
Username Enter the user name. The default user is root. Password required (Optional) By default, Yes is selected. Password Enter the password.
ETL task properties
Task group Select a task group to classify this ETL into. Running on scheduler Select the scheduler you want to run the ETL on. Maximum execution time before warning The number of hours, minutes or days to to execute the ETL for before generating warnings, if any. Frequency Select the frequency of ETL execution. Available options are:
- Predefined: Select a Predefined frequency from Each Day, Each Week or Each Month.
- Custom: Enter a Custom frequency (time interval) as the number of minutes, hours, days or weeks to run the ETL in.
Start timestamp: hour\minute (Applies to Predefined frequency) The HH:MM start timestamp to add to the ETL execution running on a Predefined frequency. Custom start timestamp Select a YYYY-MM-DD HH:MM timestamp to add to the ETL execution running on a Custom frequency.
To view or configure Advanced properties, click Advanced. You do not need to set or modify these properties unless you want to change the way the ETL works. These properties are for advanced users and scenarios only.
- Click Edit.
- Select one (click) or more (shift+click) datasets that you want to include from Available datasets and click >> to move them to Selected datasets.
- Click Apply.
4.x compatibility Select any one:
- Do not Import Virtual Machine metrics at Host level, but only at VM level
- Import Virtual Machine metrics at Host level [BYGM, BYZN, BYLP] to ensure compatibility of 4.x reports.
Metric profile selection
Select any one:
- Use Global metric profile: Select this to use an out-of-the-box global profile. By default, all ETL modules use this profile.
- Select a custom metric profile: Any metric profiles you add in the Add metric profile page (Administration > DATAWAREHOUSE > Metric profiles).
For more information, see .
Levels up to
The metric level defines the amount of metric imported into the data warehouse. If you increase the level, additional load is added to the data warehouse while decreasing the metric level reduces the number of imported metrics.
Choose the metric level to apply on selected metrics:
-  Essential
-  Basic
-  Standard
-  Extended
For more information, see .
Metric list <for selected dataset>
Note: This property is activated only after you select Datasets under the Run configuration tab.
- Click Edit.
- Select one (click) or more (shift+click) metrics that you want to include from Available items and click >> to move them to Selected items.
- Click Apply.
Xen Server ETL configuration
Max extraction period Enter the maximum extraction period.
List of properties
- Click Add.
- Add an additional property in the etl.additional.prop.n box.
- Click Apply.
Repeat this task to add more properties.
Empty dataset behavior Choose one of the following actions if the loader encounters an empty dataset:
- Abort: Abort the loader.
- Ignore: Ignore the empty dataset and continue parsing.
ETL log file name Name of the file that contains the ETL execution log; the default value is:
Maximum number of rows for CSV output A number which limits the size of the output files. CSV loader output file name Name of the file generated by the CSV loader; the default value is:
BCO loader output file name Name of the file generated by the TrueSight Capacity Optimization loader; the default value is:
Detail mode Select the level of detail:
- Standard: Data will be stored on the database in different tables at the following time granularities: Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
- Raw also: Data will be stored on the database in different tables at the following time granularities: Raw (as available from the original data source), Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
- Raw only: Data will be stored on the database in a table only at Raw granularity (as available from the original data source).
Remove domain suffix from datasource name (Only for systems) If set to True, the domain name is removed from the data source name. For example,
server.domain.comwill be saved as
Leave domain suffix to system name (Only for systems) If set to True, the domain name is maintained in the system name. For example:
server.domain.comwill be saved as such.
Update grouping object definition If set to True, the ETL will be allowed to update the grouping object definition for a metric loaded by an ETL. Skip entity creation (Only for ETL tasks sharing lookup with other tasks) If set to True, this ETL does not create an entity, and discards data from its data source for entities not found in TrueSight Capacity Optimization. It uses one of the other ETLs that share lookup to create the new entity.
Hour mask Specify a value to execute the task only during particular hours within the day. For example, 0 – 23 or 1,3,5 – 12. Day of week mask Select the days so that the task can be executed only during the selected days of the week. To avoid setting this filter, do not select any option for this field. Day of month mask Specify a value to execute the task only during particular days within a month. For example, 5, 9, 18, 27 – 31. Apply mask validation By default this property is set to True. Set it to False if you want to disable the preceding Scheduling options that you specified. Setting it to False is useful if you want to temporarily turn off the mask validation without removing any values. Execute after time Specify a value in the hours:minutes format (for example, 05:00 or 16:00) to wait before the task must be executed. This means that once the task is scheduled, the task execution starts only after the specified time passes. Enqueueable Select one of the following options:
- False(Default): While a particular task is already running, if the next execution command arises – it is ignored.
- True: While a particular task is already running, if the next execution command arises – it is placed in a queue and is executed as soon as the current execution ends.
- Click Save.
You return to the Last run tab under the ETL tasks page.
- Validate the results in simulation mode: In the ETL tasks table under ETL tasks > Last run, locate your ETL (ETL task name), click
After you run the ETL, the Last exit column in the ETL tasks table will display one of the following values:
to run the ETL.
- OK: The ETL executed without any error in simulation mode.
- WARNING: The ETL execution returned some warnings in simulation mode. Check the ETL log.
- ERROR: The ETL execution returned errors and was unsuccessful. Edit the active Run configuration and try again.
- Switch the ETL to production mode: To do this, perform the following task:
- In the ETL tasks table under ETL tasks > Last run, click the ETL under the Name column.
- In the Run configurations table in the ETL details page, click to edit the active run configuration.
- In the Edit run configuration page, navigate to the Run configuration expandable tab and set Execute in simulation mode to No.
- Click Save.
- Locate the ETL in the ETL tasks table and click
After you run the ETL, or schedule the ETL for a run, it will extract the data form the source and transfer it to the TrueSight Capacity Optimization database. to Run it, or schedule an ETL run.
Source data resolution
- 5 seconds for the past 10 minutes
- One minute for the past 2 hours
- One hour for the past week
- One day for the past year
- Pool (cluster)
- Virtual Machines
Local datastores will be attached to the host; shared datastores will be attached to the pool.