Get-DSPamCheckout

Synopsis

Return the Pam credential password

Syntax

GetByID

Get-DSPamCheckout -CheckoutID <guid> [-AsLegacyResponse] [<CommonParameters>]

EntryID

Get-DSPamCheckout -AccountID <guid> [-AsLegacyResponse] [<CommonParameters>]

Active

Get-DSPamCheckout -ActiveAndPending [-AsLegacyResponse] [<CommonParameters>]

Description

Return the PAM credential password if it is currently checked out and user has rights.

Examples

Example 1

PS C:\> $checkoutResponse = Get-DSPamCheckout -ActiveAndPending;
        $pending = $checkoutResponse | Where Status -eq "Pending";
        Invoke-DSPamCheckoutPending -Checkout $pending[0] -Approve -ApproverMessage "Accepted"

Get all pending checkouts. Select the desired checkout and approve it.

Example 2

PS C:\> $checkout = Get-DSPamCheckout -CheckoutID "2735a06c-baa0-4ff9-911c-aa1fcc03ea1e";
        Invoke-DSPamCheckin -Checkout $checkout

Get a pam checkout and check in.

Parameters

-AccountID

Get the active checkout of the specified ID

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: EntryID
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ActiveAndPending

Get all active and pending checkouts

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Active
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

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

-CheckoutID

Checkout's ID

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases:
- PamCheckoutID
ParameterSets:
- Name: GetByID
  Position: Named
  IsRequired: true
  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.

Notes

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