Page History

...

Use-JobSchedulerAlias [-Prefix <String>] [-Excludes <String[]>] [-ExcludesPrefix <String>] -NoDuplicates [<Comm
onParameters>]

DESCRIPTION

To create aliases alias names this cmdlet has to be dot sourced, i.e. use

...

• All cmdlets use a unique qualifier for the module as e.g. Use-JobSchedulerMaster, Get-JobSchedulerInventory etc.
• Users can use this cmdlet to create a short shorthand notation for cmdlet alias names. Two flavors are offered:
  • use a shorthand notation as e.g. Use-JSMaster instead of Use-JobSchedulerMaster. This notation is recommended as is
    suggests fairly unique names.
  • use a shorthand notation as e.g. Use-Master instead of Use-JobSchedulerMaster. This notation can conflict with cmdle
    ts of the PowerShell Core, e.g. for Start-Job, Stop-Job
• Users can exclude shorthand notation for specific cmdlets by use of an exclusion list.

...

• Use-JobSchedulerMaster
• Use-JSMaster
• Use-Master

Default: . UseJobSchedulerAlias -Prefix JS
Default: . UseJobSchedulerAlias -NoDuplicates -ExcludesPrefix JS

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

...

-Excludes <String[]>
Specifies a list of resulting alias names that are excluded from alias creation.

When omitting the Use-JobSchedulerAlias -Prefix parameter then

• at the time of writing - the following aliases alias names would conflict with cmdlet names from the PowerShell Core:

• Get-JobEvent
• StartGet-Job
• StopStart-Job

...

• Stop-Job

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

ExcludesPrefix

-ExcludesPrefix <String>
Specifies a prefix that is used should a resulting alias be a member of the list of
excluded aliases that is specified with the -Excludes parameter.

When used with the -NoDuplicates parameter then this parameter specifies the prefix that is used
for aliases that would conflict with any exsting cmdlets, functions or aliases.

Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

...

-NoDuplicates <SwitchParameter>
This parameters specifies that no aliases alias names should be created that conflict with existing cmdlets, functions or aliasa
es liases.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

...

Creates aliases for all JobScheduler CLI cmdlets that allow to use, e.g. Use-JSMaster for Use-JobSchedulerMaster

...

Creates aliases for all JobScheduler CLI cmdlets that allow to use, e.g. Use-Master for Use-JobSchedulerMaster.
This is specified by omitting the -Prefix parameter.

...

Creates aliases for all JobScheduler CLI cmdlets that allow to use e.g. Use-Master for Use-JobSchedulerMaster.
Should any alias conflice name conflict with an existing cmdlet, function or alias then the alias will be created with the
prefix specified by the -ExcludesPrefix parameter.

The JobScheduler CLI module uses this alias setting by defalt.