Get HPOVLogicalSwitchGroup - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVLogicalSwitchGroup

Retrieve Logical Switch Group resources.

SYNTAX

Get-HPOVLogicalSwitchGroup[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object>][ [-exportFile] <SwitchParameter>] [<CommonParameters>]
Get-HPOVLogicalSwitchGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

The logical switch group is a template for creating logical switches. Logical switches are an aggregation of up to two physical top-of-rack switches. Once constructed from a logical switch group, a logical switch continues to be associated with its logical switch group. Any change in consistency between the logical switch group and its associated logical switches is monitored and made visible on the associated logical switch screen in HPE OneView. This Cmdlet will retrieve the specified or all Logical Switch Group resources.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-InputObject <Object>

The Async task object after a Logical Switch Group resource is created, the Cmdlet will return the associated object.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-Label <String>

Specify the label associated with resources.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-Name <String>

The Logical Switch Group resource Name. Supports the * wildcard character.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Scope <Object>

Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values:

* AllResources
* AllResourcesInScope
* HPOneView.Appliance.ScopeCollection
* HPOneView.Appliance.ConnectionPermission
Aliases None
Required? False
Position? named
Default value AllResourcesInScope
Accept pipeline input? false
Accept wildcard characters?    False

-exportFile <SwitchParameter>

Export the Logical Switch Group resource(s) to the specified JSON file.

Aliases x, export
Required? false
Position? named
Default value
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Async task resource after a Logical Switch Group has been created.

Return Values

HPOneView.Networking.LogicalSwitchGroup [System.Management.Automation.PSCustomObject]

The async task resource object to monitor (if -Async was used) or results.

System.Collections.ArrayList <HPOneView.Networking.LogicalSwitchGroup>

Collection of Logical Switch Group resources.

Examples

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

Get-HPOVLogicalSwitchGroup

Get all logical switch group resources found on the default appliance connection.

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

Get-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1"

Get the "My Logical Switch Group Policy 1" resource.

Related Links


Top

HPE OneView 4.00 Library

Get-HPOVLogicalSwitchGroup

Retrieve Logical Switch Group resources.

SYNTAX

Get-HPOVLogicalSwitchGroup[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object>][ [-exportFile] <SwitchParameter>] [<CommonParameters>]
Get-HPOVLogicalSwitchGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

The logical switch group is a template for creating logical switches. Logical switches are an aggregation of up to two physical top-of-rack switches. Once constructed from a logical switch group, a logical switch continues to be associated with its logical switch group. Any change in consistency between the logical switch group and its associated logical switches is monitored and made visible on the associated logical switch screen in HPE OneView. This Cmdlet will retrieve the specified or all Logical Switch Group resources.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-InputObject <Object>

The Async task object after a Logical Switch Group resource is created, the Cmdlet will return the associated object.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-Label <String>

Specify the label associated with resources.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-Name <String>

The Logical Switch Group resource Name. Supports the * wildcard character.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Scope <Object>

Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values:

* AllResources
* AllResourcesInScope
* HPOneView.Appliance.ScopeCollection
* HPOneView.Appliance.ConnectionPermission
Aliases None
Required? False
Position? named
Default value AllResourcesInScope
Accept pipeline input? false
Accept wildcard characters?    False

-exportFile <SwitchParameter>

Export the Logical Switch Group resource(s) to the specified JSON file.

Aliases x, export
Required? false
Position? named
Default value
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Async task resource after a Logical Switch Group has been created.

Return Values

HPOneView.Networking.LogicalSwitchGroup [System.Management.Automation.PSCustomObject]

The async task resource object to monitor (if -Async was used) or results.

System.Collections.ArrayList <HPOneView.Networking.LogicalSwitchGroup>

Collection of Logical Switch Group resources.

Examples

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

Get-HPOVLogicalSwitchGroup

Get all logical switch group resources found on the default appliance connection.

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

Get-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1"

Get the "My Logical Switch Group Policy 1" resource.

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️