Update-DSPamCheckoutPolicy

    2025-01-21

    Update-DSPamCheckoutPolicy

    SYNOPSIS

    Update a PAM checkout policy

    SYNTAX

    __AllParameterSets

    Update-DSPamCheckoutPolicy -PolicyID <guid> [-Name <string>]
 [-CheckoutApprovalMode <CheckoutApprovalMode>] [-CheckoutReasonMode <CheckoutReasonMode>]
 [-AllowCheckoutOwnerAsApprover <ApproverOptions>] [-IncludeAdminsAsApprovers <ApproverOptions>]
 [-IncludeManagersAsApprovers <ApproverOptions>] [-CheckoutTime <int>] [-IsDefault <bool>]
 [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Update a checkout policy using supplied parameters. Omitted parameters are ignored.

    EXAMPLES

    PARAMETERS

    -AllowCheckoutOwnerAsApprover

    Indicate if owner can self-checkout.

    Type: Devolutions.Server.Managers.Pam.Enums.ApproverOptions
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: ''

    -CheckoutApprovalMode

    Indicate if the checkout must be approved. Approval mode choices: Default, None, Mandatory

    Type: Devolutions.Server.Managers.Pam.Enums.CheckoutApprovalMode
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -CheckoutReasonMode

    Indicate if a reason must be given for the checkout. Checkout reason mode choices: Default, None, Mandatory, Optional

    Type: Devolutions.Server.Managers.Pam.Enums.CheckoutReasonMode
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -CheckoutTime

    Default duration assigned to checkout's request. If set at 0, the default value will be used.

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

    -IncludeAdminsAsApprovers

    Indicate if administrators can approve checkout.

    Type: Devolutions.Server.Managers.Pam.Enums.ApproverOptions
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -IncludeManagersAsApprovers

    Indicate if managers can approve checkout.

    Type: Devolutions.Server.Managers.Pam.Enums.ApproverOptions
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -IsDefault

    Set as the default policy. It will affect all policies refering to default values.

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

    -Name

    Policy's name. Must be unique. Cannot be null or white spaces only.

    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: ''

    -PolicyID

    ID of the policy to update

    Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
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 Update-DSPamCheckoutPolicy -detailed". For technical information, type "Get-Help Update-DSPamCheckoutPolicy -full".