Get-HpcJobTemplate

  • Reference
Module:
HPCPack2016

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

Syntax

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

Description

The Get-HpcJobTemplate cmdlet 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.

Examples

Example 1: Get the default job template

PS C:\>Get-HpcJobTemplate -Name Default

This command gets the default job template for the cluster.

Parameters

-ClusterConnectionString

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING \<head_node_name\>.

This parameter was introduced in HPC Pack 2016.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies an array of the names of 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.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scheduler

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\>

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

HpcJobTemplate