Hitachi

uCosminexus Application Server Definition Reference Guide


8.2.14 .mngsvrutilrc (Client-side definition file of the mngsvrutil command)

Organization of this subsection

(1) Format

J2SE property file format.

(2) File storage location

Home directory of each OS user

(3) Functionality

Specify the default values for the mngsvrutil command options.

(4) Application timing

After the settings file is changed, the updated information is applied during the next execution of the mngsvrutil command.

(5) Specifiable keys

The following table describes the keys that you can specify in the client-side definition file, their contents, and the default values used when the specification is omitted:

Key name

Contents

Specifiable value

Default

VR

mngsvrutil.connect.host

Set the Management Server host name and port number to be specified in the -m option.

(Example of settings)

mngsvrutil.connect.host=localhost:28080

  • Host name

    Specify an IP address with dot notation or a host name for which the name analysis can be performed.

    You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#1

  • Port number

    Follow the Management Server settings. The default value is '28080'.

Precautions
  • When performing the operations in the host unit management model, if a value is specified in webserver.connector.http.bind_host of mserver.properties, specify the same value in this key.

  • Do not specify a colon (:) in the regular expression indicating the IP address. If a colon (:) is specified, the string after the colon is considered as the port number.

Specify one of the following values:

  • Host name

  • IPv4 address

None

06-00

mngsvrutil.connect.password

Set the password to be specified in the -p option. Note that this key is not required if a password has not been set.

(Example of settings)

mngsvrutil.connect.password=admin

Specification of this property is ignored if the functionality to omit the management user account is enabled.

Management user account password of Management Server

None

06-00

mngsvrutil.connect.userid

Set the user ID to be specified in the -u option.

(Example of settings)

mngsvrutil.connect.userid=admin

Specification of this property is ignored if the functionality to omit the management user account is enabled.

User ID of the management user account of the Management Server

None

06-00

mngsvrutil.output.file

Set the output file name to be specified in the -o option.

(Example of settings)

In Windows

mngsvrutil.output.file=C:/tmp/output.txt

In UNIX

mngsvrutil.output.file=/tmp/output.txt

File name (absolute path)

None

06-00

mngsvrutil.output.format

Set the output format to be specified in the -f option.

To output in the CSV format, specify csv and to output in the SNMP integration format, specify snmp.

(Example of settings)

mngsvrutil.output.format=csv

The following strings can be specified:

  • csv

  • snmp

csv

06-00

mngsvrutil.output.suppress_header

Set this property to true when specifying the -h option and set false when not specifying the option. Note that the value is not case sensitive.

(Example of settings)

mngsvrutil.output.suppress_header=true

The following strings can be specified:

  • true

  • false

false

06-00

mngsvrutil.target_name#2

Specifies the logical server name or the host name to be specified in the -t option.

(Example of settings)

mngsvrutil.target_name=myServer

Specify the target name (logical server name or host name) to be used by the sub-command.

Follow the definition of Logical server configuration definition of the management portal.

You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#1

Precautions

When you want to specify host in the -k option or mngsvrutil.target_kind, specify the same value that is specified for webserver.connector.http.bind_host in mserver.properties.

Specify one of the following values:

  • IPv4 address

  • Host name

  • logical-server-name

None

06-00

mngsvrutil.target_kind

Specify the target kind to be specified in the -k option.

(Example of settings)

mngsvrutil.target_kind=host

The following strings can be specified:

  • logicalServer

  • host

logicalServer

06-00

mngsvrutil.target_server_name#2

Set the logical server name to be specified in the -t option. This key is provided for compatibility. Hitachi recommends using mngsvrutil.target_name. If you specify this property along with mngsvrutil.target_name, the value specified in mngsvrutil.target_name is used.

(Example of settings)

mngsvrutil.target_server_name=myServer

Specified in alphanumeric characters and symbols.

None

06-00

Notes

If a key does not exist or if it is incorrectly specified, the default value is used.

As this file holds important information such as passwords, set appropriate access permissions for this file.

When you code characters other than the ASCII characters, match the character encoding of the setup file and that of the OS locale when the executing the mngsvrutil command. Moreover, when using Japanese, do not specify character strings that include escape sequences.

For SNMP integration using 'JP1/Cm2/ESA for Extension Mib Runtime' or 'JP1/Cm2/Extensible Agent for Extension Mib Runtime', create the settings file under the home directory of the executing user of 'JP1/Cm2/ESA for Extension Mib Runtime' or 'JP1/Cm2/Extensible Agent for Extension Mib Runtime'.

#1

If the IP address subnet used in the communication with the Administration Agent in the management domain is fixed, and if the IP address to be specified is coded as 192\\.168\\.0\\..+, the IP address matches with the IP address starting with 192.168.0. (for example, 192.168.0.32 or 192.168.0.128), so the setup file can be distributed to all the hosts and can be used without modifications. For details on the regular expressions, check the specifications for the java.util.regex.Pattern class in Java.

However, as "\\" is replaced with the single character "\", when specifying "\", specify two characters in succession. If multiple IP addresses matching with the specified regular expression are detected, the IP address with the smallest value is used. For example, if 192.168.0.32 and 192.168.0.128 are detected, 192.168.0.32 will be used. In this case, the used IP address is not always the intended IP address, therefore, make sure to code a regular expression such as 192\\.168\\.0\\.1.. to match with only one IP address.

#2

For information about the relation between the mngsvrutil.target_name key and the mngsvrutil.target_server_name key specification with the -k option and -t option of the mngsvrutil command, see mngsvrutil (Management Server management command) in the manual uCosminexus Application Server Command Reference Guide.