Get-Tag Command | Vmware PowerCLI Reference

Get-Tag

This cmdlet retrieves the tags available on a vCenter Server system. This cmdlet filters tags by name and category to which tags belong.

Syntax

Get-Tag
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id String[] named
Filters the tags by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
Get-Tag
[-Category < TagCategory[] > ]
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Category TagCategory[] named
  • pipeline
  • wildcards
Filters the tags by category.
optional Name String[] named
  • wildcards
Filters the tags by name.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

Output

VMware.VimAutomation.ViCore.Types.V1.Tagging.Tag

Examples

Example 1

Get-Tag -Name "MyTag"

Returns all tags named "MyTag".

Example 2

Get-Tag -Category "MyCategory1", "MyCategory2" -Name "MyTag"

Returns all tags from the "MyCategory1" and "MyCategory2" categories, named "MyTag".

Related Commands

Tag

This cmdlet retrieves the tags available on a vCenter Server system.

This cmdlet creates a new tag in the specified tag category with the specified parameters.

This cmdlet removes the specified tags from the server.

This cmdlet modifies the specified tags.

TagAssignment

This cmdlet retrieves the tag assignments of objects.

This cmdlet assigns the specified tag(s) to the specified entity(s).

This cmdlet removes the specified tag assignment.

TagCategory

This cmdlet retrieves the tag categories available on a vCenter Server system and filters them using the specified cmdlet parameters.

This cmdlet creates a new tag category on the specified vCenter Server systems with the specified parameters.

This cmdlet removes the specified tag categories from the server.

This cmdlet modifies the specified tag categories.