Edit-RDMUserTemplate

    2024-11-18

    Edit-RDMUserTemplate

    SYNOPSIS

    Add or default vaults in the User Template of the System Settings for a specific data source. New users created in that data source will gain or lose access to those vaults.

    SYNTAX

    AddRepository

    Edit-RDMUserTemplate [-DataSource] <Object> [-AddRepository] <Object[]> [-CaseSensitive]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

    RemoveRepository

    Edit-RDMUserTemplate [-DataSource] <Object> [-RemoveRepository] <Object[]> [-CaseSensitive]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Add or default vaults in the User Template of the System Settings for a specific data source. New users created in that data source will gain or lose access to those vaults.

    EXAMPLES

    EXAMPLE 1

    PS C:> Edit-RDMUserTemplate -DataSource ADataSource -AddRepository ACommonVault;

    Add ACommonVault in the User Template in the System Settings of the data source "ADataSource".

    EXAMPLE 2

    PS C:> Edit-RDMUserTemplate -DataSource ADataSource -RemoveRepository *;

    Remove all the repositories in the User Template in the System Settings of the data source ADataSource.

    EXAMPLE 3

    PS C:> Get-RDMDataSource -Name "ADataSource" | Edit-RDMUserTemplate -RemoveRepository CommonVault[ab] -CaseSensitive;

    Remove the repositories CommonVaulta and CommonVaultb in the User Template in the System Settings of the data source "ADataSource". The case sensitive switch is not impacting the term [ab], meaning a repository CommonVaultA would not be affected.

    EXAMPLE 4

    PS C:> Edit-RDMUserTemplate -DataSource ADataSource -Repository UserVault? -CaseSensitive;

    Add all repositories UserVault? such as UserVaultA and UserVault1 in the User Template in the System Settings of the data source "ADataSource". The search for the data source and the repositories wll be case sensitive.

    PARAMETERS

    -AddRepository

    Add the default vaults in the User Template of the System Settings. Allows to find repositories by ID (Guid), by name (supports wildcards), and repositories (PSRepositoryInfo).

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

    -CaseSensitive

    Case sensitive when searching the data source or the repositories by name

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

    -Confirm

    Prompts you for confirmation before running the cmdlet.

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

    -DataSource

    DataSource whose settings will be modified. Allows to find the data source by ID (Guid), by name (supports wildcard), and data source (PSDataSource).

    Type: System.Object
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: ''

    -RemoveRepository

    Remove the default vaults in the User Template of the System Settings. Allows to find repositories by ID (Guid), by name (supports wildcards), and repositories (PSRepositoryInfo). Removing all default vaults is possible.

    Type: System.Object[]
DefaultValue: ''
SupportsWildcards: true
ParameterValue: []
Aliases:
- RemoveVault
ParameterSets:
- Name: RemoveRepository
  Position: 2
  IsRequired: true
  ValueFromPipeline: true
  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
ParameterValue: []
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

    System.Object

    OUTPUTS

    NOTES

    For more information, type "Get-Help Edit-RDMUserTemplate -detailed". For technical information, type "Get-Help Edit-RDMUserTemplate -full".