Get-RDMEntryCheckOut

Synopsis

Get the check-outs currently active on an entry.

Syntax

__AllParameterSets

Get-RDMEntryCheckOut [-InputObject] <PSConnection> [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Get the current check-outs on an entry. Can be used to decide which specific check-outs to force check in. The result reflects the current server state, so the workspace must be online. An entry with no check-outs returns nothing. Without the "View checkouts" right, only your own check-out is returned; other users' check-outs are omitted.

Examples

Example 1

PS C:\> Get-RDMEntry -Name "MyEntry" | Get-RDMEntryCheckOut

Returns the current check-outs on MyEntry.

Example 2

PS C:\> $entry = Get-RDMEntry -Name "SharedServer"
PS C:\> $checkOut = $entry | Get-RDMEntryCheckOut | Where-Object UserName -eq "jdoe"
PS C:\> $entry | Invoke-RDMEntryCheckIn -CheckOut $checkOut

Force checks in a specific user's check-out on an entry. Requires the "Check in (force)" right.

Parameters

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InputObject

Entry to inspect. Accepts a PSConnection object from the pipeline.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-VaultMode

Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the workspace.

Type: Devolutions.RemoteDesktopManager.VaultMode
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

Entry to inspect

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSEntryCheckOut

Notes

For more information, type "Get-Help Get-RDMEntryCheckOut -detailed". For technical information, type "Get-Help Get-RDMEntryCheckOut -full".