Cloud Infrastructure Management SoftwareV1.2.0 User's Guide

G.2.3 Image Information Manipulation Commands

This section explains the commands for manipulating image information.

Displaying a Virtual Image List

Synopsis

cfmg_listvmimage [-utf8]

Description

This command outputs an XML file that contains a list of the virtual images that have been registered.

Options

Option	Description
-utf8	This option outputs the list in UTF-8 format. This option is only valid for the Windows version. For the Windows version, the list is output in ISO-8859-1 format if this option is omitted.

Output format

This command uses the following format to output all of the virtual images that have been registered.

<?xml version="1.0" encoding="UTF-8"?>
<images>
	<image>
		<id>[Image ID]</id>
		<name>[Image name]</name>
		<comment>[Comment]</comment>
		<type>[Image type]</type>
		<version>[Image version]</version>
		<time>[Date and time when the image was created]</time>
	</image>
	…
</images>

Cautions

This command outputs the following data if no virtual image information has been registered.

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

Example

# /opt/FJSVcfmg/bin/cfmg_listvmimage
<?xml version="1.0" encoding="UTF-8"?>
<images>
	<image>
		<id>ST01-M_896</id>
		<name>RHELx64_IMG </name>
		<comment />
		<type>cloning</type>
		<version>1</version>
		<time>2010-11-17-15:20:17+09:00 </time>
	</image>
</images>

Displaying Image Information

Synopsis

cfmg_listimageinfo [-v] [-utf8]

Description

This command outputs an XML file that contains a list of the image information that has been registered.

Options

Option	Description
-v	This option outputs the list in detailed format. If this option is omitted, the list is output in the simple format.
-utf8	This option outputs the list in UTF-8 format. This option is only valid for the Windows version. For the Windows version, the list is output in ISO-8859-1 format if this option is omitted.

Output format

This command uses the following format to output all of the image information that has been registered.

Detailed format	Simple format	Output format
* * * * * * * * * * * * * * * * * * * * * * * - * * *	* * * * - - - - * - - - - - - - - - - - - - - - - * *	<?xml version="1.0" encoding="UTF-8"?> <images> <image> <id>[Image ID]</id> <name>[Image name]</name> <ownerOrg>[Owner organization]</ownerOrg> <ownerUser>[Owner user]</ownerUser> <publicCategory>[Publication category]</publicCategory> <serverCategory>[Server type]</serverCategory> <serverApplication>[Server usage]</serverApplication> <serverType>[Default server type]</serverType> <cpuBit>[Number of CPU bits]</cpuBit> <sysvolSize>[Size of the system disk]</sysvolSize> <numOfNIC>[Number of NICs]</numOfNIC> <maxCpuPerf>[Maximum CPU performance]</maxCpuPerf> <numOfMaxCpu>[Maximum number of CPUs]</numOfMaxCpu> <maxMemorySize>[Maximum memory size]</maxMemorySize> <numOfMaxDisk>[Maximum number of disks]</numOfMaxDisk> <maxDiskSize>[Maximum disk capacity]</maxDiskSize> <icon>[Icon type]</icon> <virtualization>[Virtualization method]</virtualization> <showFlag>[Show flags]</showFlag> <softwares> … </softwares> </image> </images>

*: Indicates information that is output.

-: Indicates information that is not output.

Cautions

This command outputs the following data if no image information has been registered.

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

Example

# /opt/FJSVcfmg/bin/cfmg_listimageinfo -v
<?xml version="1.0" encoding="UTF-8"?>
<images>
	<image>
		<id>ST01-M_896</id>
		<name>RHELx64_IMG</name>
		<ownerOrg>cfmgadm</ownerOrg>
		<ownerUser>cfmgadm</ownerUser>
		<publicCategory>PUBLIC</publicCategory>
		<serverCategory>GENERAL</serverCategory>
		<serverApplication>AP</serverApplication>
		<serverType>extra_small</serverType>
		<cpuBit>32</cpuBit>
		<sysvolSize>15.0</sysvolSize>
		<numOfNIC>2</numOfNIC>
		<maxCpuPerf>10.0</maxCpuPerf>
		<numOfMaxCpu>1</numOfMaxCpu>
		<maxMemorySize>10.0</maxMemorySize>
		<numOfMaxDisk>10</numOfMaxDisk>
		<maxDiskSize>30.0</maxDiskSize>
		<numOfMaxNic>1</numOfMaxNic>
		<icon>unit_tag_web.png</icon>
		<virtualization>hvm</virtualization>
		<showFlag>0</showFlag>
		<softwares>
			<software>
			<name>Red Hat Enterprise Linux 5 (for Intel64)</name>
			<id>SW00000011</id>
			<category>OS</category>
			<osCategory>linux64</osCategory>
			<version>5.5</version>
			<officialVersion />
			<patch />
			<license />
			<support />
			<productId />
			<productName />
			<price />
			<chargeType />
			<expectedUsage />
			</software>
		</softwares>
	</image>
