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

[-Category  <TagCategory[]>]
[-Name  <String[]>]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Category
TagCategory[] named
  • wildcards
  • pipeline
  • Filters the tags by category.
    optional
    Name
    String[] named
  • wildcards
  • Filters the tags by name.
    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.

    -Id  <String[]>
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named Filters the tags by ID.
    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

    Feedback

    Was this page helpful?