Get HPOVLogicalSwitch - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVLogicalSwitch

Retrieve Logical Switch resources.

SYNTAX

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

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

Detailed Description

This cmdlet will retrieve one or more Logical Switch resources configured on the appliance.

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>

Provide an HPOneView.Appliance.TaskResource object and the Cmdlet will return the associated Logical Switch resource created from the New-HPOVLogicalSwitch Cmdlet..

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>

Name of the Logical Switch resource. Supports 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 <String>

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

Aliases	x, export
Required?	false
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]

Async Task resource object, from New-HPOVLogicalSwitch.

Return Values

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

Single Logical Switch resource.

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

Collection of Logical Switch resources.

Examples

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

Get-HPOVLogicalSwitch

Retrieve all Logical Switch resources from the default appliance connection.

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

Get-HPOVLogicalSwitch -Name MyLogicalSwitch1

Retrieve the specified MyLogicalSwitch1 resource from the default appliance connection.

HPE OneView 4.00 Library