VCSAG_SET_ENVS
Prev	Logging agent messages	Next

---

VCSAG_SET_ENVS

The VCSAG_SET_ENVS function is used in each script-based entry point file. Its purpose is to set and export environment variables that identify the agent's category ID, the agent's name, the resource's name, and the entry point's name. With this information set up in the form of environment variables, the logging functions can handle messages and their arguments in the unified logging format without repetition within the scripts.

The VCSAG_SET_ENVS function sets the following environment variables for a resource:

VCSAG_SET_ENVS examples, Shell script entry points

The VCSAG_SET_ENVS function must be called before any of the other logging functions.

• A minimal call:

  VCSAG_SET_ENVS ${resource_name}

• Setting the category ID:

  VCSAG_SET_ENVS ${resource_name} ${category_ID}

  VCSAG_SET_ENVS ${resource_name} 1062

• Overriding the default script name:

  VCSAG_SET_ENVS ${resource_name} ${script_name}

  VCSAG_SET_ENVS ${resource_name} "monitor"

• Setting the category ID and overriding the script name:

  VCSAG_SET_ENVS ${resource_name} ${script_name} ${category_id}

  VCSAG_SET_ENVS ${resource_name} "monitor" 1062

  Or,

  VCSAG_SET_ENVS ${resource_name} ${category_id} ${script_name}

  VCSAG_SET_ENVS ${resource_name} 1062 "monitor"

VCSAG_SET_ENVS examples, Perl script entry points

• A minimal call:

  VCSAG_SET_ENVS ($resource_name);

• Setting the category ID:

  VCSAG_SET_ENVS ($resource_name, $category_ID);

  VCSAG_SET_ENVS ($resource_name, 1062);

• Overriding the script name:

  VCSAG_SET_ENVS ($resource_name, $script_name);

  VCSAG_SET_ENVS ($resource_name, "monitor");

• Setting the category ID and overriding the script name:

  VCSAG_SET_ENVS ($resource_name, $script_name, $category_id);

  VCSAG_SET_ENVS ($resource_name, "monitor", 1062);

  Or,

  VCSAG_SET_ENVS ($resource_name, $category_id, $script_name);

  VCSAG_SET_ENVS ($resource_name, 1062, "monitor");