Set-RDMSystemSettingsTags

Synopsis

Set the system settings tag list.

Syntax

__AllParameterSets

Set-RDMSystemSettingsTags [-Tags] <string[]> [-ForcePromptAnswer <DialogResult[]>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

Set the system tag list for the data source. This replaces all existing system tags. System tags help organize and find related entries, improving search, filters, and dashboard overviews. System tags can be assigned to entries across all vaults.

Tags containing spaces are automatically quoted. Duplicate tags (case-insensitive) are removed. Tag names cannot contain the " character. Whitespace is trimmed from tag names.

Requires data source settings permission.

Examples

Example 1

PS C:\> $tags = @("Production", "Development", "Test")
PS C:\> Set-RDMSystemSettingsTags -Tags $tags

Set the system tag list with three tags.

Example 2

PS C:\> $tags = @(Get-RDMSystemSettingsTags)
PS C:\> $tags += "NewTag"
PS C:\> Set-RDMSystemSettingsTags -Tags $tags

Get current system tags, add a new one, and save the updated list. Using @() ensures $tags is always an array for array operations like +=.

Example 3

PS C:\> Set-RDMSystemSettingsTags -Tags @()

Clear all system tags.

Example 4

PS C:\> Get-RDMSystemSettingsTags | Where-Object { $_ -match "^Prod" } | Set-RDMSystemSettingsTags

Pipeline usage to filter and set system tags. Get all tags, keep only those starting with 'Prod', and save the filtered list.

Example 5

PS C:\> Set-RDMSystemSettingsTags -Tags @("Tag with spaces", "SimpleTag") -WhatIf

Preview changes without applying them. Shows how tags with spaces are handled.

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

-Tags

Array of system tags to set. Pass an empty array to clear all tags.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  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
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.String

Tag name to add to the system tag list.

System.String[]

Notes

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

Devolutions Forum logo Share your feedback