Top
ServerView Resource Orchestrator Cloud Edition V3.4.0 Reference Guide (Command/XML)
FUJITSU Software
Part 2 File Reference > Chapter 15 XML Files > 15.18 L-Platform Template > 15.18.2 Image Information
PreviousNext

15.18.2 Image Information

This section explains the image information in detail.

15.18.2.1 Overview of Image Information

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

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

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

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

[Windows Manager]

Installation_folder\RCXCFMG\templates\images\

[Linux Manager]

/opt/FJSVcfmg/templates/images/

Refer to "15.18.2.2 File Information Details" for information on a description of cloning items (tags).

The software ID (which was assigned when the software information was registered) must be entered as the software ID in the image information.

15.18.2.2 File Information Details

Image information files use the following XML format:

<?xml version="1.0" encoding="UTF-8" ?>
<image version="2.0">
	<id>[Cloning image ID]</id>
	<name>[Image information name]</name>
	<resourceId>[Resource ID]</resourceId>
	<imageName>[Cloning image name]</imageName>
	<ownerOrg>[Owner (tenant)]</ownerOrg>
	<ownerUser>[Owner (user)]</ownerUser>
	<publicCategory>[Public category]</publicCategory>
	<serverCategory>[Sever category]</serverCategory>
	<serverApplication>[Server application]</serverApplication>
	<serverType>[Default server type]</serverType>
	<cpuBit>[CPU bit number]</cpuBit>
	<sysvolSize>[System disk size]</sysvolSize>
	<maxCpuPerf>[Maximum CPU performance]</maxCpuPerf>
	<numOfMaxCpu>[Maximum number of CPUs]</numOfMaxCpu>
	<maxMemorySize>[Maximum memory size]</maxMemorySize>
	<numOfMaxDisk>[Maximum number of data disks]</numOfMaxDisk>
	<maxDiskSize>[Maximum data disk size]</maxDiskSize>
	<maxSysvolSize>[Maximum system disk size]</maxSysvolSize>
	<numOfMaxNic>[Maximum number of NICs]</numOfMaxNic>
	<initialPassword>[Initial password]</initialPassword>
	<icon>[Icon type]</icon>
	<virtualization>[Image type]</virtualization>
	<virtualizationMethod>[Virtualization method]</virtualizationMethod>
	<filterPool>[Filter string]</filterPool>
	<dataDiskFlag>[Data disk use]</dataDiskFlag>
	<vmType>[Virtual machine type]</vmType>
	<storeType>[Storage location type]</storeType>
	<relation>[Related software name]</relation>
	<adminUser>[Administrator user name]</adminUser>
	<rootPassword>[Root role password]</rootPassword>
	<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>
	<vdisks>
		<vdisk>
			<no>[Disk number]</no>
			<diskSize>[Disk capacity]</diskSize>
		</vdisk>
		...
	</vdisks>
</image>

The following table shows descriptions of each of these items (tags), as well as their settings:
Modify image information files if necessary, by referring to the information in this table.
Tag cloning names in square brackets [ ] can be omitted.

Tag name

Format

Setting range

Mandatory

Description

id

string

0 - 32 characters

Optional

The cloning image ID.
When image information is updated, cloning image ID to be updated is specified.
When new image information is created, specify nothing.

name

string

Up to 85 characters

Yes

The name of image information is specified.

resourceId

string

1 - 256 characters

Yes

The resource ID.
Specify the resource ID that was confirmed using the cfmg_listvmimage command.

imageName

string

1 - 32 characters

Yes

The cloning image name.
Specify the cloning image ID that was confirmed using the cfmg_listvmimage command.

ownerOrg

string

Fixed value

Yes

The tenant name to which the cloning image belongs.
The value is fixed as "cfmgadm".

ownerUser

string

Fixed value

Yes

The user ID of the user registering the cloning image.
The value is fixed as "cfmgadm".

publicCategory

string

List

Yes

This item selects the cloning image category.
Select one of the following options:
- "PUBLIC": Show the cloning image to all users.
- "PRIVATE": Show the cloning image to the owner (user) only. This can only be specified if the replication function is being used. It cannot be specified at template creation.

serverCategory

string

Fixed value

Yes

This item selects the category of the server included in the cloning image.
The value is fixed as "GENERAL".
The server is a generic server.

serverApplication

string

List

Yes

The usage of the server included in the cloning image.
One or more of the following options can be selected:
- "WEB": Web server
- "AP": Application server
- "DB": DB server
If multiple options are specified, separate each option with a forward slash ("/"). Options can be specified in any order.

