Top
Cloud Infrastructure Management SoftwareV1.2.0 User's Guide

G.2.2 Software Information Manipulation Commands

This section explains the commands for manipulating software information.

It is also possible to use a software information file that has already been registered.

Refer to "Appendix H Registered Software IDs" for details.

Displaying Software information

Synopsis
cfmg_listsoft [-v] [-utf8]
Description

This command outputs an XML file that contains a list of the software 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 software information that has been registered.

Detailed format

Simple format

Output format

  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  -
  *
  *
  *
  *
  *
  *
  *
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  *
  -
  *
<?xml version="1.0" encoding="UTF-8"?>
<softwares>
	<software>
		<id>[Software ID]</id>
		<name>[Software name]</name>
		<category>[Software category]</category>
		<osCategory>[Operating system category]</osCategory>
		<version>[Version]</version>
		<officialVersion>[Official version]</officialVersion>
		<patch>[Patch version]</patch>
		<license>[License information]</license>
		<support>[Support information]</support>
		<productId>[Model number]</productId>
		<productName>[Product name]</productName>
		<price>[Unit price]</price>
		<chargeType>[Billing method]</chargeType>
		<expectedUsage>[Expected monthly usage]</expectedUsage>
	</software>
	…
</softwares>

*: Indicates information that is output.

-: Indicates information that is not output.

Cautions

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

<?xml version="1.0" encoding="UTF-8"?>
<softwares />
Example
# /opt/FJSVcfmg/bin/cfmg_listsoft
<?xml version="1.0" encoding="UTF-8"?>
<softwares>
	<software>
		<id>SW00000011</id>
		<category>OS</category>
		<name>Red Hat Enterprise Linux 5 (for Intel64)</name>
	</software>
</softwares>

Registering Software information

Synopsis
cfmg_addsoft [-name <Software name>] -xml <Path to the software information file>
Description

This command registers software information.

Options

Option

Description

-name

This option specifies the name of the software to be registered in the software information file, using a string made up of up to 85 printable ASCII characters long.
Enclose the string in double quotes (") if it contains blank spaces.
If this option is specified, the value specified for this option takes precedence over the information in the software information file.
If this option is omitted, the software name in the software information file takes effect.
An error will occur if this option is omitted and a software name has not been entered in the software information file.

-xml

This option specifies the absolute or relative path to the software information file, using a string made up of printable ASCII characters.

Enclose the string in double quotes (") if it contains blank spaces.

Output format

The software ID that has been allocated is output using the following XML format.

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<id>[Software ID]</id>
</result>
Cautions

None.

Example
# /opt/FJSVcfmg/bin/cfmg_addsoft -xml /tmp/template_test/software/software.xml
<?xml version="1.0" encoding="UTF-8"?>
<result>
	<id>SW00000003</id>
</result>

Deleting Software information

Synopsis
cfmg_deletesoft [-f] -id <Software ID>
Description

This command deletes software 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.

-id

This option specifies the software ID of the software information to be deleted.

Output format

None.

Cautions

None.

Example
# /opt/FJSVcfmg/bin/cfmg_deletesoft -id SW00000011
Do you want to delete the software information?  (Y/N) y

Detailed explanation of software information

This section provides detailed software information.

Software information

Software information files are XML documents that list configuration information for the software (the operating system and middleware) contained in the virtual image.

Create and register one software information file for each item of software.

Because software information for main Fujitsu middleware products and operating systems comes with the product, there is normally no need for service providers to create these software information files.

Refer to "Appendix H Registered Software IDs" for details on the software information files that come with this product.

When license information and so on is required, the service provider will need to modify the content of the files.

Refer to "Software infoemation Details" for details on the items (tags).

To register software such as OSS, a new software information file must be created.

Sample software 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\softwares\
Software information Details

Software information files use the following XML format.

<?xml version="1.0" encoding="UTF-8" ?>
<software version="1.1">
	<id>[Software ID]</id>
	<lcid>[Locale ID]</lcid>
	<name>[Software name]</name>
	<category>[Software category]</category>
	<osCategory>[Operating system category]</osCategory>
	<version>[Version]</version>
	<officialVersion>[Official version]</officialVersion>
	<patch>[Patch version]</patch>
	<license>[License information]</license>
	<support>[Support information]</support>
	<productId>[Model number]</productId>
</software>

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

Modify software 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 ]

-

-

This item sets the ID that is allocated when the software information is registered.

U

[ lcid ]

string
ASCII

Select

This item specifies the locale for software information.

M

Select one of the following values:
- "ja": Japanese version
- "en": English version

[ name ]

string
UTF-8

Up to 85 characters

This item specifies the name of the software.

Specify this item when registering software information.

O

category

string
ASCII

Select

This item specifies the category of the software.

M

Select the following value:
- "OS": Operating system

osCategory

string
ASCII

Select

This item specifies the software category of the operating system.

M

Select one of the following values:
- "windows": Windows
- "linux": Linux
- "windows64": Windows (64bit)
- "linux64": Linux (64bit)

version

string
ASCII

1 to 10 bytes

This item specifies the version of the software.

M

Specify the version.
Example: 9.2.0

officialVersion

-

-

This item specifies the official version.

U

patch

-

-

This item represents patch information.

U

Specify information about the patches that have been applied in the image information files.

license

string
UTF-8

Up to 85 characters

This item specifies license information for the software.

O

If "OS" was selected for the "category" item, specify the product key for the Windows operating system.
This item cannot be specified for Linux operating systems.
- If the virtualization software is Vmware:
For Windows Server 2003, specify the product key for the Windows operating system.
Example:
XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
For operating systems other than Windows Server 2003, specify an empty string.
- If the virtualization software is Hyper-V:

Specify the product key for the Windows operating system.
Example:
XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

support

string
UTF-8

Up to 85 characters

This item specifies support information for the software.

O

productId

-

-

This item specifies the product ID of the software.

U

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.