< Back

Get-NsxSecurityTag

Sat Jan 18, 2020 9:12 pm

NAME Get-NsxSecurityTag



SYNOPSIS

Retrieves an NSX Security Tag





SYNTAX

Get-NsxSecurityTag [[-Name] <String>] [-objectId <String>] [-IncludeSystem] [-Connection <PSObject>]

[<CommonParameters>]





DESCRIPTION

A NSX Security Tag is a arbitrary string. It is used in other functions of

NSX such as Security Groups match criteria. Security Tags are applied to a

Virtual Machine.



This cmdlet retrieves existing NSX Security Tags





PARAMETERS

-Name <String>

Get Security Tag by name



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-objectId <String>

Get security tag by objectId



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IncludeSystem [<SwitchParameter>]

Include system security tags



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Connection <PSObject>

PowerNSX Connection object



Required? false

Position? named

Default value $defaultNSXConnection

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-NSXSecurityTag



Gets all Security Tags









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-NSXSecurityTag -name ST-Web-DMZ



Gets a specific Security Tag by name











RELATED LINKS