Get-HpcJobTemplate

Gets information for one or more specified job templates, or for all job templates if none are specified.

Syntax

	Copy Code
Parameter Set: Default Get-HpcJobTemplate [[-Name] <String[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: Default


Get-HpcJobTemplate [[-Name] <String[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Gets information for one or more specified job templates, or for all job templates if none are specified.

If you do not save the HpcJobTemplate object that this cmdlet returns in a variable or redirect the object to another cmdlet, Get-HpcJobTemplate displays information about the job templates. This information includes the name and description for the job template and the dates and times in local time that the job template was created and last changed.

Parameters

-Name<String[]>

Specifies a list of the names of one or more job templates for which you want to get an HpcJobTemplate object or information. To specify multiple job templates, separate the names with commas (,). If you do not specify the -Name parameter, the Get-HpcJobTemplate cmdlet gets HpcJobTemplate objects or information for all available job templates.

Aliases	none
Required?	false
Position?	1
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster that includes the job templates. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>

Aliases	none
Required?	false
Position?	named
Default Value	%CCP_SCHEDULER%
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

None.

Outputs

The output type is the type of the objects that the cmdlet emits.

One or more HpcJobTemplate objects.

Examples

EXAMPLE 1

Displays information about the default job template for the cluster.

	Copy Code
Get-HpcJobTemplate -name Default