Set-RDMDatasourceMasterKey

2025-01-21

Set-RDMDatasourceMasterKey

SYNOPSIS

Modify or clear your data source master key

SYNTAX

NewMasterKey

Set-RDMDatasourceMasterKey [-DataSource] <PSDataSource> [-NewMasterKey] <securestring>
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

NoMasterKey

Set-RDMDatasourceMasterKey [-DataSource] <PSDataSource> -NoMasterKey
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

EXAMPLES

EXAMPLE

PS C:> $dataSource = Get-RDMDataSource -Name MyDataSource; Set-RDMDatasourceMasterKey -DataSource $dataSource -NewMaster (ConvertTo-SecureString -AsPlainText "MyMasterKey" -Force)

Modify the master key of the data source named MyDataSource to MyMasterKey

PARAMETERS

-DataSource

Specifies the data source to change the master key

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSDataSource
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  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 not an option No.
• Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.

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

-NewMasterKey

New data source master key.

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

-NoMasterKey

Set no master key.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: NoMasterKey
  Position: Named
  IsRequired: true
  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.PSDataSource

OUTPUTS

NOTES

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

RELATED LINKS