Update-DSFolderCredentials

2024-11-18

Update-DSFolderCredentials

SYNOPSIS

Updates the credentials (Username/password) on a folder.

SYNTAX

Clear

Update-DSFolderCredentials [-FolderId] <guid> -ClearCredentials] [-AsLegacyResponse]
 [<CommonParameters>]

Change

Update-DSFolderCredentials [-FolderId] <guid> [[-Username] <string>] [[-Password] <string>]
 [-AsLegacyResponse] [<CommonParameters>]

Inherited

Update-DSFolderCredentials [-FolderId] <guid> -SetInherited] [-AsLegacyResponse]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

If the "ClearCredentials" switch parameter is present, it will delete both username AND password from folder. If not, it checks which field was provided and check with the current folder credentials to update accordingly with what credentials were supplied.

EXAMPLES

EXAMPLE

PS C:> Update-DSFolderCredentials -FolderId "[guid]" -Username "YourNewUsername" -Password "YourNewPassword"

Update

PARAMETERS

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

-ClearCredentials

Clear the username and the password of the folder.

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

-FolderId

ID of the folder to update the credentials

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

-Password

Password of the folder

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Change
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SetInherited

Set the credential mode to inherited.

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

-Username

Username of the folder

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Change
  Position: 1
  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-DSFolderCredentials -detailed". For technical information, type "Get-Help Update-DSFolderCredentials -full".

RELATED LINKS