< Back
Get-NsxServiceGroup
Post
NAME Get-NsxServiceGroup
SYNOPSIS
Retrieves a list of NSX Service Groups.
SYNTAX
Get-NsxServiceGroup [-scopeId <String[]>] [-Connection <PSObject>] [<CommonParameters>]
Get-NsxServiceGroup -objectId <String> [-scopeId <String[]>] [-Connection <PSObject>] [<CommonParameters>]
Get-NsxServiceGroup [[-Name] <String>] [-scopeId <String[]>] -LocalOnly [-Connection <PSObject>]
[<CommonParameters>]
Get-NsxServiceGroup [[-Name] <String>] [-scopeId <String[]>] -UniversalOnly [-Connection <PSObject>]
[<CommonParameters>]
Get-NsxServiceGroup [-Name] <String> [-scopeId <String[]>] [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
Lists all created NSX Service Groups. Service groups contain a mixture of
selected ports to represent a potential grouping of like ports.
This cmdlet retrieves the service group of the specified configuration.
PARAMETERS
-objectId <String>
Objectid of Service Group
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Name of the Service Group
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-scopeId <String[]>
ScopeId of Service Group. Can define multiple scopeIds in a list to iterate accross scopes.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UniversalOnly [<SwitchParameter>]
Return only Universal objects
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LocalOnly [<SwitchParameter>]
Return only Locally scoped objects
Required? true
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-NsxServiceGroup
Retrieves all NSX Service Groups
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxServiceGroup Heartbeat
Retrieves the default NSX Service Group called Heartbeat
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-NsxServiceGroup | where-object {$_.name -match ("Exchange")} | select-object name
Retrieves all Services Groups that have the string "Exchange" in their
name property
e.g:
----
Microsoft Exchange 2003
MS Exchange 2007 Transport Servers
MS Exchange 2007 Unified Messaging Centre
MS Exchange 2007 Client Access Server
Microsoft Exchange 2007
MS Exchange 2007 Mailbox Servers
Microsoft Exchange 2010
MS Exchange 2010 Client Access Servers
MS Exchange 2010 Transport Servers
MS Exchange 2010 Mailbox Servers
MS Exchange 2010 Unified Messaging Server
RELATED LINKS
SYNOPSIS
Retrieves a list of NSX Service Groups.
SYNTAX
Get-NsxServiceGroup [-scopeId <String[]>] [-Connection <PSObject>] [<CommonParameters>]
Get-NsxServiceGroup -objectId <String> [-scopeId <String[]>] [-Connection <PSObject>] [<CommonParameters>]
Get-NsxServiceGroup [[-Name] <String>] [-scopeId <String[]>] -LocalOnly [-Connection <PSObject>]
[<CommonParameters>]
Get-NsxServiceGroup [[-Name] <String>] [-scopeId <String[]>] -UniversalOnly [-Connection <PSObject>]
[<CommonParameters>]
Get-NsxServiceGroup [-Name] <String> [-scopeId <String[]>] [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
Lists all created NSX Service Groups. Service groups contain a mixture of
selected ports to represent a potential grouping of like ports.
This cmdlet retrieves the service group of the specified configuration.
PARAMETERS
-objectId <String>
Objectid of Service Group
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Name of the Service Group
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-scopeId <String[]>
ScopeId of Service Group. Can define multiple scopeIds in a list to iterate accross scopes.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UniversalOnly [<SwitchParameter>]
Return only Universal objects
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LocalOnly [<SwitchParameter>]
Return only Locally scoped objects
Required? true
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-NsxServiceGroup
Retrieves all NSX Service Groups
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxServiceGroup Heartbeat
Retrieves the default NSX Service Group called Heartbeat
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-NsxServiceGroup | where-object {$_.name -match ("Exchange")} | select-object name
Retrieves all Services Groups that have the string "Exchange" in their
name property
e.g:
----
Microsoft Exchange 2003
MS Exchange 2007 Transport Servers
MS Exchange 2007 Unified Messaging Centre
MS Exchange 2007 Client Access Server
Microsoft Exchange 2007
MS Exchange 2007 Mailbox Servers
Microsoft Exchange 2010
MS Exchange 2010 Client Access Servers
MS Exchange 2010 Transport Servers
MS Exchange 2010 Mailbox Servers
MS Exchange 2010 Unified Messaging Server
RELATED LINKS