</images>

Image information registration command

Synopsis

cfmg_addimageinfo -xml <Path to the image information file>

Description

This command registers image information.

Options

Option	Description
-xml	This option specifies the absolute or relative path to the image information file, using a string made up of printable ASCII characters. Enclose the string in double quotes (") if it contains blank spaces

Output format

None.

Cautions

None.

Example

# /opt/FJSVcfmg/bin/cfmg_addimageinfo -xml /tmp/template_test/images/sample.xml

Image information deletion command

Synopsis

cfmg_deleteimageinfo [-f] -name <Image name>

Description

This command deletes image information.

Options

Option	Description
-f	This option executes the deletion without confirmation. If this option is omitted, a confirmation prompt will be output before the deletion takes place.
-name	This option specifies the image name of the image information file to be deleted.

Output format

None.

Cautions

None.

Example

# /opt/FJSVcfmg/bin/cfmg_deleteimageinfo -name RHELx64_IMG
Do you want to delete the image information? (Y/N) y

Detailed explanation of image information

This section provides detailed image information.

Image information

Image information files are XML documents that list configuration information for virtual images.

Create and register a separate image information file for each virtual image.

Sample image information files are stored in the following directory.

The service provider must create software information files by referring to these samples.

[Windows]
	<CIMS installation folder>\Systemwalker\SWCFMG\templates\images\

Refer to "Detailed image information" for details on the items (tags).

For information on the software ID contained in the image information, the software ID (which is assigned when the software information is registered) must be entered in the image information file.

Detailed image information

Image information files use the following XML format.

<?xml version="1.0" encoding="UTF-8" ?>
<image version="1.1">
	<id>[Image ID]</id>
	<name>[Image name]</name>
	<ownerOrg>[Owner organization]</ownerOrg>
	<ownerUser>[Owner user]</ownerUser>
	<publicCategory>[Publication category]</publicCategory>
	<serverCategory>[Server type]</serverCategory>
	<serverApplication>[Server usage]</serverApplication>
	<serverType>[Default server type]</serverType>
	<cpuBit>[Number of CPU bits]</cpuBit>
	<sysvolSize>[Size of the system disk]</sysvolSize>
	<numOfNic>[Number of NICs]</numOfNic>
	<maxCpuPerf>[Maximum CPU performance]</maxCpuPerf>
	<numOfMaxCpu>[Maximum number of CPUs]</numOfMaxCpu>
	<maxMemorySize>[Maximum memory size]</maxMemorySize>
	<numOfMaxDisk>[Maximum number of disks]</numOfMaxDisk>
	<maxDiskSize>[Maximum disk capacity]</maxDiskSize>
	<initialPassword>[Default password]</initialPassword>
	<icon>[Icon type]</icon>
	<virtualization>[Virtualization method]</virtualization>
	<softwares>
		<software>
			<id>[Software ID]</id>
			<order>[Display order]</order>
			<patches>
				<patch>
					<id>[Patch ID]</id>
					<locale>
						<lcid>[Locale ID]</lcid>
						<componentName>[Component name]</componentName>
						<description>[Description]</description>
					</locale>
					…
				</patch>
				…
			</patches>
		</software>
		…
	</softwares>
</image>

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

Modify image information files as necessary, by referring to the information in this table.

The square brackets enclosing some of the tag names indicate that these tags can be omitted.

Tag name	Type	Setting range	Description	Required?	Settings
Id	string ASCII	1 to 32 bytes	This item specifies the image ID.	M	Specify the image ID that was verified using the cfmg_listvmimage command (described in "Displaying a Virtual Image List").
name	string ASCII	1 to 32 bytes	This item specifies the image name.	M	Specify the image name that was verified using the cfmg_listvmimage command (described in "Displaying a Virtual Image List").
ownerOrg	string ASCII	Fixed value	This item specifies the organization ID of the organization to which the image belongs.	M	The value is fixed as "cfmgadm".
ownerUser	string ASCII	Fixed value	This item specifies the user ID of the user who registers the image.	M	The value is fixed as "cfmgadm".
publicCategory	string ASCII	Fixed value	This item selects the category of the image.	M	The value is fixed as "PUBLIC". The image is available to all users.
serverCategory	string ASCII	Fixed value	This item selects the category of the server included in the image.	M	The value is fixed as "GENERAL". The server is a generic server.
serverApplication	string ASCII	Select	This item selects the usage of the server included in the image.	M	One or more values can be selected from the following: - "WEB": Web server - "AP": Application server - "DB": Database server Separate each value with "/" when specifying more than one value. Values can be specified in any order. Example: WEB/AP, AP/WEB/DB, etc.
serverType	string ASCII	0 to 32 bytes	This item specifies the server type.	O	Specify the name of an L-Server Template that has been set up and will be selected as the default L-Server Template when this image is used.
cpuBit	integer	Select	This item selects the number of bits used in the CPU of the server included in the image.	M	Select one of the following values: - "32": 32 bits - "64": 64 bits
sysvolSize	decimal	In decimal notation, to one decimal place	This item specifies the size of the system disk for a server included in the image.	M	Specify this value in GB.
numOfNic	integer	1 to 99	This item specifies the number of NICs.	M	Specify the number of NICs for the server included in the image.
[ maxCpuPerf ]	decimal	In decimal notation, to one decimal place (0.1 to 99999.9)	This item specifies the limit for the CPU performance that can be specified for the server.	M	Specify the limit for the CPU performance that can be specified for the server using the Manager View. Specify the value in GHz.
[ numOfMaxCpu ]	integer	1 to 99	This item specifies the limit for the number of CPUs that can be specified for the server.	M	This value will be the maximum number of CPUs that users can specify with the Manager View.
[ maxMemorySize ]	decimal	In decimal notation, to one decimal place (0.1 to 99999.9)	This item specifies the limit for the memory size that can be specified for the server.	M	Specify the limit for the memory size that can be specified for the server using the Manager View. Specify the value in GB.
[ numOfMaxDisk ]	integer	0 to 99	This item specifies the maximum number of expansion disks that can be added to the server.	M	This value will be the maximum number of disks that can be specified.
[ maxDiskSize ]	decimal	In decimal notation, to one decimal place (0.1 to 99999.9)	This item specifies the limit for the disk capacity that can be specified for expansion disks.	M	Specify this value in GB. This value will be the maximum size of expansion disks that can be specified.
initialPassword	string UTF-8	Up to 85 characters	This item specifies the default password for the operating system.	M	[Windows] - If the virtualization software is Vmware: Specify the password for the user name "Administrator". - If the virtualization software is Hyper-V: Specify the password for the local administrator account used by the L-Server to be created. [Linux] Specify the password for the superuser.
icon	string UTF-8	Select	This item selects the icon for the server included in the image.	M	Select one of the following icons, corresponding to server usages (as specified by the "serverApplication" item). - "unit_tag_web.png": Web server - "unit_tag_ap.png": Application server - "unit_tag_db.png": Database server - "unit_tag_webap.png": Web/application servers - "unit_tag_webdb.png": Web/database servers - "unit_tag_apdb.png": Application/database servers - "unit_tag_webapdb.png": Web/application/database servers - "unit_tag_blank.png": Other
virtualization	string ASCII	Fixed value	This item specifies the virtualization method.	M	The value is fixed as "hvm".
softwares	-	-	This item specifies the software installed on the server.	U	This tag is mandatory.
software	-	One or more	This item is specified for each software program installed on the server.	U
Id	string ASCII	1 to 32 bytes	This item specifies the software ID of the software.	M	Specify the software ID that is displayed in the registration results of the cfmg_addsoft command (described in "Registering Software information ") or in the output results of the cfmg_listsoft command.
order	integer	0 or more	This item specifies the order in which software programs are to be displayed.	M	Specify the software programs in order, starting from "0". Make sure that the operating system is listed first.
patches	-	-	This item specifies patch information for the software.	U
[ patch ]	-	One or more	This item is specified for each patch or update that needs to be applied.	U	This item is required only when patch information exists.
Id	string ASCII	1 to 32 bytes	This item specifies the patch ID for the patch.	M	Specify the update number and so on. It is not possible to specify the same patch ID more than once for a single software ID.
locale	-	One or more	This item specifies patch information for each locale.	U
lcid	string ASCII	Select	This item specifies the locale for patch information.	M	Select one of the following values: - "ja": Japanese version - "en": English version
componentName	string UTF-8	Up to 85 characters	This item specifies the name of the component to which the patch is to be applied.	O	Specify an empty string if the patch specification does not include the concept of components. If patch information has already been registered with exactly the same software ID, patch ID and locale, the existing information will be updated by the newly registered information.
description	string UTF-8	Up to 85 characters	This item contains a description for the patch.	O	If patch information has already been registered with exactly the same software ID, patch ID and locale, the existing information will be updated by the newly registered information.

The symbols in the "Required?" column have the following meaning:

M: If the tag is specified, be sure to specify a value.

O: The value can be omitted.

U: There is no need to set a value. Only the tag itself is specified.