Function
Using console define files previously created, this command can perform the registration of the following items usually performed with management console.
Console definition
System group
Proxy Manager
Agent
Privileges required for execution
[Windows]
The privileges of a user belonging to the "Administrators" group are required to execute this command.
Execution environment
This command can be run on an operation management client.
Syntax
[Windows]
<installation directory>\bin\sqcSetupConsoleDefine.bat -f <console_define_file> |
Options
Specifies the console definition file.
This file is created in XML format.The suffix is [xml]. Follow the formats described below.
Tag | Attribute | Content |
ConsoleDefine | DisplayName | Specify the console definition name. Only alphanumeric characters [a-z, A-Z, 0-9], hyphens ('-') and underscores ('_') can be used. Note '-'(hyphen) cannot be used as the first character. Upper and lower characters are not distinguished. The length must be within 64 characters. |
SystemGroup | DisplayName | Specify the display name to identify the system group. This must be unique within the management configuration. However, use Agent name or ProxyManager name as the display name is allowed. The following characters of Shift-JIS code can be used. - Alphanumeric characters - Symbols (exception: \:,<>"$'[]=&). Characters dependent on machines are not allowed. Length must be within 64 characters. |
ProxyManager | DisplayName | Specify the display name to identify the Proxy Manager. This must be unique within the management configuration. However, use Agent name or system group name as display name is allowed. The following characters of Shift-JIS code can be used. - Alphanumeric characters - Symbols (exception: \:,<>"$'[]=&). Characters dependent on machines are not allowed. Length must be within 64 characters. |
InstanceName | Specify an identify name for the Proxy Manager. The registered names must be unique within one group. However, a same host name can be registered to different groups. In case one Proxy Manager is used for multiple business, it is allowed to create a system group for every business, and register the same proxy manager to these system groups. However, the display name of the ProxyManager must be different. The identify name will be displayed by the sqcSetPolicy (policy application command). Regarding the policy application command, refer to "1.1.3 sqcSetPolicy (Policy Application Command)". | |
Agent | DisplayName | Specify a display name to identify the Agent. This must be unique within the management configuration. However, use Agent name or ProxyManager name as display name is allowed. The following characters of Shift-JIS code can be used. - Alphanumeric characters - Symbols (exception: \:,<>"$'[]=&). Characters dependent on machines are not allowed. Length must be within 64 characters. |
InstanceName | Specify a identify name for the Agent. The registered names must be unique within one group. However, a same host name can be registered to different groups.In case one Agent is used for multiple business, it is allowed to creat a system group for every business, and register the same agent to these system groups. However, the display name of the Agent must be different. The identify name will be displayed by the sqcSetPolicy (policy application command).Regarding the policy application command, refer to "1.1.3 sqcSetPolicy (Policy Application Command)". Point If the Agent is in cluster operation, specify the physical host name or physical IP address. |
Point
Prepare a definition file for every console definition. You can do this by copying the sample file (ConsoleDefine_sample.xml) to a proper file and editting it.
Location of the sample file:
<installation directory>\www\control\ConsoleDefine_sample.xml |
Define multiple SystemGroup tags (the block from <SystemGroup> to </SystemGroup>) to define multiple system groups.
Define multiple ProxyManager tags (the block from <ProxyManager> to </ProxyManager>) to define multiple ProxyManagers.
Define multiple Agent tags (the block from <Agent> to </Agent>) to define multiple Agents.
Return values
Normal termination: 0
Abnormal termination: 1
Execution results/Output format
The following normal completion message will be sent to standard output.
(Success):sqcSetupConsoleDefine |
"C:\Program Files\SystemwalkerSQC-C\bin\sqcSetupConsoleDefine.bat" -f "C:\tmp\condef1.xml" (Success):sqcSetupConsoleDefine |
An error message will be sent to standard error output:
(Error):Message,error number |
The error numbers, messages, and content corresponding to the error messages are as shown below.
Error number | Message | Content | Corrective measure |
|---|---|---|---|
010 | Parameter error.(error detail code) | Parameter specification error | Modify the parameter and run again. |
020 | Server access error.(error detail code) | Server communication error | Confirm the connection state of the Manager and run again. |
030 | Definition file error.(error detail code) | Error reading the console definition file. | Confirm the console define file and run again. |
100 | System error.(error detail code) | Other error | Collecting the maintenance information and contact a Fujitsu SE. |
In case the specified console definition file not exist.
"C:\Program Files\SystemwalkerSQC-C\bin\sqcSetupConsoleDefine.bat" -f "C:\tmp\condef2.xml" "C:/tmp/condef2.xml" is not found. (Error):Parameter error.(11), 010 |
In case the DCM service of the Manager is not running.
"C:\Program Files\SystemwalkerSQC-C\bin\sqcSetupConsoleDefine.bat" -f "C:\tmp\condef1.xml" Cannot connect to the Manager. |
In case Agent name is not unique (mistake in console definition file)
"C:\Program Files\SystemwalkerSQC-C\bin\sqcSetupConsoleDefine.bat" -f "C:\tmp\condef3.xml" Specified "DisplayName" of "Agent" already exists. DisplayName = Agent01 (Error):Definition file error.(34), 030 |
Usage example
Below is an example of creating a console definition under following condition.
C:\tmp\condef1.xml
Console1
GRP1
GRP2
Display name: SYSTEM01/System name: SYSTEM01
Display name: SYSTEM01/System name: SYSTEM01
Display name: SYSTEM01#/System name: SYSTEM01
Display name: SYSTEM02/System name: SYSTEM02
Console definition file (C:\tmp\condef1.xml)
<?xml version="1.0" encoding="Shift_JIS"?> <ConsoleSettings> <ConsoleDefine DisplayName="Console1"> <SystemGroup DisplayName="GRP1"> <ProxyManager DisplayName="SYSTEM01" InstanceName="SYSTEM01"/> <Agent DisplayName="SYSTEM01" InstanceName="SYSTEM01"/> </SystemGroup> <SystemGroup DisplayName="GRP2"> <Agent DisplayName="SYSTEM01#" InstanceName="SYSTEM01"/> <Agent DisplayName="SYSTEM02" InstanceName="SYSTEM02"/> </SystemGroup> </ConsoleDefine> </ConsoleSettings>
