Start-BrokerNaturalRebootCycle
Reboots all machines from the specified catalog when they are not in use.
Syntax
Start-BrokerNaturalRebootCycle
[-InputObject] <Catalog[]>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Creating a natural reboot cycle for a catalog ensures that all machines in the catalog are running the most recent image for the catalog.
The machines are rebooted in a non-disruptive manner, allowing machines that are in use to continue working and be restarted only after they become idle.
Examples
EXAMPLE 1
The above code applies a natural reboot cycle on catalog with Id 1
$c = Get-BrokerCatalog -Uid 1
Start-BrokerNaturalRebootCycle -InputObject $c
Parameters
-InputObject
Reboots all machines from this input catalog. The catalogs can be specified using UID values, name values (including wildcards) or catalog objects.
| Type: | Catalog[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Citrix.Broker.Admin.SDK.Catalog
Catalogs may be specified through pipeline input. The catalogs can be specified using UID values, name values (including wildcards) or catalog objects
Outputs
None
By default, this cmdlet returns no output.
Notes
Natural reboot cycles do not apply to non-power managed and multi session catalogs