< Back
Wait-CBorder
Post
NAME Wait-CBorder
SYNOPSIS
Waits for a CloudBolt order to complete.
SYNTAX
Wait-CBorder -Session <Object> -ID <Int32> [-Timeout <TimeSpan>] [-RetryInterval <TimeSpan>] [<CommonParameters>]
DESCRIPTION
The `Wait-CBOrder` function waits for a CloudBolt order to complete. Pass the session to the target CloudBolt
instance to the `Session` parameter (use `New-CBSession` to create a session object). Pass the ID of the order to
the `ID` parameter. You can also pipe order objects or IDs to `Wait-CBOrder`.
By default, will wait 100 seconds for the job to complete, checking the status every second.
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
-Timeout <TimeSpan>
The total amount of time to wait for the order to complete. The default value is 100 seconds. If the order
doesn't complete, the function returns nothing.
Required? false
Position? named
Default value (New-TimeSpan -Seconds 100)
Accept pipeline input? false
Accept wildcard characters? false
-RetryInterval <TimeSpan>
The amount of time to wait between checking the order's status. The default is one second.
Required? false
Position? named
Default value (New-TimeSpan -Seconds 1)
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:\\>Start-CBOrder -Session $session -GroupID 4398 -BlueprintID 383 | Wait-CBOrder -Session $session
Demonstrates how to pipe an object from `Start-CBOrder` to `Wait-CBOrder`, which will wait until the order
completes or the wait times out.
RELATED LINKS
SYNOPSIS
Waits for a CloudBolt order to complete.
SYNTAX
Wait-CBorder -Session <Object> -ID <Int32> [-Timeout <TimeSpan>] [-RetryInterval <TimeSpan>] [<CommonParameters>]
DESCRIPTION
The `Wait-CBOrder` function waits for a CloudBolt order to complete. Pass the session to the target CloudBolt
instance to the `Session` parameter (use `New-CBSession` to create a session object). Pass the ID of the order to
the `ID` parameter. You can also pipe order objects or IDs to `Wait-CBOrder`.
By default, will wait 100 seconds for the job to complete, checking the status every second.
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
-Timeout <TimeSpan>
The total amount of time to wait for the order to complete. The default value is 100 seconds. If the order
doesn't complete, the function returns nothing.
Required? false
Position? named
Default value (New-TimeSpan -Seconds 100)
Accept pipeline input? false
Accept wildcard characters? false
-RetryInterval <TimeSpan>
The amount of time to wait between checking the order's status. The default is one second.
Required? false
Position? named
Default value (New-TimeSpan -Seconds 1)
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:\\>Start-CBOrder -Session $session -GroupID 4398 -BlueprintID 383 | Wait-CBOrder -Session $session
Demonstrates how to pipe an object from `Start-CBOrder` to `Wait-CBOrder`, which will wait until the order
completes or the wait times out.
RELATED LINKS