Set-RDMEntryPassword

Synopsis

Set the password of an entry

Syntax

Id

Set-RDMEntryPassword [-ID] <guid> [-Password] <securestring> [-PasswordAge <int>]
 [-PasswordSinceDate <datetime>] [-PassThru] [-Refresh] [-Set] [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Set-RDMEntryPassword [-InputObject] <PSConnection> [-Password] <securestring> [-PasswordAge <int>]
 [-PasswordSinceDate <datetime>] [-PassThru] [-Refresh] [-Set] [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Set the password of an entry. The entry to modify can be fetched by its ID or by a PSConnection object obtained from Get-RDMEntry, New-RDMEntry, Get-RDMPersonalCredentials, or Get-RDMPrivilegedAccount. In the latter case, the local object will be modified. To modify the password, the user must have the appropriate rights: add for a new entry, and edit for an existing one. For workspace supporting the password age, it is also possible to modify that value for the new password. It can be used to indicate when the password was generated instead of when the password has been set in the entry.

Examples

Example 1

PS C:\> $entry = New-RDMEntry -Type Credential -Name 'NewCredEntry';
    $entry.Credentials.UserName = 'MyUserName';
    Set-RDMEntryPassword -InputObject $entry -Password (Read-Host -AsSecureString -Prompt 'Password')
    Set-RDMEntry -InputObject $entry

The user create a new credential entry. Its username and password are being set. The call to Set-RDMEntryPassword does modify the local object. The user can do more modifications if desired. The last line finally save the new entry.

Example 2

PS C:\> $pwd = ConvertTo-SecureString -AsPlainText -String 'passwordFr0mSomewhereElse';
    Get-RDMEntry -Name 'EntryToModify' | Set-RDMEntryPassword -Password $pwd -PasswordAge 14 -Set -Refresh

The entry named 'EntryToModify' will have an updated password, the one stored in $pwd, and it will be aged of 14 days.

Example 3

PS C:\> Get-RDMEntry -Name 'UniqueName' |
                    Set-RDMEntryDomain -Domain 'MyOtherDomain.com' -PassThru |
                    Set-RDMEntryPassword -Password $securePassword -PassThru |
                    Set-RDMEntryUsername -UserName 'NewUserName' -PassThru |
                    Set-RDMEntry

Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMEntry call.

Parameters

-Confirm

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

-ID

Specifies the ID of the session to get the password from.

Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.

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

-InputObject

Specifies the session to set the password to.

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

-PassThru

Return the modified entry.

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

-Password

Password as SecureString. Use either "Read-Host -AsSecureString" or "ConvertTo-SecureString"

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

-PasswordAge

Specifies password age in days. PasswordAge takes presedence over PasswordSinceDate.

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

-PasswordSinceDate

Specifies date/time (UTC) at which the password was first created. PasswordAge takes presedence over PasswordSinceDate.

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

-Refresh

Send refresh notification to Remote Desktop Manager application.

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

-Set

Save the session in the current workspace.

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

-VaultMode

Vault where the command will be applied. Three choices are offered:

• Default: Current vault that has been set.
• User: Vault specific to the current user.
• Global: Global vault of the workspace.

Type: Devolutions.RemoteDesktopManager.VaultMode
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 runs. The cmdlet is 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.PSConnection

Entry whose password will be modified. Can be obtained from Get-RDMEntry, New-RDMEntry, Get-RDMPersonalCredentials, or Get-RDMPrivilegedAccount.

Notes

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