Invoke-DSPamCheckoutPending

    2025-02-17

    Invoke-DSPamCheckoutPending

    SYNOPSIS

    Approve or deny a pending checkout request.

    SYNTAX

    __AllParameterSets

    Invoke-DSPamCheckoutPending -Checkout <DvlsPamCheckout> [-Approve] [-ApproverMessage <string>]
 [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Change the state of a pending checkout request depending on the -Accept flag parameter.

    EXAMPLES

    EXAMPLE

    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.

    PARAMETERS

    -Approve

    Approve the checkout request

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

    -ApproverMessage

    Test

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Checkout

    Pending pam checkout to accept

    Type: Devolutions.Server.Pam.Dto.DvlsPamCheckout
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases:
- CredentialCheckout
ParameterSets:
- Name: (All)
  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.

    INPUTS

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.Private.ServerResponse

    NOTES

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