Get HPOVUplinkSet - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVUplinkSet

Retreive Uplink Set resource(s).

SYNTAX

Get-HPOVUplinkSet [-Name] <String> [-LogicalInterconnect] <Object>[ [-Report] <SwitchParameter>] [-ApplianceConnection] <Object> [-ExportFile] <String> [<CommonParameters>]

Get-HPOVUplinkSet [-LogicalInterconnect] <Object> [-Type] <String>[ [-Report] <SwitchParameter>] [-ApplianceConnection] <Object> [-ExportFile] <String> [<CommonParameters>]

Detailed Description

This cmdlet will retrieve the list of all Uplink Sets or specific by the name. The cmdlet will only display provisioned Uplink Sets that are members of a Logical Interconnect resource. To view Uplink Sets of a Logical Interconnect Group, use the Get-HPOVLogicalInterconnectGroup CMDLET.

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?	true
Position?	named
Default value	(${Global:ConnectedSessions} \| ? Default)
Accept pipeline input?	false
Accept wildcard characters?	False

-ExportFile <String>

Export the found Uplink Set resource objects to JSON files in the specified directory.

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

-LogicalInterconnect <Object>

Aliases [-LiName] Name of the Logical Interconnect to show associated Uplink Set.

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

-Name <String>

Name of Uplink Set

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

-Report <SwitchParameter>

Generate a report of the defined Uplink Sets. Includes Uplink Set type, networks, redundancy report, and assigned uplink ports.

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

-Type <String>

Specify the Uplink Set Type to display. Will display all Uplink Sets of the type provided. Allowed values:

* Ethernet
* FibreChannel

Aliases	None
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

None. You cannot pipe objects to this cmdlet.

Return Values

System.Management.Automation.PSCustomObject

Single Uplink Set

System.Collections.ArrayList

Multiple Uplink Sets

Collection of Uplink Sets

Examples

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

$UplinkSets = Get-HPOVUplinkSet

Get list of all Uplink Sets.

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

Get-HPOVUplinkSet -name "Production Networks"

Get the "Production Networks" Uplink Set(s).

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

Get-HPOVUplinkSet -name "Production Networks" -report

Get the "Production Networks" Uplink Set(s), and generate a report.

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

Get-HPOVUplinkSet -name "Production Networks" -liname "Encl1-LI" -report

Get the "Production Networks" Uplink Set that is associated with "Encl1-LI" Logical Interconnect and generate a report.

HPE OneView 4.00 Library