Skip to content

Get HPOVSwitch

Chris Lynch edited this page Dec 10, 2020 · 23 revisions

HPE OneView 4.10 Library

Get-HPOVSwitch

Get a Switch resource.

SYNTAX

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

Detailed Description

Retrieve a Switch that is managed by HPE OneView. Currently, HPE OneView can Manage or Monitor Cisco Nexus-family of switches. 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

-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 Switch 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

<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-HPOVSwitch

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

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

Get-HPOVSwitch -Name "10.1.1.1"

Get the "10.1.1.1" switch resource.

Related Links


HPE OneView 4.00 Library

Get-HPOVSwitch

Get a Switch resource.

SYNTAX

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

Detailed Description

Retrieve a Switch that is managed by HPE OneView. Currently, HPE OneView can Manage or Monitor Cisco Nexus-family of switches. 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

-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 Switch 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

<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-HPOVSwitch

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

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

Get-HPOVSwitch -Name "10.1.1.1"

Get the "10.1.1.1" switch resource.

Related Links


Wiki Table of Contents

Clone this wiki locally