Set-RDMForbiddenPasswordList

Synopsis

Update a forbidden password list.

Syntax

InputObject

Set-RDMForbiddenPasswordList -InputObject <PSForbiddenPasswordList> [-NewName <string>]
 [-Password <PSPassword[]>] [-VerificationMode <ForbiddenPasswordVerificationMode>]
 [-CaseSensitive] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Name

Set-RDMForbiddenPasswordList -Name <string> [-NewName <string>] [-Password <PSPassword[]>]
 [-VerificationMode <ForbiddenPasswordVerificationMode>] [-CaseSensitive]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Update an existing named forbidden password list in the current workspace, identified by its name (or piped from Get-RDMForbiddenPasswordList). Only the supplied properties are changed; -Password replaces the whole list of passwords, and -NewName renames the list. When a list is piped in, its state is applied and can still be overridden by the explicit parameters. Requires system settings edit permission.

Examples

Example 1

PS C:\> Set-RDMForbiddenPasswordList -Name 'Weak' -VerificationMode Contains

Changes the match mode of the list named 'Weak', leaving its passwords and case sensitivity untouched.

Example 2

PS C:\> Set-RDMForbiddenPasswordList -Name 'Weak' -NewName 'Weak passwords'

Renames the list 'Weak' to 'Weak passwords'.

Example 3

PS C:\> $list = Get-RDMForbiddenPasswordList -Name 'Weak'
PS C:\> $list.Passwords += 'password123'
PS C:\> $list | Set-RDMForbiddenPasswordList

Retrieves the list named 'Weak', appends a password, and saves the change through the pipeline.

Example 4

PS C:\> Get-RDMForbiddenPasswordList -Name 'Weak' | Set-RDMForbiddenPasswordList -VerificationMode Equals

Pipes the list named 'Weak' and overrides its match mode while keeping its other properties.

Example 5

PS C:\> $lists = Get-RDMForbiddenPasswordList
PS C:\> foreach ($list in $lists) { $list.Passwords = $list.Passwords -ne 'password123' }
PS C:\> $lists | Set-RDMForbiddenPasswordList

Removes the password 'password123' from every forbidden password list.

Parameters

-CaseSensitive

Match the forbidden passwords case-sensitively.

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

-Confirm

Prompts for confirmation before running the cmdlet.

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

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

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

-InputObject

Forbidden password list to update, obtained from Get-RDMForbiddenPasswordList.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSForbiddenPasswordList
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: InputObject
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Name of the forbidden password list to update. Matching is case-insensitive.

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

-NewName

New name for the list. Renaming replaces the stored list under the new name.

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

-Password

Replaces the passwords of the list, as plain strings or secure strings.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSPassword[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-VerificationMode

Match mode for this list: Contains or Equals.

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

-WhatIf

Shows what would happen if the cmdlet were to run. The cmdlet does not run.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- wi
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

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSForbiddenPasswordList

Forbidden password list to update, obtained from Get-RDMForbiddenPasswordList.

Notes

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