Stop-LogHighLevelOperation
Logs the completion of a previously started high level operation.
Syntax
Stop-LogHighLevelOperation
-HighLevelOperationId <String>
[-EndTime <DateTime>]
-IsSuccessful <Boolean>
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Stop-LogHighLevelOperation logs the completion of a started high level operation.
Examples
EXAMPLE 1
Creates an unmanaged catalog and assigns a machine to it, within the scope of a high level operation start and stop. The identifier of the high level operation is passed into the "-LoggingId" parameter of the service SDK cmdlets. The execution of the cmdlets in the services will create the low level operation logs for the supplied high level operation.
$succeeded = $false #indicates if high level operation succeeded.
# Log high level operation start.
$highLevelOp = Start-LogHighLevelOperation -Text "Create unmanaged catalog" -Source "My Custom Script"
try
{
# Create catalog object
$catalog = New-BrokerCatalog -Name "MyCatalog" -ProvisioningType Manual -AllocationType Permanent -MinimumFunctionalLevel 'LMAX' -LoggingId $highLevelOp.Id
# Add a machine to the catalog
$machine = New-BrokerMachine -CatalogUid $catalog.Uid -MachineName "DOMAIN\Machine" -LoggingId $highLevelOp.Id
$succeeded = $true
}
catch{ "Error encountered" }
finally{
# Log high level operation stop, and indicate its success
Stop-LogHighLevelOperation -HighLevelOperationId $highLevelOp.Id -IsSuccessful $succeeded
}
Parameters
-HighLevelOperationId
Specifies the identifier of the high level operation being completed.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsSuccessful
Specifies if the started high level operation completed sucessfully.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndTime
Specifies the end time of the high level operation being completed.
| Type: | DateTime |
| Position: | Named |
| Default value: | DateTime.UtcNow. |
| 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
None
You can't pipe objects to this cmdlet.
Outputs
None
By default, this cmdlet returns no output.