< Back

Get-SmaScriptTask

Thu Jan 16, 2020 9:41 am

NAME Get-SmaScriptTask



SYNOPSIS







SYNTAX

Get-SmaScriptTask [-ScriptID] <Int32> [[-OrderID] <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

Returns task information about a specific script.





PARAMETERS

-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-OrderID <Int32>

(Optional) The order (ordinal) ID of a specific task to be returned. The first task in a script is ordinal ID

0, and increments from there.



Required? false

Position? 1

Default value 0

Accept pipeline input? False

Accept wildcard characters? false



-ScriptID <Int32>

The ID of the script who's tasks you'd like information about.



Required? true

Position? 0

Default value 0

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

PSCustomObject







NOTES









-------------------------- EXAMPLE 1 --------------------------



PS> Get-SmaScriptTask -ScriptID 1234



Retrieves task information about a script with ID 1234.



RELATED LINKS

Online Version: https://github.com/ArtisanByteCrafter/K ... iptTask.md