Get HPOVInterconnect - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVInterconnect

Retrieve Interconnect resource(s).

SYNTAX

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

Detailed Description

Retrieves a list of all Interconnects (Ethernet, FC, Converged Network, and/or SAS) or just specific ones via a query if the name parameter is provided. The output can be sent to a file using the Export 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? false
Position? 3
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-Export <String>

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

Aliases x, exportFile
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Label <String>

Specify the label associated with resources.

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

-Name <String>

The name of the interconnect to retrieve.

Aliases None
Required? false
Position? 0
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? 1
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

None. You cannot pipe objects to this cmdlet.

Return Values

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

Single Interconnect object.

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

Single SAS Interconnect object.

System.Collections.ArrayList

Multiple Interconnect objects.

An Interconnect or collection of Interconnects

Examples

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

Get-HPOVInterconnect

Returns all Interconnects managed by all connected appliances to standard output.

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

Get-HPOVInterconnect "Encl1, Interconnect 1"

Returns just the Encl1, Interconnect 1 Interconnect object to standard output.

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

$myICs = Get-HPOVInterconnect

Returns the Get-HPOVInterconnect query and stores it in the object $myICs

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

Get-HPOVInterconnect -exportFile "c:\myApplianceConfig\ICs.json"

Returns the Get-HPOVInterconnect query results to the file c:\myApplianceConfig\ICs.json

Related Links


Top

HPE OneView 4.00 Library

Get-HPOVInterconnect

Retrieve Interconnect resource(s).

SYNTAX

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

Detailed Description

Retrieves a list of all Interconnects (Ethernet, FC, Converged Network, and/or SAS) or just specific ones via a query if the name parameter is provided. The output can be sent to a file using the Export 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? false
Position? 3
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-Export <String>

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

Aliases x, exportFile
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Label <String>

Specify the label associated with resources.

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

-Name <String>

The name of the interconnect to retrieve.

Aliases None
Required? false
Position? 0
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? 1
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

None. You cannot pipe objects to this cmdlet.

Return Values

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

Single Interconnect object.

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

Single SAS Interconnect object.

System.Collections.ArrayList

Multiple Interconnect objects.

An Interconnect or collection of Interconnects

Examples

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

Get-HPOVInterconnect

Returns all Interconnects managed by all connected appliances to standard output.

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

Get-HPOVInterconnect "Encl1, Interconnect 1"

Returns just the Encl1, Interconnect 1 Interconnect object to standard output.

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

$myICs = Get-HPOVInterconnect

Returns the Get-HPOVInterconnect query and stores it in the object $myICs

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

Get-HPOVInterconnect -exportFile "c:\myApplianceConfig\ICs.json"

Returns the Get-HPOVInterconnect query results to the file c:\myApplianceConfig\ICs.json

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️