Set-RDMEntryOTP
Synopsis
Set OTP properties of an entry
Syntax
Id
Set-RDMEntryOTP [-ID] <guid> [-Key] <PSPassword> [-Account <string>] [-Application <string>]
[-CodeSize <OTPCodeSize>] [-PasswordListItemID <guid>] [-TimeStep <int>]
[-HashAlgorithm <OTPHashAlgorithm>] [-PassThru] [-Refresh] [-Set] [-VaultMode <VaultMode>]
[-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]InputObject
Set-RDMEntryOTP [-InputObject] <PSConnection> [-Key] <PSPassword> [-Account <string>]
[-Application <string>] [-CodeSize <OTPCodeSize>] [-PasswordListItemID <guid>] [-TimeStep <int>]
[-HashAlgorithm <OTPHashAlgorithm>] [-PassThru] [-Refresh] [-Set]
[-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Set OTP properties of an entry. The entry to modify can be obtained from Get-RDMEntry or New-RDMEntry. To modify the OTP Entry, the user must have the appropriate rights: add for a new entry, and edit for an existing one.
Examples
Example 1
Update the OTP key and change the refresh rate of the code to 60 seconds. The changes are saved.
Example 2
Update the OTP key and change the refresh rate of the code to 60 seconds of a password in a password list. The changes are saved.
Parameters
-Account
OTP's associated account name
-Application
QR Code's application name
-CodeSize
OTP code's size. Must be 6 or 8 digits.
-Confirm
Prompts you for confirmation before running the cmdlet.
-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.
-HashAlgorithm
Algorithm used to hash the code.
-ID
ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global vault.
-InputObject
Credential entry whose OTP value must be updated.
-Key
Key used to generate the OTP code.
-PassThru
Return the modified entry.
-PasswordListItemID
For password list, the item's ID to be resolved.
-Refresh
Send refresh notification to Remote Desktop Manager application. Use Set switch to persist the modification.
-Set
Save the entry in the current workspace.
-TimeStep
Refresh rate, in seconds, of the OTP.
-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.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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
PSConnection object of the OTP entry obtained from Get-RDMEntry
Notes
For more information, type "Get-Help Set-RDMEntryOTP -detailed". For technical information, type "Get-Help Set-RDMEntryOTP -full".
Last updated
Was this helpful?