(Example) WEB/AP, AP/WEB/DB, etc.

serverType

string

0 - 32 characters

Optional

The server type.
If this cloning image has been used, specify the name of the L-Server template that is to be selected as the default from amongst the L-Server templates that have been set using Resource Management.

cpuBit

integer

List

Yes

The CPU bit count of the server included in the cloning image.
Select one of the following options:
- 32: 32 bit
- 64: 64 bit

sysvolSize

decimal

In decimal notation, to one decimal place
(0.1 to 99999.9)

Yes

The size of the system disk for the server to be deployed.
Specify this value in GB.
The value must be greater than the size of the system disk included in the cloning image.

[ maxCpuPerf ]

decimal

In decimal notation, to one decimal place
(0.1 to 99999.9)

Yes

The maximum specifiable CPU performance for the server.
Specify the maximum CPU performance in GHz that can be specified for the server in the [L-Platform Template] window.
Do not specify if the server virtualization software is OVM for SPARC. The CPU performance cannot be specified and the limit cannot be imposed because the physical CPU performance will be that of the VM host.

[ numOfMaxCpu ]

integer

1 - 99

Yes

The maximum specifiable number of CPUs for the server.
Specify a value up to the maximum number of CPUs that the user can specify in the [L-Platform Template] window.

[ maxMemorySize ]

decimal

In decimal notation, to one decimal place
(0.1 to 99999.9)

Yes

Specify in GB the maximum memory size that can be specified for the server.
If the server virtualization software is RHEL-KVM and memory hot plug is enabled in a VM-specific information definition file, ensure that you specify a value less than or equal to max_definable_memory_size.

numOfMaxDisk

integer

0 to 99

Yes

The maximum number of extension disks that can be added to the server.
Specify a value up to the maximum number of disks that can be specified.

[ maxDiskSize ]

decimal

In decimal notation, to one decimal place
(0.1 to 99999.9)

Yes

The maximum specifiable disk size for extension disks.
Specify a value in GB, up to the maximum disk size that can be specified for extended disks.

[ maxSysvolSize ]

decimal

In decimal notation, to one decimal place
(0.1 to 99999.9)

Yes

The maximum specifiable disk size for system disks.
Specify a value in GB up to the maximum disk size that can be specified for system disks.

numOfMaxNic

integer

1 - 99

Yes

The maximum number of network interface cards (NICs) that can be added to the server.
Specify a value up to the maximum number of NICs that can be specified.

initialPassword

string

Up to 85 characters

Optional

The initial password for the operating system.
The automatically generated password can be set on Windows and Solaris if this is omitted.
Specify the password for the following user.
[Windows]
Specified password is set to OS. If this setting is omitted, an automatically-generated password will be set in the OS.
- When the server virtualization software is VMware or Hyper-V,
the local administrator account password will be configured.
- When the server virtualization software is RHEL-KVM, the local administrator account password will be configured.
Windows Server 2008 R2 and Windows Server 2012 can be specified as the guest OS. For other OSs, please specify the same password as the one that has been set in the cloning image.
- When the server virtualization software is OVM for x86
Specify the password for the local administrator account.
When using Linux Manager or using Windows Manager and a cloning image where "OS setting" are disabled, the password specified here is not set in the OS.
Please specify the same password set in the cloning image.
Refer to "17.5.1 Collecting and Registering" in the "User's Guide for Infrastructure Administrators (Resource Management) CE" for information on "OS setting" when collecting cloning images.
- When the server virtualization software is Citrix XenServer
Specify the password for the local administrator account. When using Linux Manager or using Windows Manager and a cloning image where "OS setting" are disabled, the password specified here is not set in the OS. Please specify the same password set in the cloning image.
Refer to "17.5.1 Collecting and Registering" in the "User's Guide for Infrastructure Administrators (Resource Management) CE" for information on "OS setting" when collecting cloning images.

[Linux]
Specify the super user password.
The password specified here is not set to OS.
Please specify the same password as the one that has been set in the cloning image.

[Solaris]
- When the server virtualization software is Solaris zone
Specify the superuser password. The specified password is set in the OS. If this setting is omitted, an automatically-generated password will be set in the OS.
- When the server virtualization software is OVM for SPARC
Specify a string of no more than 8 characters for the super user password. The specified password is set in the OS. If this setting is omitted, an automatically-generated password will be set in the OS.

[Other]
Specify the password for default users (such as the super user), that can log in. The password specified here is not set to OS.
Please specify the same password as the one that has been set in the cloning image.

icon

string

List

Yes

