Get HPOVLogicalInterconnect - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVLogicalInterconnect

Retrieve Logical Interconnect resource(s).

SYNTAX

Get-HPOVLogicalInterconnect [-Name] <String>[ [-NonCompliant] <SwitchParameter>][ [-Scope] <Object>][ [-Label] <String>] [-ApplianceConnection] <Object> [-Export] <String> [<CommonParameters>]

Detailed Description

Retrieves a list of all Logical Interconnect 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).

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

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

-Export <String>

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

Aliases	x, ExportFile
Required?	true
Position?	named
Default value
Accept pipeline input?	false
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 to retrieve.

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

-NonCompliant <SwitchParameter>

Filter resources based on their non-compliant state.

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

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

None. You cannot pipe objects to this cmdlet.

Return Values

HPoneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]

Logical Interconnect resource object from Get-HPOVLogicalInterconnect

System.Collections.ArrayList <HPoneView.Networking.LogicalInterconnect>

Multiple Logical Interconnects

A Logical Interconnect or collection of Logical Interconnects

Examples

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

Get-HPOVLogicalInterconnect

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

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

Get-HPOVLogicalInterconnect "Production"

Returns just the Production Logical Interconnect object to standard output.

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

$myLogicalICs = Get-HPOVLogicalInterconnect

Returns the Get-HPOVLogicalInterconnect query and stores it in the object $myLogicalICs

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

Get-HPOVLogicalInterconnect -Export "c:\myApplianceConfig\LogicaICs.json"

Returns the Get-HPOVLogicalInterconnect query results to the file c:\myApplianceConfig\LogicaICs.json

HPE OneView 4.00 Library