ServerView Resource Orchestrator Cloud Edition V3.1.1 Reference Guide (Command/XML)

15.18.4 Template Information

This section explains the template information in detail.

15.18.4.1 Overview of Template Information

Template information is defined in XML documents that list the configuration information for L-Platform templates.

Create and register one template information file for each L-Platform template.

Infrastructure administrators must take this model into account when performing creation.

A model template information file is stored in the following folder:

[Windows Manager]

Installation_folder\RCXCFMG\templates\templates\
The following models are stored: 
	sample1.xml(Single server configuration)
	sample2.xml(Two-layer configuration)
	sample3.xml(Three-layer configuration)

[Linux Manager]

/opt/FJSVcfmg/templates/templates/
The following models are stored: 
	sample1.xml(Single server configuration)
	sample2.xml(Two-layer configuration)
	sample3.xml(Three-layer configuration)

Refer to "15.18.4.2 File Information Details" for a description of items (tags).

The cloning image ID of the cloning image registered with Resource Management is entered for the cloning image ID in the template information.

15.18.4.2 File Information Details

Template information files use the following XML format:

<?xml version="1.0" encoding="UTF-8" ?>
<template version="1.1">
	<id>[Template ID]</id>
	<lcid>[Locale ID]</lcid>
	<name>[Template name]</name>
	<baseTemplateId>[Base template ID]</baseTemplateId>
	<ownerOrg>[Owner (tenant)]</ownerOrg>
	<ownerUser>[Owner (user)]</ownerUser>
	<publicCategory>[Public category]</publicCategory>
	<designSheetPath>[Path to the design sheet]</designSheetPath>
	<releaseDate>[Release date]</releaseDate>
	<numOfMaxVnet>[Maximum number of VNETs]</numOfMaxVnet>
	<numOfMaxVm>[Maximum number of VMs]</numOfMaxVm>
	<productId>[Model number]</productId>
	<description>[Description]</description>
	<keyword>[Search keyword]</keyword>
	<estimate>[Rough cost estimate]</estimate>
	<license>[License]</license>
	<support>[Support]</support>
	<vnets>
		<vnet>
			<id>[Network ID]</id>
			<name>[Name]</name>
			<numOfMaxVm>[Maximum number of VMs]</numOfMaxVm>
			<resourceId>[Network resource ID]</resourceId>
			<category>[Network type]</category>
			<segmentType>[Segment type information]</segmentType>
		</vnet>
		...
	</vnets>
	<connector>[Connection destination]</connector>
	<lnetdevs>
		<lnetdev>
			<name>[LNetDev name]</name>
			<type>[LNetDev type]</type>
			<lnetdevIfs>
				<lnetdevIf>
					<name>[Interface name]</name>
					<networkId>[Network ID]</networkId>
				</lnetdevIf>
				...
			</lnetdevIfs>
			<ruleset>
				<name>[Ruleset name]</name>
				<designtype>[UI type]</designtype>
				<lplatformModel>[L-Platform model]</lplatformModel>
				<description>[Ruleset description]</description>
				<deviceModel>[Device model]</deviceModel>
				<maxAccessRuleSetting>[Maximum number of access rules]</maxAccessRuleSetting>
				<maxProvision>[Maximum number of deployments]</maxProvision>
				<parameters>
					<parameter>
						<name>[Parameter name]</name>
						<label>[Display name]</label>
						<segmentlabel>[Segment display name]</segmentlabel>
						<serverlabel>[Server display name]</serverlabel>
						<view>[Display flag]</view>
						<required>[Flag indicating whether parameter is required]</required>
						<syntax>[Syntax]</syntax>
						<value>[Parameter value]</value>
						<summary>[Parameter summary]</summary>
						<description>[Parameter description]</description>
					</parameter>
					...
				</parameters>
				<parameterGroups>
					<parameterGroup>
						<name>[Parameter group name]</name>
						<id>[Parameter group ID]</id>
						<parameters>
							<parameter>
								<name>[Parameter name]</name>
								<label>[Display name]</label>
								<view>[Display flag]</view>
								<value>[Parameter value]</value>
								<description>[Parameter description]</description>
							</parameter>
							...
						</parameters>
					</parameterGroup>
					...
				</parameterGroups>
			</ruleset>
		</lnetdev>
	</lnetdevs>
	<servers>
		<server>
			<no>[Server serial number]</no>
			<imageId>[Cloning image ID]</imageId>
			<name>[Server name]</name>
			<serverType>[Server type]</serverType>
			<pool>[Deployment destination pool resource name]</pool>
			<sparePool>[Spare pool resource name]</sparePool>
			<storagePool>[Storage pool resource name]</storagePool>
			<powerPriority>[Startup priority level]</powerPriority>
			<useDataDisk>[Data disk use]</useDataDisk>
			<nicgroups>
				<management>[Control NIC]</management>
				<nicgroup>
					<index>[NIC group index]</index>
					<networkId>[Connection destination network ID]</networkId>
				</nicgroup>
				...
			</nicgroups>
			<vnics>
				<management>[Control NIC]</management>
				<vnic>
					<no>[NIC serial number]</no>
					<networkId>[Connection destination network ID]</networkId>
					<group>[NIC group index]</group>
				</vnic>
				...
			</vnics>
			<vdisks>
				<vdisk>
					<no>[Disk serial number]</no>
					<diskSize>[Disk capacity]</diskSize>
					<resourceId>[Resource ID]</resourceId>
					<resourceName>[Disk resource name]</resourceName>
					<storagePool>[Storage pool resource name]</storagePool>
					<contained>[Disk contained in image]</contained>
				</vdisk>
				...
			</vdisks>
		</server>
		...
	</servers>
