cluscfg setenvs

 

Applies To: Microsoft HPC Pack 2012, Microsoft HPC Pack 2012 R2

Sets the values of one or more specified cluster-wide environment variables.

For examples of how to use this command, see Examples.

Syntax

cluscfg setenvs <name1>=<value1>[<name2>=<value2>...]
[/scheduler:<name>]

cluscfg setenvs {/? | /help}

Parameters

Parameter

Description

<name1>=<value1>[<name2>=<value2>...]

Specifies a list of one or more environment variables and the values to which you want to set those environment variables. Specify each pair of an environment variable name and value in a format of <name>=<value>. To specify multiple environment variables and values, use a space between each pair.

To specify a value that contains spaces, enclose the value in double quotation marks (" ").

To unset an environment variable, do not specify a value. For example, "<variable_to_unset_name>=".

/scheduler:<name>

Specifies the host name or IP address of the head node for the cluster for which you want to set the cluster-wide environment variables. The value must be a valid computer name or IP address. If you do not specify the /scheduler parameter, this command uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies.

/?

Displays Help at the command prompt.

/help

Displays Help at the command prompt.

Remarks

  • For information about the cluster-wide environment variables that are present by default, see the Help for the cluscfg listenvs command.

  • To create your own cluster-wide environment variable, use the cluscfg setenvs command to set a value for it.

  • You must be a cluster administrator to run this command successfully.

Examples

To set the environment variable named MyVariable equal to 1, use the following command:

cluscfg setenvs MyVariable=1

To set the environment variable named Variable1 equal to 150, unset the environment variable named Variable2, and set the environment variable named Variable3 to C:\MyFolder, use the following command:

cluscfg setenvs Variable1=150 Variable2= Variable3=C:\MyFolder

Additional references