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

9.12 cfmg_listtemplate (Displaying Template Information List)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\cfmg_listtemplate - Displaying Template Information List

[Linux Manager]
/opt/FJSVcfmg/bin/cfmg_listtemplate - Displaying Template Information List

Synopsis

cfmg_listtemplate [-v] [-utf8] [-a]

Functional Description

This command outputs an XML list of registered template information.

All of the template information that has been registered is output in the following format:

Detailed format

Simple format

Output format

Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
No
No
Yes
Yes
Yes
Yes
No
No
No
No
Yes
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
Yes
Yes
Yes
<?xml version="1.0" encoding="UTF-8"?>
<templates>
	<template>
		<id>[Template ID]</id>
		<name>[Template name]</name>
		<baseTemplateId>[Base template ID]</baseTemplateId>
		<baseTemplateName>[Base template name]</baseTemplateName>
		<ownerOrg>[Owner (tenant)]</ownerOrg>
		<ownerUser>[Owner (user)]</ownerUser>
		<useFlag>[Use flag]</useFlag>
		<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>
		<description>[Description]</description>
		<keyword>[Search keyword]</keyword>
		<estimate>[Rough cost estimate]</estimate>
		<license>[License]</license>
		<support>[Support]</support>
		<productId>[Model number]</productId>
		<productName>[Product name]</productName>
		<price>[Unit price]</price>
		<chargeType>[Billing method]</chargeType>
		<unitName>[Charge unit]</unitName>
		<currencyUnit>[Currency code]</currencyUnit>
		<currencySign>[Currency symbol]</currencySign>
		<numOfDecimals>[Number of decimal places]</numOfDecimals>
		<expectedUsage>[Expected monthly usage]</expectedUsage>
		<showFlag>[Show flag]</showFlag>
		<vnets>
			<vnet>
				<id>[Network ID]</id>
				<name>[Name]</name>
				<numOfMaxVm>[Maximum number of VMs]</numOfMaxVm>
				<resourceId>[Resource ID]</resourceId>
				<category>[Network category]</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>[Tenant Display Name]</label>
							<segmentlabel>[Segment Display Name]
							</segmentlabel>
							<serverlabel>[Server Display Name]</serverlabel>
							<view>[Display flag]</view>
							<required>[Required prameter]</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>
				<useDataDisk>[Data disk use]</useDataDisk>
				<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>
				<nicgroups>
					<nicgroup>
						<index>[NIC group index]</index>
						<networkId>[IP Address network ID]</networkId>
						<management>[Management NIC]</management>
					</nicgroup>
					...
				</nicgroups>
				<vnics>
					<vnic>
						<no>[NIC serial number]</no>
						<networkId>[IP address network ID]</networkId>
						<management>[Control NIC]</management>
						<group>[NIC group index]</group>
					</vnic>
					...
				</vnics>
				<vdisks>
					<vdisk>
						<no>[Disk serial number]</no>
						<diskSize>[Disk capacity]</diskSize>
						<resourceId>[Resource ID]</resourceId>
						<resourceName>[Disc Resource Name]</resourceName>
						<storagePool>[Storage pool resource name]</storagePool>
						<contained>[Disk contained in image]</contained>
					</vdisk>
					...
				</vdisks>
				<image>
					[Image Information]
				</image>
			</server>
			...
		</servers>
	</template>
	...
</templates>

Yes: Indicates that the information is output.

No: Indicates that the information is not output.

Note

If template information does not exist, information will be output in the following format.

<?xml version="1.0" encoding="UTF-8"?>
<templates />

Options

-v (optional)

This option outputs the list in detailed format.
If this option is omitted, the list is output in the simple format.

-utf8 (optional)

This option outputs the list in UTF-8 format.
This option is only enabled for Windows Manager versions.
If this option is omitted, the list is output in ISO-8859-1 format.
For Linux Manager versions, the list is output in UTF-8 irrespective of this option.

-a (optional)

This option displays a list of the templates that have been generated automatically by the cfmg_importlserver command.

Requirements

Permissions

Infrastructure administrator with OS administrator privilege

Location

Admin server

Example

> cfmg_listtemplate
<?xml version="1.0" encoding="Windows-31J"?>
<templates>
	<template>
		<id>template-12c95768de8</id>
		<name>TEMPLATE_SAMPLE1</name>
		<ownerOrg>cfmgadm</ownerOrg>
		<ownerUser>cfmgadm</ownerUser>
		<useFlag>true</useFlag>
		<publicCategory>PUBLIC</publicCategory>
		<description>Web/AP/DB 1 Server model</description>
		<estimate>0.0000</estimate>
		<license>0</license>
		<support>0</support>
		<productId />
		<productName />
		<price />
		<chargeType />
		<expectedUsage />
		<showFlag>1</showFlag>
	</template>
</templates>

Remarks: Encoding will be "UTF-8" with the Linux Manager.

Exit Status

This command returns the following values:

0

The command executed successfully.

non-zero

An error has occurred.