Set-BluGenieJobId



Set-BluGenieJobId

SYNOPSIS

Set-BluGenieJobId is an add-on to manage the Job ID in the BluGenie Console

SYNTAX

Set-BluGenieJobId [[-ID] <String>] [-Remove] [-Walkthrough] [<CommonParameters>]

DESCRIPTION

Set-BluGenieJobId is an add-on to manage the Job ID in the BluGenie Console

A Job ID is an identifier that helps you track the progress of a job.

EXAMPLES

EXAMPLE 1

Command: Set-BluGenieJobId 'ID5564'

Description: Set JobID using the default command name
Notes: The ID is a string

EXAMPLE 2

Command: Set-BluGenieJobId -ID 'ID5564'

Description: Set JobID using the default command name while using the JOB ID parameter
Notes: The ID is a string

EXAMPLE 3

Command: Set-JobId -ID 'ID5564'

Description: Set JobID using the Alias command name while using the JOB ID parameter
Notes: The ID is a string

EXAMPLE 4

Command: Set-BluGenieJobId -Remove

Description: Remove the Job ID.
Notes: If no Job ID is set.  The current time and date will be used instead.

EXAMPLE 5

Command: Set-BluGenieJobId -Help

Description: Call Help Information
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal 
       Get-Help will be called with the -Full parameter

EXAMPLE 6

Command: Set-BluGenieJobId -WalkThrough

Description: Call Help Information [2]
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal 
       Get-Help will be called with the -Full parameter

PARAMETERS

ID

-ID <String>
   Description: JobID value
   Notes:  If left blank the value will be converted to a DateTime value at runtime
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    1
   Default value                
   Accept pipeline input?       false
   Accept wildcard characters?  false

Remove

-Remove [<SwitchParameter>]
   Description: Remove the current value
   Notes:
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false

Walkthrough

-Walkthrough [<SwitchParameter>]
   Description:  Start the dynamic help menu system to help walk through the current command and all of the parameters
   Notes:
   Alias: Help
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false

CommonParameters

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