Get HPOVLogicalInterconnectGroup - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVLogicalInterconnectGroup

Retrieve Logical Interconnect Group resource(s).

SYNTAX

Get-HPOVLogicalInterconnectGroup[ [-Name] <String>] [-Type] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object>] [-exportFile] <String> [<CommonParameters>]

Get-HPOVLogicalInterconnectGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

Retrieves a list of all Logical Interconnect Groups or just specific ones via a query if the name parameter is provided. The output can be sent to a file using the exportFile parameter.

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>

Pipeline input resource generated from Wait-HPOVTaskComplete, or successfully completed Async Task resource object.

Aliases	Resource
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 name of the Logical Interconnect Group to retrieve.

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

-Type <String>

Provide the type of Logical Interconnect Group to return. Omit to return all Logical Interconnect Group resources.

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

-exportFile <String>

Aliases [-x, -export] The full path and file name to export the contents retrieved from the call to Get-HPOVLogicalInterconnectGroup.

Aliases	x, export
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

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]

Successfully Completed Async task resource from Wait-HPOVTaskComplete or other supported method

Return Values

System.Collections.ArrayList

A Logical Interconnect Group or collection of Logical Interconnect Groups

Examples

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

Get-HPOVLogicalInterconnectGroup

Returns all Logical Interconnect Groups defined on the appliance to standard output.

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

Get-HPOVLogicalInterconnectGroup -Name "Production"

Returns just the Production Logical Interconnect Group object to standard output.

-------------------------- EXAMPLE 3 --------------------------

$myLigs = Get-HPOVLogicalInterconnectGroup

Returns the Get-HPOVLogicalInterconnectGroup query and stores it in the object $myLigs

-------------------------- EXAMPLE 4 --------------------------

$LigName = "VC FF Virt Prod" $CreatedLig = New-HPOVLogicalInterconnectGroup -Name $LigName -bays @{1 = "FlexFabric";2 = "FlexFabric"} -EnableIgmpSnooping $True -InternalNetworks "VMMigration Network" | Wait-HPOVTaskComplete | Get-HPOVLogicalInterconnectGroup $CreatedLig Name Enclosure Groups ---- ---------------- VC FF Virt Prod

Create a new Logical Interconnect Group resource, wait for the task to complete, then retrieve the created resource.

-------------------------- EXAMPLE 5 --------------------------

Get-HPOVLogicalInterconnectGroup -exportFile "c:\myApplianceConfig\LogicaICGs.json"

Returns the Get-HPOVLogicalInterconnectGroup query results to the file c:\myApplianceConfig\LogicaICGs.json

HPE OneView 4.00 Library