Update-DSPamFolder

2024-10-28

Update-DSPamFolder

SYNOPSIS

Update a PAM folder with given values.

SYNTAX

__AllParameterSets

Update-DSPamFolder -FolderID <guid> [-Name <string>] [-Group <string>]
 [-CheckoutApprovalMode <CheckoutApprovalMode>] [-CheckoutReasonMode <CheckoutReasonMode>]
 [-AllowCheckoutOwnerAsApprover <ApproverOptions>] [-IncludeAdminsAsApprovers <ApproverOptions>]
 [-IncludeManagersAsApprovers <ApproverOptions>] [-CheckoutTime <int>]
 [-Permission <PSPermissionWrapper[]>] [-AsLegacyResponse] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Update a PAM folder with given parameters. Goes through every parameter and check if key match a key in current folder data. If so, updates current folder data and send 'PUT' web request.

EXAMPLES

PARAMETERS

-AllowCheckoutOwnerAsApprover

Users can approve their own Check-out requests

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

New checkout approval mode to assign the root

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

New checkout reason mode to assign the root

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

New default checkout time in minutes to assign the root

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

-FolderID

Id of the pam folder to update.

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

-Group

For server version prior to 2024.3.0, the id of the new folder's parent. After that, the group name.

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

-IncludeAdminsAsApprovers

Include administrators when listing approvers

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

Include PAM managers when listing approvers

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

-Name

New name to assign to the folder

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

-Permission

Security permissions. Prior to server version 2024.3.0.0, use the PamUserPermission type. Else, use the ConnectionPermission type on the root folder.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSWrapper.PSPermissionWrapper[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases:
- Security
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

OUTPUTS

RemoteDesktopManager.PowerShellModule.Private.ServerResponse

NOTES

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

RELATED LINKS

• Get-DSPamFolder
• New-DSPamFolder
• Remove-DSPamFolder