The icon of the server included in the cloning image.
Select an icon from the following list that corresponds to serverApplication:
- unit_tag_web.png: WEB
- unit_tag_ap.png: AP
- unit_tag_db.png: DB
- unit_tag_webap.png: WEB/AP
- unit_tag_webdb.png: WEB/DB
- unit_tag_apdb.png: AP/DB
- unit_tag_webapdb.png: WEB/AP/DB
- unit_tag_blank.png: Other

virtualization

string

List

Yes

The virtual or physical cloning image type.
Select one of the following options:
- "hvm": Virtual
- "pv": Physical

[ vitualizationMethod ]

string

List

Optional

The cloning image virtualization type.
Specify only if the server virtualization software is OVM for x86.
Select one of the following options:
- "pv": para virtualization
- "hvm": full virtualization
- "pvhvm": full virtualization + PV driver

[ filterPool ]

string

1 - 85 characters

Optional

The string for filtering the VM pool choices for the cloning image.

[ dataDiskFlag ]

string

List

Yes

Specify true if a data disk is included in the image.
Select one of the following:
- "true": Data disk exists
- "false": Data disk absent
If nothing was specified, the setting will be "false".

[ vmType ]

string

List

Yes

Specify the VM type for the image.
Select one of the following:

- "VMware": VMware
- "Hyper-V": Hyper-V
- "RHEL-Xen": RHEL-Xen
- "RHEL-KVM": RHEL-KVM
- "Solaris Containers": Solaris Zones
- "Citrix-Xen": Citrix XenServer
- "OVM-x86": OVM for x86
- "OVM-SPARC": OVM for SPARC

[ storeType ]

string

List

Yes

For RHEL-KVM images, specify the storage location type.
Select one of the following:

- "Virtual Disk": Virtual disk
- "Raw Disk": Existing disk
For RHEL-KVM images, if this is omitted, "Raw Disk" will be set by default.
For images other than RHEL-KVM, all settings will be ignored.

[ relation ]

string

List

Yes

For Solaris zone images, specify a related software name. Select one of the following:

- "BladeLogic": BladeLogic
- "None": No related software

[ adminUser ]

string

1 - 8 characters

Yes

When using Solaris zones and a Solaris 11 image, specify an administrator name.
It must be composed of alphanumeric characters, and start with an alphabetic character.
When omitted or when "root" is specified, root is created as a user.
When something other than "root" is specified, root is created as a role.

[ rootPassword ]

string

1 - 255 characters

Yes

When using Solaris zones and a Solaris 11 image, specify the Root role password.
When something other than "root" is specified for the administrator, if this is omitted, an automatically-generated password will be set for the OS.
When the administrator user is omitted or when "root" is specified, this setting is ignored even if it is specified.

softwares

-

-

No

The software installed on the server.
This tag is required.

software

-

1 or more

No

Specify as many <software> tags as there are software programs installed on the server.

id

string

1 - 32 characters

Yes

The software ID of the software.
Specify the software ID that was displayed in the registration results obtained using the cfmg_addsoft command or in the output results obtained using the cfmg_listsoft command.

order

integer

0 or more

Yes

The order in which software programs are displayed.
Specify the software in order, starting from "0". Make sure that the operating system is listed first.

patches

-

-

No

Patch information for the software.

[ patch ]

-

0 or more

No

Specify as many <patch> tags as there are patches or updates that need to be applied.
These tags are required only when patch information exists.

id

string

1 - 32 characters

Yes

Specify a patch ID for the patch, such as the update number.
The same patch ID cannot be specified multiple times for one software ID.

locale

-

1 or more

No

Patch information for each locale.

lcid

string

Fixed value

Yes

The locale for patch information.

Select one of the following:
- "en": English
- "zh": Chinese

componentName

string

Up to 85 characters

Optional

The name of the component to which the patch is applied.
Specify an empty string if the patch specification does not include the concept of components.
If patch information that matches all of the software ID, patch ID, and locale is already registered, it will be updated by information that is registered later.

description

string

Up to 85 characters

Optional

A description for the patch.
If patch information that matches all of the software ID, patch ID, and locale is already registered, it will be updated by information that is registered later.

[ vdisks ]

-

-

No

Specify the data disk that is included in the image.

vdisk

-

1 or more

Yes

Specify for each of the data disks included in the image.

no

integer

1-99

Yes

Specify the number of the disk to be connected to the L-Server.
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)

Yes

Specify the size of the disk.
Specify the same value as is output to the <diskSize> tag with the cfmg_listvmimage command.

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.

PreviousNext
Copyright 2010-2020 FUJITSU LIMITED