Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

CloudResources.xml

This topic lists a sample CloudResources.xml file and describes the meaning of each element in the file.

The purpose of the CloudResources.xml file is to declare static folders in the navigation tree of the operator console under the Global folder as shown in the following figure. All the elements are defined within the global-node tag.

vcloud_resources.PNG

Sample CloudResources.xml file

<?xml version="1.0" encoding="UTF-8"?>
<global-node xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="CloudCI.xsd">
<cloud-resources>
 <cloud-folder name="Locations" type="ci_physical_location" hideChildren="false" preferredView="TMV">
   <view-types>TMV GrV</view-types>
   <query>CLASS EQUALS BMC_PhysicalLocation</query>
 </cloud-folder>
 <cloud-folder name="Pods" objectId="Pod" type="ci_network" hideChildren="false" preferredView="TV">
   <view-types>TV CV TMV GrV</view-types>
   <query>CLASS EQUALS BMC_ConcreteCollection AND CollectionType EQUALS Pod</query>
 </cloud-folder>
 <cloud-folder name="Network Containers" objectId="NetworkContainer" type="ci_network" hideChildren="true" preferredView="TV">
   <view-types>TV CV TMV GrV</view-types>
   <query>CLASS EQUALS BMC_ConcreteCollection AND CollectionType EQUALS NetworkContainer</query>
 </cloud-folder>
 <cloud-folder name="Compute Pools" objectId="Compute" type="ci_resources" hideChildren="false" preferredView="TV">
   <view-types>TV CV TMV GrV</view-types>
   <query>CLASS EQUALS BMC_ResourcePool AND Type EQUALS Compute</query>
 </cloud-folder>
</cloud-resources>

 <cloud-folder name="Tenants" objectId="Tenants" type="ci_tenants" consoleType="CENTRAL" hideChildren="true" preferredView="TV">
   <view-types>TV CV TMV GrV</view-types>
   <query>CLASS EQUALS BMC_Organization AND isTenant EQUALS Yes</query>
 </cloud-folder>
</global-node>

Description of the elements

The following table describes the elements in the CloudResources.xml file.

Element

Description

global-node

Required top-level tag that encompasses all the other tags.

cloud-resources

Defines those folders that are designated to be the children of the Cloud Resources folder. This tag is optional but must be the first child of the global-node tag if defined. Only one instance is allowed. It can have an unlimited number of cloud-folder tags as children.

cloud-folder

Defines a folder in the navigation tree. This tag can be a child of the global-node or cloud-resources tag. It has two required children tags in the following order:

  • view-types - list of views delimited by a space
  • query - text query on configuration item (CI) slot values. Supported operators are: EQUALS, NOT_EQUALS, EQUALS_IGNORE_CASE, AND, OR, OPEN_BRACKET, CLOSE_BRACKET

Attributes for the cloud-folder tag

The following table lists the attributes that you can declare for the cloud-folder tag.

Attribute

Description

Required or optional

name

English name used as a key (spaces removed) to retrieve localized values. Localized values are stored in the navigationData.properties file.

Required

objectId

Actual internal property logically used as the sub-type by the UI.

Optional

hideChildren

Hides children under this folder in the navigation tree if specified as true.

Optional and defaults to false

preferredView

Possible views are:

  • EV–Event view
  • GV–Grid view
  • TV–Tile view
  • CV–Canvas view
  • ChV–Chart view
  • GrV–Graph view
  • TMV–Treemap view
  • TrV–Tree view
  • MpV–Multipane view

Optional. Default value is TV.

consoleType

Restricts the folder visibility in the required console type. Possible console types are:

  • ALL–folder is visible in both the central and global consoles
  • CENTRAL–folder is visible only in the central console
  • GLOBAL–folder is visible only in the global console

Optional. Default value is ALL.

type

CI types used by the UI. Possible types are:

  • ci_physical_location–physical location used in BMC Cloud Lifecycle Management
  • ci_network–BMC Cloud Lifecycle Management constructs such as pods, network containers, and zones.  VMware vCloud constructs such as PVDC, OVDC, and vApps.
  • ci_resources–resource pools
  • ci_service_offerings–service offerings in BMC Cloud Lifecycle Management
  • ci_service_offering_instance–service offering instances in BMC Cloud Lifecycle Management
  • ci_tenants–tenants or organizations
  • component_ci – generic CI

 

 

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