Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager Command, Definition File and API Reference


Environment variable file (any file name)

Organization of this page

Format

Environment variable name 1 = Variable Value 1
[Environment-variable-name-2 = Variable Value 2]
   :

File

File name is optional.

Storage directory

■Integrated agent host

In Windows:

Any integrated agent host folder# where you want to execute commands.

In Linux:

Any integrated agent host directory# where you want to execute commands.

#

The directory where Environment variable file is stored is arbitrary, but Environment variable file should not be stored in the directory for JP1/IM. If it is stored, it becomes the object of data collection and backup.

When File manipulation facility is used to operate Environment variable file, Environment variable file is stored in the following directory#:

In Windows:
  • For a physical host

    Agent-path\conf\user\

  • For a logical host

    shared-folder\jp1ima\conf\user\

In Linux:
  • For a physical host

    /opt/jp1ima/conf/user/

  • For a logical host

    shared-directory/jp1ima/conf/user/

#

When Environment variable file is operated by definition File manipulation function, Environment variable file is stored in the specified Storage directory. This directory is not subject to data collection or backup.

Description

A File that defines an environment-variable for Execute commands on JP1/IM managed hosts.

When you Execute a command on a JP1/IM managed host with auto Response Action, or manual Response Action in JP1/IM - Manager, you can specify an environment variable as execution environment for that command. Environment variables can be specified by Environment variable file written in the format described here.

You can specify any Environment variable for each command as making Environment variable files(File names are optional).

If Environment variable file is not specified in Windows environment, the command is executed in the system environment variable.

When the definitions are applied

Environment variable file is referenced when starting the command execution.

Character code

The encoding of Environment variable file is the character codes of the managed host that Execute the command. For the character codes, see the explanation of the character codes in 3.15.7(1)(e) Command execution function in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

Line feed code

In Windows: CR+LF

In Linux: LF

Information that is specified

The maximum length of a character string that can be specified in a single line is 1023 bytes. Be sure to insert a line break at the end of each line.

Environment Variable Name

Specifies the name of the environment variable.

You cannot specify an environment variable that contains a newline character.

Value

Specifies Value of the environment-variable.

By specifying the system environment variable name here, Value of the system environment variable is inherited.

When specifying a system environment variable, enclose the system environment variable name in "<-" and "->", and then specify "<-variable->".

Important
  • Do not specify a character string other than the format "environment variable name = variable Value". If this operand is specified, the command may terminate abnormally depending on the host-side OS that Execute the command.

  • Note that Setup Value will not be encrypted or obfuscated if you include something like proxy Setup as an environment-variable.