Privileges required for execution
[Windows]
The privileges of a user belonging to the "Administrators" group are required to execute this command.
[UNIX]
The privileges of a system administrator (superuser) are required to execute this command.
Execution environment
This command can be executed on Enterprise Manager, Manager, Proxy Manager, and Agent.
Syntax
[Windows]
<Installation directory>\bin\sqcSetPolicy.exe [-h <host name>] [-p <IP address>] |
<Installation directory>\ bin\sqcSetPolicy.exe -v |
[UNIX]
/opt/FJSVssqc/bin/sqcSetPolicy.sh [-h <host name>] [-p <IP address>] |
/opt/FJSVssqc/bin/sqcSetPolicy.sh -v |
Function
This command applies policies. The system name can be changed using the -h option. Also, when using dashboard, setting target IP address to be managed using the -p option.
Note
Do not execute multiple sqcSetPolicy commands simultaneously.
Point
From Systemwalker Service Quality Coordinator V13.3.0 onwards, the service or daemon no longer needs to be stopped before executing the Policy Application Command.
However, before using the "-h" option or "-p" option, service or daemon needs to be stopped. Execute the Policy Application Command after stopping the service or daemon by referring to "Chapter 2 Starting and Stopping Resident Processes".
If the services or daemons are running and performance data for various middleware is being collected when the Policy Application Command is executed, then the collection of this performance data will be temporarily suspended while policies are applied. Collection of this performance data will start again after the policies have been finished being applied.
Options
Use this option to specify a system name to change the managed system name.
Also, use this option to specify a system name for the managed system in the following kinds of cluster operations:
Where the server is a Manager and information about resources within the server is to be collected.
=> Specify the inheritance node.
Where the server is an Agent in a cluster system that uses node name inheritance.
=> Specify node name of each Agent.
If this option is omitted, host name which is set at the installation or the system name which was set at the last -h option will be used as system name.
Host name will not be updated automatically, so use this option to change the host name.
Note
If this command is re-executed or an Agent is reinstalled where an operating environment for this product already exists and an Agent has already been registered, then use the same system name as was used before if the -h option is specified.
If the system name has to be changed for some reason, first delete the previous system name information from the PDB using the data deletion command explained in "1.7.3 sqcPDBerase (Data Deletion Command)". However, in this case, performance information that has already been collected cannot be displayed.
In the dashboard, management target is managed by using IP address.
When using the dashboard, be sure to specify IP address of the management target by using this option after installation. Specify the IP address of the connection Manager or Enterprise Manager which is available for connection.
Specify the inheritance node if the cluster system is being used.
If this option is omitted, IP address which was set at the last -p option will be used.
IP address will not be updated automatically, so use this option to change the IP address.
Note
If this command is executed at the first time after the installation, and if this option is omitted, IP address will be set by the address which is automatically collected. However, if multiple IP addresses are existed, IP address which can communicate with the connection Manager or Enterprise Manager might not be acquired. Be sure to specify IP address of the management target by using -p option.
Use this option to display the system name and the IP address that are currently set.
Return values
Normal termination: 0
Abnormal termination:1
If this command terminates normally, the following message will be output:
(Success) : sqcSetPolicy succeeded.
If the managed middleware is detected on the server where the sqcSetPolicy command is executed, the following message will be output.
The policy has been set for the <middleware name> (Success) : sqcSetPolicy succeeded.
(The name of the detected middleware appears in <middleware name>)
If this command terminates abnormally, the following messages will be output:
(Error ) : sqcSetPolicy Parameter error.
(There is an error in specifying parameter)
(Error ) : The file was not able to be created because of insufficient file access rights or disk space.
(File access error such as no available disk space or access privileges)
(Error ) : There is an error in section [Section : XXX] of the template file sqcSetPolicy Template define error.
(There is an error with a template definition.)
(Error ) : DCM is running and so sqcSetPolicy can not be run.
Please stop dcm and retry sqcSetPolicy.(The Systemwalker SQC DCM service/dcmd process is running.)
Note
If these error messages are displayed, the policies for the policy settings message displayed before the error messages will not take effect.
Usage example
[Windows]
For normal termination C:\Program Files\SystemwalkerSQC\bin>sqcSetPolicy This Computer Name is "XXXX" The policy has been set for the <YYYY> (Success) : sqcSetPolicy succeeded. For abnormal termination C:\Program Files\SystemwalkerSQC\bin>sqcSetPolicy This Computer Name is "XXXX" (Error ) : There is an error in section [Section:ZZZZ] of the template file. With -p option C:\Program Files\SystemwalkerSQC\bin>sqcSetPolicy -p 192.0.2.10 This Computer Name is "XXXX" This IP Address is "192.0.2.10" The policy has been set for the <YYYY> (Success) : sqcSetPolicy succeeded. With -v option C:\Program Files\SystemwalkerSQC\bin>sqcSetPolicy -v This Computer Name is "XXXX" This IP Address is "192.0.2.10" (Success) : sqcSetPolicy succeeded. |
[UNIX]
For normal termination # cd /opt/FJSVssqc/bin/ # ./sqcSetPolicy.sh This Host Name is "XXXX" The policy has been set for the <YYYY> (Success) : sqcSetPolicy succeeded. For abnormal termination # cd /opt/FJSVssqc/bin/ # ./sqcSetPolicy.sh This Host Name is "XXXX" (Error ) : There is an error in section [Section : ZZZZ] of the template file sqcSetPolicy Template define error. With -p option # cd /opt/FJSVssqc/bin/ # ./sqcSetPolicy.sh -p 192.0.2.10 This Host Name is "XXXX" This IP Address is "192.0.2.10" The policy has been set for the <YYYY> (Success) : sqcSetPolicy succeeded. With -v option # cd /opt/FJSVssqc/bin/ # ./sqcSetPolicy.sh -v This Host Name is "XXXX" This IP Address is "192.0.2.10" (Success) : sqcSetPolicy succeeded. |
"XXXX" refers to the name specified with the -h option. If the -h option is omitted, the host name which is set at the installation or the system name which is set at the last -h option will be displayed.
"YYYY" indicates the middleware that has been detected. A separate line will be displayed for each middleware product that is detected.
"ZZZZ" indicates the section of the template file where the definition error was found.
File
If this command is successful, the following files will be created according to the content of the managed object configuration information file.
[Windows]
<Variable file storage directory>\control\ManagedConf_XXXX.xml |
"XXXX" refers to the name specified with the -h option. If the -h option was omitted, the host name which is set at the installation or the system name which is set at the last -h option will be set.
[UNIX]
/etc/opt/FJSVssqc/ManagedConf_XXXX.xml |
"XXXX" refers to the name specified with the -h option. If the -h option was omitted, the host name which is set at the installation or the system name which is set at the last -h option will be set.
Point
Start the service/daemon after applying the policy. This configuration information must then be updated in the Console window.
Refer to "Chapter 2 Starting and Stopping Resident Processes" for details on how to start the service/daemon, and "Agents" in the User's Guide (Console Edition) for details on how to collect and apply configuration information.
Definition error file
When this command is executed,
Agent for Agentless Monitoring management
Eco information management
Virtual resource management
if the content of any one of definitions listed above is invalid, the error message is output to the following files.
[Windows]
<Variable file storage directory>\log\setpolicy_error.log |
[UNIX]
/var/opt/FJSVssqc/setpolicy_error.log |
The content of the message output to the file is as follows.
Message | Action |
|---|---|
[Install-less Agent: %1, %2] | [Meaning] There was an error in the definition of agent for Agentless Monitoring management. %1: The name of remote monitoring configuration file %2: The name of connection account configuration file [Action] Please confirm the content of the error message output starting from the next line, and correct the definition of the corresponding item. |
%1 is Empty (Section: %2) | [Meaning] The value is not set to the item to which the setting is indispensable. %1: Item name of the error object %2: Section name of the setting of the observed server which contains errors [Action] Please confirm the method of defining the definition file, and set the value to the specified item. |
%1 is too long (Section: %2) | [Meaning] The value set to the item is too long. %1: Item name of the error object %2: Section name of the setting of the observed server which contains errors [Action] Please confirm the number of characters that can be set to the item from the method of defining the definition file, and change the length of the specified item. |
%1 is wrong value (Section: %2) | [Meaning] A correct value is not set to the item (selection item) from which the value that can be set is limited (selection). %1: Item name of the error object %2: Section name of the setting of the observed server which contains errors [Action] Please confirm the value that can be set to the item from the method of defining the definition file, and set the correct value to the specified item. |
%1 contains wrong letter (Section: %2) | [Meaning] An invalid character is specified for the value of the item. %1: Item name of the error object %2: Section name of the setting of the observed server which contains errors [Action] Please confirm the characters which can be used for the value of the item, and change the value of the specified item. |
The combination of %1 and %2 is invalid (Section: %3) | [Meaning] The method of the communication and the combination of the two items are not correct. %1: Item name number 1 of the error object %2: Item name number 2 of the error object %3: The section name which contains the error in the remote monitoring configuration file [Action] Please confirm the User's Guide,"Management with an Agent for Agentless Monitoring" and set the correct value of the communication method and the correct combination of the type of OS and virtual machine. |
Selected ACCOUNT is not exist (Section: %1) | [Meaning] The ACCOUNT set on the remote monitoring configuration file is not set on the connection account configuration file. %1: Section name of the setting of the observed serve which contains errors. [Action] Please set ACCOUNT in the specified section to the connection account configuration file. Otherwise, use the account name which is already set on the ACCOUNT in the connection account configuration file. |
%1 has a already been used by other section (Section: %2) | [Meaning] The same value is set to the item that should set a unique value to each section in two sections or more. * The value set to either HOSTNAME or DISPLAYNAME cannot be used any HOSTNAME and DISPLAYNAME of another section. %1: Item name of the error object %2: Section name of the setting of the observed server which contains errors [Action] Please confirm the value set to the item in the specified section is used in the other section, and change the setting not to use the same value. |
Message | Action |
|---|---|
[ECO: %1] | [Meaning] There was an error in the definition of the eco information management. %1: Definition file name which contains errors [Action] Please confirm the content of the error message output starting from the next line, and correct the definition of the corresponding item. |
%1 is NULL (Line no:%2) | [Meaning] The value is not set to the specified item in the configuration information file of the SNMP agent. %1: Item name %2: Line number * There are item names as follows. Hostname: IP Address/Host name SNMP version: version of the SNMP Community: Community name machinekind: Model name Username: User name [Action] Please set value to the item on the specified line. |
%1 is used wrong character (Line no:%2) | [Meaning] An invalid character is specified for the value on the specified line in the configuration file of the SNMP agent. %1: Item name %2: Line number * There are item names as follows. Hostname: IP Address/Host name SNMP version: version of the SNMP Community: Community name machinekind: Model name Username: User name [Action] Please change the value of the "IP address/Host name" on the specified line. |
%1 is too long (Line no:%2) MAX:%3 | [Meaning] The value of the item on the specified line in the configuration file of the SNMP agent is too long. %1: Item name %2: Line number %3: Number of maximum characters * There are item names as follows. Hostname: IP Address/Host name SNMP version: version of the SNMP Community: Community name machinekind: Model name Username: User name [Action] Please set the value shorter than the number of maximum characters to the item on the specified line. |
SNMP version is wrong (Line no:%1) | [Meaning] An invalid string is used for the "SNMP version" on the specified line in the configuration information file of the SNMP agent. %1: Line number [Action] Please change the value of the "SNMP version" on the specified line to character string that can be used (v1, v2, v2c, v3). |
Auth_type is wrong (Line no: %1) | [Meaning] An invalid string is used for the "attestation type" on the specified line in the configuration information file of the SNMP agent. %1: Line number [Action] Please change the value of the "attestation type" on the specified line to character string that can be used (SHA, MD5). |
The same definition already exists. (Line no:%1) | [Meaning] The specified line has already been defined. %1: Line number [Action] Please delete specified line. |
machinename is used wrong character(%1) (lineno=%2) | [Meaning] An invalid character is used for "model name" on the specified line in the ECO information collection definitions file. %1: Model name %2: Line number [Action] Please change the value of the "model name" on the specified line. |
%1 is used wrong character(%2) (lineno=%3) | [Meaning] An invalid character is used for the definition on the specified line in the ECO information collection definitions file. %1: Definition label %2: Model name %3: Line number [Action] Please change the definition on the specified line. |
mibfilename is used wrong filename (not end of filename ".txt") (%1) (lineno=%2) | [Meaning] There is no ".txt" at the end of the definition on the specified line in the ECO information collection definition file. %1: String defined in the mibfilename %2: Line number [Action] Please change the definition on the specified line. |
machine-kind is not defined.ignored line[%1] | [Meaning] Because the corresponding model name is not exist in the ECO information collection definitions file, or the file specified in the mibfilename is not exist, the definition of the specified line in the configuration information file of the SNMP agent is not applied. %1: Line number [Action] Please change the definition on the specified line. |