Top
Cloud Infrastructure Management SoftwareV1.2.0 User's Guide

G.2.4 Segment Information Manipulation Commands

This section explains the commands for manipulating segment information.

Virtual network list display command

Synopsis
cfmg_listvnet [-utf8]
Description

This command outputs an XML file that contains a list of the virtual networks 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 networks that have been registered.

<?xml version="1.0" encoding="UTF-8"?>
<networks>
	<network>
		<id>[Resource ID]</id>
		<name>[Network name]</name>
		<category>[Network type]</category>
		<extid>[VLANID]</extid>
		<addrset>
			<name>[Address set name]</name>
			<subnet>[Subnet address]</subnet>
			<mask>[Net mask]</mask>
			<start>[Start address]</start>
			<end>[End address]</end>
		</addrset>
		<exclude>
			<range>
				<start>[Beginning of the excluded addresses]</start>
				<end>[End of the excluded addresses]</end>
			</range>
			…
		</exclude>
		<status>
			<num>[Number of addresses]</num>
			<used>[Number of reserved addresses]</used>
			<avail>[Number of vacant addresses]</avail>
		</status>
	</network>
	…
</networks>
Cautions

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

<?xml version="1.0" encoding="UTF-8"?>
<networks />
Example
# /opt/FJSVcfmg/bin/cfmg_listvnet
<?xml version="1.0" encoding="UTF-8"?>
<networks>
	<network>
		<id>cloud-st-03_641</id>
		<name>cloudst_net1</name>
		<category>BUSINESS</category>
		<extid>70</extid>
		<addrset>
			<name>192.168.xxx.xxx</name>
			<subnet>192.168.xxx.xxx</subnet>
			<mask>255.255.xxx.xxx</mask>
			<start>192.168.xxx.xxx</start>
			<end>192.168.xxx.xxx</end>
		</addrset>
		<exclude>
			<range>
				<start>192.168.xxx.xxx</start>
				<end>192.168.xxx.xxx</end>
			</range>
		</exclude>
		<status>
			<num>30</num>
			<used>9</used>
			<avail>21</avail>
		</status>
	</network>
</networks>

Segment list display command

Synopsis
cfmg_listnetinfo [-v] [-utf8]
Description

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

Detailed format

Simple format

Output format

  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  *
  -
  *
  *
  *
  *
  *
  *
  *
  -
  *
  *
  *
  *
  *
  *
  *
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  -
  *
  -
  *
<?xml version="1.0" encoding="UTF-8"?>
<networks>
	<network>
		<id>[Resource ID]</id>
		<name>[Network name]</name>
		<category>[Network type]</category>
		<extid>[VLANID]</extid>
		<addrset>
			<name>[Address set name]</name>
			<subnet>[Subnet address]</subnet>
			<mask>[Net mask]</mask>
			<start>[Start address]</start>
			<end>[End address]</end>
		</addrset>
		<exclude>
			<range>
				<start>[Beginning of the excluded addresses]</start>
				<end>[End of the excluded addresses]</end>
			</range>
			…
		</exclude>
		<status>
			<num>[Number of addresses]</num>
			<used>[Number of reserved addresses]</used>
			<avail>[Number of vacant addresses]</avail>
		</status>
	</network>
	…
</networks>

*: Indicates information that is output.

-: Indicates information that is not output.

Cautions

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

<?xml version="1.0" encoding="UTF-8"?>
<networks />
Example
# /opt/FJSVcfmg/bin/cfmg_listnetinfo -v
<?xml version="1.0" encoding="UTF-8"?>
<networks>
	<network>
		<id>ST01-M_1446</id>
		<name>gyomu-3</name>
		<category>BUSINESS</category>
		<extid>10</extid>
		<addrset>
			<name>192.168.xxx.xxx</name>
			<subnet>192.168.xxx.xxx</subnet>
			<mask>255.255.xxx.xxx</mask>
			<start>192.168.xxx.xxx</start>
			<end>192.168.xxx.xxx</end>
		</addrset>
		<exclude>
			<range>
				<start>192.168.xxx.xxx</start>
				<end>192.168.xxx.xxx</end>
			</range>
		</exclude>
		<status>
			<num>20</num>
			<used>8</used>
			<avail>12</avail>
		</status>
	</network>
</networks>

Segment registration command

Synopsis
cfmg_addnetinfo -xml <Path to the segment information file>
Description

This command registers segments.

Options

Option

Description

-xml

This option specifies the absolute or relative path to the segment 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_addnetinfo -xml /tmp/template_test/networks/sample.xml

Segment deletion command

Synopsis
cfmg_deletenetinfo [-f] -id <Resource ID>
Description

This command deletes segments.

Options

Option

Description

-f

This option executes the deletion without confirmation.
If this option is omitted, a confirmation message will be output before the deletion takes place.

-id

Specify the resource ID of the segment to be deleted.

Output format

None.

Cautions

None.

Example
# /opt/FJSVcfmg/bin/cfmg_deletenetinfo -id ST01-M_1446
Do you want to delete the segment? (Y/N) y

Detailed explanation of segment information

This section provides detailed segment information.

Segment information

Segment information files are XML documents that list configuration information for virtual networks.

Create and register a separate segment information file for each segment.

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

Sample segment information files are stored in the following directory.

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

[Windows]
<CIMS installation folder>\Systemwalker\SWCFMG\templates\networks\
[Linux]
/opt/FJSVcfmg/templates/networks/
Detailed segment information

Segment information files use the following XML format.

<?xml version="1.0" encoding="UTF-8" ?>
<network version="1.0">
	<id>[Resource ID]</id>
	<category>[Network type]</category>
</network>

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

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

Tag name

Type

Setting range

Description

Required?

Settings

Id

string
ASCII

1 to 32 bytes

This item specifies the resource ID.

M

Specify the resource ID corresponding to the virtual network that was verified using the cfmg_listvnet command (described in "Virtual network list display command").

category

string
ASCII

Select

This item specifies the category.

M

Select one of the following values:
- MANAGEMENT: Management Segment
- BUSINESS: Business segment