</template>

The following table shows descriptions of each of these items (tags), as well as their settings:

Modify template information files if necessary, by referring to the information in this table.

Tag names in square brackets [ ] can be omitted.

Tag name	Format	Setting range	Description	Mandatory	Settings
[ id ]	ASCII string	0 to 32 characters	The ID assigned to the template.	No	If this template ID is omitted, one is automatically assigned.
[ lcid ]	ASCII string	Fixed value	The locale for template information.	Yes	The value is fixed as "en"
[ name ]	UTF-8 string	Up to 85 characters	The template name. The template name specified here is used for the default system name for the L-Platform system. For the system name, the characters that can be used and the length of the name vary depending on the method for setting resource names. It is recommended that template names be specified within the following range, which is effective for any method for setting resource names: - Names containing no more than 23 alphanumeric characters, underscores ("_") and hyphens ("-") Refer to "18.5 Setting the Method for Setting Resource Names" in the "Setup Guide CE" for information on the method for setting resource names.	Optional
baseTemplatId	-	-	The name of the base template.	No
ownerOrg	ASCII string	Fixed value	The tenant name to which the template belongs.	Yes	The value is fixed as "cfmgadm".
ownerUser	ASCII string	Fixed value	The user ID of the user registering the template.	Yes	The value is fixed as "cfmgadm".
publicCategory	ASCII string	Fixed value	The category of the template.	Yes	The value is fixed as"PUBLIC". The template is available to all users.
designSheetPath	-	-	The storage folder for the design sheet.	No
releaseDate	ASCII string	0 to 10 characters	The date when the template is made available.	Optional	The format is "yyyy/mm/dd".
numOfMaxVnet	integer	1 to 99	The maximum number of segments that can be used by the system in the template.	Yes
numOfMaxVm	integer	0 to 30	The maximum number of servers that can be used by the template's system.	Yes
productId	-	-	The product ID of the template that will be used for billing purposes.	No
description	UTF-8 string	Up to 85 characters	A description of the template, explaining the system that the template produces, the content of the template, and so on.	Optional
keyword	UTF-8 string	Up to 85 characters	The search keyword for the template.	Optional	The template search function finds templates that use this keyword.
estimate	decimal	Fixed value	The price of the template.	Yes	The value is fixed as "0".
license	ASCII string	List	Specifies whether a license has been assigned to the template.	Yes	Select one of the following options: - "0": No license assigned - "1": License assigned
support	ASCII string	List	Specifies whether support has been assigned to the template.	Yes	Select one of the following options: - "0": No support assigned - "1": Support assigned
vnets	-	-	The details of the system segments.	No
[ vnet ]	-	1 or more	As many segment information files as there are segments.	No	Not required if there is no segment information.
id	ASCII string	1 to 20 characters	The ID that identifies the segments within the template.	Yes	Specify any ID within the template. Specify the value specified in this designated value, in the vnic networkID.
name	ASCII string	0 to 20 characters	The segment name.	Optional
numOfMaxVm	integer	0 to 30	The maximum number of servers that can be added to the segment and used.	Yes
[ resourceId ]	ASCII string	1 to 256 characters	The resource ID of the virtual network assigned to the segment.	Yes	Confirm the resource ID using the cfmg_listvnet command. If omitted, the selection is automatic. To omit this, also omit the tag.
[ category ]	ASCII string	1 to 10 characters	The segment type for filtering the network resources that can be selected.	Optional	Select one of the following options: - "BUSINESS": Business segment - "MANAGEMENT": Management segment If this is omitted, "BUSINESS" will be used. To omit this, also omit the tag.
[ segmentType ]	ASCII string	1 to 32 characters	The segment type information for filtering the network resources that can be selected.	Optional	If this is omitted, no filtering will be performed. To omit this, also omit the tag.
[ connector ]	ASCII string	List	Specify the connection destination for the external LAN.	Yes	Select one of the following: - "internet": Internet - "intranet": Intranet - "both": Both - "none": No connection Specify this tag only if you specified LNetDev and you specified "Simple" for "designtype" of the ruleset.
[ lnetdevs ]	-	-	The system LNetDevs.	No
lnetdev	-	1 or more	Specify as many <lnetdev> tags as there are LNetDevs.	Yes
name	ASCII string	1 to 32 characters	The LNetDev name.	Yes
type	ASCII string	List	The LNetDev type.	Yes	Select one of the following: - "Firewall": Firewall - "SLB": Server load balancer
lnetdevIfs	-	-	The LNetDev virtual interface definition.	Yes
lnetdevIf	-	1 or more	Specify as many <lnetdevlf> tags as there are virtual interfaces.	Yes
name	ASCII string	1 character or more	The name of the network ID parameter corresponding to the LNetDev virtual interface.	Yes
networkId	ASCII string	1 to 20 characters	The corresponding VNET segment ID.	Yes
ruleset	-	-	The ruleset.	Yes
name	ASCII string	1 to 32 characters	The ruleset name.	Yes
[ designtype ]	ASCII string	List	Specify the type of the user interface.	Yes	Select one of the following: - "UserCustomize": User-customized - "Simple": Simple setup Specify the same value as was set in the ruleset.
lplatformModel	integer	List	Specify the L-Platform model.	Yes	Select one of the following: - 1: Firewall only - 2: Server load balancer only - 3: Firewall and server load balancer
description	UTF-8 string	1 to 256 characters	The ruleset description.	Yes
[ deviceModel ]	ASCII string	List	Specify the network device model corresponding to the setup window.	Yes	Select one of the following: - "NSAppliance": NS appliance Specify the same value as was set in the ruleset.
[ maxAccessRuleSetting ]	integer	1 or more	Specify the maximum set number of access rules.	Yes	Specify the same value as was set in the ruleset.
[ maxProvision ]	integer	1 to 9	Specify the maximum number that can be deployed to a network device.	Yes	Specify the same value as was set in the ruleset.
parameters	-	-	The ruleset parameters.	Yes
parameter	-	1 or more	Specify as many <parameter> tags as there are parameters.	Yes
name	ASCII string	1 character or more	The parameter name.	Yes
label	ASCII string	1 to 32 characters	The parameter name to be displayed on the GUI.	Yes
segmentlabel	ASCII string	0 to 32 characters	Specify the segment name displayed in the GUI.	Optional
serverlabel	ASCII string	0 to 32 characters	Specify the server name displayed in the GUI.	Optional
view	ASCII string	List	The parameter display flag.	Yes	Select one of the following options: - "true": Display - "false": No display
[ required ]	ASCII string	List	Specify whether the parameter is required.	Optional	Select one of the following options: - "true": Required - "false": Optional If omitted, "false" will be used.
[ syntax ]	ASCII string	List	Specify the parameter syntax.	Optional	Select one of the following: - "INTEGER(0..255)": integer Specify the range of values with "minimum value...maximum value" format - "DisplayString (SIZE (0...256))": string Specify the minimum number of characters and the maximum number of characters with SIZE (0 to 256) - "DisplayString(SELECT("AA" | "BB" | "CC"))": string Select a SELECT string (AA, BB, and CC are arbitrary strings) - "Physical Address": Media Access Control address Media Access Control address format (xx:xx:xx:xx:xx:xx) - "IpAddress": IP address IPv4 address format (xxx.xxx.xxx.xxx) or IPv6 address format (xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx) - DisplayString(SELECT IPADDRESS("SegA"|"SegB"|"SegC")): Select server (IP address) from target segments - DisplayString(SELECT IPADDRESS SLB SERVER()): Select server (IP address) from target SLB servers
value	ASCII string	1 character or more	The parameter value.	Yes
summary	UTF-8 string	0 to 256 characters	Specify a summary for the parameter.	Optional
description	UTF-8 string	0 to 256 characters	The parameter description.	Yes
[ parameterGroups ]	-	-	Specify the parameter groups of the ruleset.	No	Specify only when parameter groups have been set in the ruleset.
parameterGroup	-	1 or more	Specify as many <parameterGroup> tags as there are parameter groups.	Yes
name	ASCII string	1 character or more	Specify the parameter group name.	Yes	Specify the same value as was set in the ruleset.
id	integer	Fixed value	Specify the identifier information to be assigned to the parameter group name.	Yes	The value is fixed as "0".
parameters	-	-	Specify the parameters within the parameter group.	No
parameter	-	1 or more	Specify as many <parameter> tags as there are parameters.	Yes
name	ASCII string	1 character or more	Specify the parameter name.	Yes	Specify the same value as was set in the ruleset.
label	ASCII string	0 to 32 characters	Specify the parameter name to be displayed on the GUI.	Optional	This tag will be ignored even if specified. Specify a space.
view	ASCII string	Fixed value	Specify the parameter display flag.	Yes	The value is fixed as "true".
value	ASCII string	1 character or more	Specify the parameter value.	Yes
description	UTF-8 string	0 to 256 characters	Specify the parameter description.	Optional	This tag will be ignored even if specified. Specify a space.
servers	-	-	The number of servers in the system.	No
server	-	1 or more	Server information for the number of servers that exist.	Yes
no	integer	0 to 29	The server number.	Yes	This item specifies a serial number for the server that is unique within the template.
imageId	ASCII string	1 to 32 characters	The image ID of an image to be deployed on the server.	No	It is necessary to register the image information in advance and check the image ID.
[ useDataDisk ]	ASCII string	List	Specify true if a data disk is included in the image.	Yes	Select one of the following values: - "true": Data disk used - "false": Data disk not used If nothing was specified, the setting will be "false".
name	UTF-8 string	Up to 85 characters	The name of the server.	Yes	This is a name that is used to distinguish servers within the template, and is not the host name.
serverType	ASCII string	1 to 32 characters	The name of the L-Server template to be selected as the default template from amongst the L-Server templates that have been set up using Resource Management.	Yes	Specify the same value as was specified in the image information file.
[ Pool ]	ASCII string	1 character or more	The resource name (resource name in Resource Management) of the deployment destination pool of the server. Specify the resource name of the VM pool for virtual, and of the server pool for physical. Specify resource names starting with a forward slash "/". (Example) /vmPool_2	Optional	If this is omitted, the first pool registered with Resource Management will be selected. This can also be modified during deployment.
[ sparePool ]	ASCII string	1 character or more	The resource name (resource name in Resource Management) of the spare server pool for when a physical server fails.	No
[ storagePool ]	ASCII string	1 character or more	The resource name (resource name in Resource Management) of the storage pool at the server deployment destination. Specify resource names starting with a forward slash "/". (Example) /StoragePool_2	Optional	If omitted, the first storage pool registered with Resource Management will be selected. This can also be modified during deployment. Cannot be specified when the server virtualization software is OVM for x86. The storage pool is selected automatically.
[ powerPriority ]	integer	1 to 256	This setting indicates the priority level when performing batch power supply operations within either the L-Platform or within the tenant.	Optional	The smaller the value, the higher the priority level. When omitted, the value is set to 128.
[ nicgroups ]	-	-	The redundant network interface card (NIC) groups.	Yes
management	integer	1 or more	The index of the NIC group to be specified in the control NIC.	Yes	This is mandatory if "management" under "vnics" has been omitted. "management" cannot be set in both "nicgroup" and "vnics".
nicgroup	-	-	Specify as many <nicgroup> tags as there are redundant network interface card (NIC) groups.	Yes	A nicgroup without an NIC cannot be defined.
index	integer	1 to 99	A number for the NIC group that is unique within the server.	Yes
networkId	ASCII string	1 to 20 characters	The network ID of the segment to which the NIC group is to connect.	Yes
vnics	-	-	The network interface card (NIC).	No
management	integer	1 or more	The NIC number specified in the control NIC.	Yes	Specify the value specified in <no> under <vnic>. When <nicgroups> is specified, this item is mandatory in the case of omitting <management> under <nicgroups>. One of the NIC/NIC Groups defined in either <nicgroup> or <vnic> must be specified. It is not possible to specify a NIC whose <group> is specified. It is not possible to assign management settings to both <nicgroup> and <vnics>.
[ vnic ]	-	1 or more	As many <vnic> tags as there are NICs.	No
no	integer	1 to 99	The NIC number.	Yes	This item specifies a serial number for the NIC that is unique within the server.
networkId	ASCII string	1 to 20 characters	The segment ID for the segment that the NIC connects to.	Yes	Specify the value that was specified in the vnet id.
[ group ]	ASCII string	1 to 99	If grouping is performed for this NIC, the index number of the NIC group (value of "index" in "nicgroup").	Optional	If this is omitted, no grouping will be performed.
vdisks	-	-	The extension disk for the server.	No
[ vdisk ]	-	0 or more	As many <vdisk> tags as there are disks.	No	These tags are required only when extension disks exist. - If the server virtualization software is Hyper-V, specify up to three. - If the server virtualization software is RHEL-KVM, only existing disks can be specified. - Cannot be specified if the server virtualization software is Solaris Zones.
[ no ]	integer	1 or more	A serial number for the disk that is unique within the server.	Yes	If it is a data disk that is included in the image, specify the same value as is output to the <no> tag with the cfmg_listvmimage command.
[ diskSize ]	decimal	In decimal notation, to one decimal place (0.1 to 99999.9)	The size of the disk.	Yes	Specify this value in GB. If it is a data disk that is included in the image, specify the same value as is output to the <diskSize> tag with the cfmg_listvmimage command.
[resourceId]	ASCII string	1 to 256 characters	The resource ID of an existing disk if an existing disk is to be connected.	Yes	Make sure to specify it when the server virtualization software is RHEL-KVM.
[ resouceName ]	ASCII string	1 to 32 characters	The disk resource name of an existing disk if an existing disk is to be connected.	Yes	Make sure to specify it when the server virtualization software is RHEL-KVM.
[ storagePool ]	ASCII string	1 character or more	The resource name (resource name in Resource Management) of the storage pool at the extension disk deployment destination. Specify resource names starting with a forward slash "/". (Example) /StoragePool_2	Optional	Cannot be specified when the server virtualization software is OVM for x86. The storage pool is selected automatically.
[ contained ]	ASCII string	List	Specify true if the data disk is included in the image.	Yes	Select one of the following values: - "true": Disk contained in image - "false": New disk If nothing was specified, the setting will be "false".

The meanings of the symbols in the Mandatory column are as follows:

Yes: If a tag was specified, you must specify the value.

Optional: Value can be omitted.

No: A value setting is not required. Tag only specification.