Share via

hpccred mailcred

  • Article

 

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

Sets the credentials for the account that is used to send email notifications about jobs.

Note

This subcommand was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2).

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

Syntax

hpccred mailcred {/clear | /user:[<domain>\]<user_name> [/password:{<password>|*}]}
[/scheduler:<name>]

hpccred mailcred {/? | /help}

Parameters

Parameter

Description

/clear

Clears the existing credentials for the account that is used to send email notifications about jobs. You cannot specify the /clear parameter if you also specify the /user or /password parameter.

/user:[<domain>\]<user_name>

Specifies the account that you want to use to send email notifications about jobs. You cannot specify the /user parameter if you also specify the /clear parameter.

/password:{<password>|*}

Specifies the password for the user for whom you want to set the credentials. If you specify the /user parameter but not the /password parameter, or if you specify an asterisk (*) for the password, the cluscfg mailcred command prompts you for the password.

You cannot specify the /password parameter if you also specify the /clear parameter. If you specify the /password parameter, you must also specify the /user parameter.

/scheduler:<name>

Specifies the host name or IP address of the head node for the cluster for which you want to set the credentials that are used for job submissions. 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

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

Examples

To set credentials for the account that is used to send email notifications about jobs to the credentials for the user with a user name of someone in the CONTOSO domain, use the following command and enter the password for the user when prompted:

hpccred cluscfg mailcred /user:CONTOSO\someone /password:*

To clear the existing credentials for the account that is used to send email notifications about jobs, use the following command:

hpccred mailcred /clear

Additional references