< Back
Get-SmaScriptRunStatus
Post
NAME Get-SmaScriptRunStatus
SYNOPSIS
SYNTAX
Get-SmaScriptRunStatus [-RunID] <Int32> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Returns information about the status of a running script using the runID. Equivalent to the 'Run Now Status' in
the SMA admin page.
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
-RunID <Int32>
Specifies the job status to return.
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 --------------------------
Get-SmaScriptRunStatus -RunID 1234
Retrieves the runStatus of job with ID 1234.
RELATED LINKS
Online Version: https://github.com/ArtisanByteCrafter/K ... nStatus.md
SYNOPSIS
SYNTAX
Get-SmaScriptRunStatus [-RunID] <Int32> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Returns information about the status of a running script using the runID. Equivalent to the 'Run Now Status' in
the SMA admin page.
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
-RunID <Int32>
Specifies the job status to return.
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 --------------------------
Get-SmaScriptRunStatus -RunID 1234
Retrieves the runStatus of job with ID 1234.
RELATED LINKS
Online Version: https://github.com/ArtisanByteCrafter/K ... nStatus.md