Get-BrokerSessionRecordingStatus
Gets the recording status of the specified session.
Syntax
Get-BrokerSessionRecordingStatus
[-Session] <Session>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Gets the recording status of the specified session.
Examples
EXAMPLE 1
Gets the recording status of the session Uid 1.
Get-BrokerSessionRecordingStatus -Session 1
Parameters
-Session
The session whose recording status to get.
| Type: | Session |
| 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.Session
The session whose recording status to get.
Outputs
Get-BrokerSessionRecordingStatus returns a string representing whether or not the target session is being recorded.
Values can be:
-
SessionBeingRecorded - Session is being recorded.
-
SessionNotRecorded - Session is not being recorded.
Notes
The specified session can be passed using the Session parameter as a session object or a session Uid.