The Template Management Commands provide functions for listing, registering, and deleting the various files that make up the system template.
The Template Management Commands can only be used by service providers.
Structure of Template Management Commands
The following table shows how the Template Management Commands are organized.
Type | Function name | Command name | Description |
|---|---|---|---|
Software information manipulation commands | Software information list display command | cfmg_listsoft | This command outputs a list of the software information that has been registered. |
Software information registration command | cfmg_addsoft | This command registers software information. | |
Software information deletion command | cfmg_deletesoft | This command deletes software information. | |
Image information manipulation commands | Virtual image list display command | cfmg_listvmimage | This command outputs a list of the virtual images that have been registered. |
Image information list display command | cfmg_listimageinfo | This command outputs a list of the image information that has been registered. | |
Image information registration command | cfmg_addimageinfo | This command registers image information. | |
Image information deletion command | cfmg_deleteimageinfo | This command deletes image information. | |
Segment information manipulation commands | Virtual network list display command | cfmg_listvnet | This command outputs a list of the virtual networks that have been registered. |
Segment list display command | cfmg_listnetinfo | This command outputs a list of the segments that have been registered. | |
Segment registration command | cfmg_addnetinfo | This command registers segments. | |
Segment deletion command | cfmg_deletenetinfo | This command deletes segments. | |
Template information manipulation commands | Template information list display command | cfmg_listtemplate | This command outputs a list of the template information that has been registered. |
Template information registration command | cfmg_addtemplate | This command registers template information. | |
System template publication setup command | cfmg_showtemplate | This command publishes or delists system templates. | |
Template information deletion command | cfmg_deletetemplate | This command deletes template information. |
Command location
The storage location of the Template Management Commands is shown below.
[Windows] <CIMS installation folder>\Systemwalker\SWCFMG\bin\
Input files
This section explains the file configuration used by Template Management Commands.
The following types of files are used as input files for these commands.
Software information files
Image information files
Segment information files
Template information files
The sections relating to each command explain the relationship between these input files.
Note
For the values of the setting items in the input files, the strings cannot contain control characters such as linefeed or tab characters.
Each tag (everything between <tag name> and </tag name>) must be entered on a single line.
Also, these strings cannot contain the following characters:
< > & " '
Nor can these strings contain the following strings, which are entity references to the characters above:
< > & " '
Return values and error messages
For the execution results of Template Management Commands, check the return values.
If the return value is 0, the command has terminated normally.
If the return value is other than 0, the command has terminated abnormally and an error message is output.
The following example shows how to check return values.
C:\Users\Administrator>cfmg_deletesoft -f -id SW00000003 C:\Users\Administrator>echo %errorlevel% 0 C:\Users\Administrator>
Description format
This section explains the description format for Template Management Commands.
This section explains the synopsis for the commands.
"Command name" "Option" "Option 1" | "Option 2" [Option] […]
The following table explains each item of the command.
Item | Description |
|---|---|
Command name | This is a command name. |
Option | This is an option name, or an option name plus a parameter. |
Option 1 | Option 2 | Select either option 1 or option 2. |
[Option] | Options in square brackets can be omitted. |
[...] | This indicates that multiple options can be entered. However, these additional options can be omitted. |
This section explains the function of a command.
This section explains options.
This section explains the format of the data output when the command terminates normally.
This section explains important points to note when using the command.
This section shows examples of how the command is used.
The examples in the explanations here are based on the Linux version.
