Get-CBJob

NAME Get-CBJob



SYNOPSIS

Gets a job from CloudBolt.





SYNTAX

Get-CBJob -Session <Object> -ID <Int32> [-Recurse] [<CommonParameters>]



Get-CBJob -Session <Object> -OrderID <Int32> [-Recurse] [<CommonParameters>]





DESCRIPTION

The `Get-CBJob` function gets a job from CloudBolt. Pass a session to the target CloudBolt instance to the

`Session` parameter (use `New-CBSession` to get a session object) and the ID of the job to the `ID` parameter.





PARAMETERS

-Session <Object>

The session/connecton to the CloudBolt instance to use. Use `New-CBSession` to create a session object.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ID <Int32>

The job's ID.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-OrderID <Int32>

The order ID that created the job.



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Recurse [<SwitchParameter>]

Also get any sub-jobs in each job.



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



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



PS C:\\>GEt-CBJob -Session $session -ID 54



Demonstrates how to get a specific job usng its ID.











RELATED LINKS