Get HPOVApplianceNetworkConfig

ℹ️ Note: This Wiki is no longer the source for HPE OneView PowerShell Library documentation. The new location is here.

Please update your local offline help system using Get-Help <ModuleName> to dwonload the latest offline help contents.

Library Version 5.00

Library Version 4.20

Library Version 4.10

HPE OneView

Library

5.00

Get-HPOVApplianceNetworkConfig

Syntax

Get-HPOVApplianceNetworkConfig [[-Location] <String>] [[-ApplianceConnection] <Object>] [<CommonParameters>]

Description

This Cmdlet will return the appliance network settings configuration parameters of the primary network interface on the appliance, which can be captured into a customer object for further operation, or captured to a text file in JSON format.

NOTE: Any time the IP address or hostname of the appliance changes, any CA-signed appliance certificate associated with the appliance is erased, and a new self signed appliance certificate is generated. In this case, you must generate a new Certificate Signing Request (CSR), have it signed by a CA, and import it into the appliance.

Minimum required privileges: Read-only

Parameters

-ApplianceConnection <Object>

Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).

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

-Location <String>

Directory to where the appliance network configuration will be exported to. Exported file name will be "{$ApplianceConnection.Name}_ApplianceNetConf.json".

Aliases	x, export, exportFile
Required?	False
Position?	0
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

HPOneView.Appliance.ApplianceServerConfiguration [System.Management.Automation.PSCustomObject]

A collection object containing the properties and values of the primary network interface of the appliance.

HPOneView.Appliance.ApplianceServerConfiguration.ApplianceNetworks [System.Management.Automation.PSCustomObject]

The applianceNetworks property will display the appliance Networking in either a Format-Table (default) or Format-List view.

System.IO.FileSystemInfo

If exporting the appliance network configuration, the file object created will be returned.

Examples

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

Get-HPOVApplianceNetworkConfig Hostname IPv4Type IPv4Address IPv4DNS IPv6Type IPv6Address IPv6DNS -------- -------- ----------- ------- -------- ----------- ------- hpov1.domain.com STATIC 172.20.51.4\24 {172.20.10.41, 172.20.10.42} UNCONFIGURE {} hpov2.domain.com STATIC 172.20.52.4\24 {172.20.10.41, 172.20.10.42} UNCONFIGURE {}

Outputs the configuration of the primary network interface to standard output.

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

Get-HPOVApplianceNetworkConfig -Appliance hpov1.domain.com | fl Hostname : hpov1.domain.com IPv4Type : STATIC IPv4Address : 172.20.51.4 IPv4Mask : 255.255.255.0 IPv4Gateway : 172.20.51.1 IPv4DNS : {172.20.10.41, 172.20.10.42} IPv6Type : UNCONFIGURE IPv6Address : IPv6Mask : IPv6Gateway : IPv6DNS : {}

Outputs the configuration of the primary network interface and pipe to Format-List for more information about the network configuration.

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

$myAppNetConfig = Get-HPOVApplianceNetworkConfig -Appliance hpov1.domain.com

Outputs the configuration of the primary network interface of the appliance to the object variable $myAppNetConfig

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

Get-HPOVApplianceNetworkConfig -Location .

Outputs the configuration of the primary network interface of the appliance to the current directory.

HPE OneView

Library

4.20

Get-HPOVApplianceNetworkConfig

Syntax

Get-HPOVApplianceNetworkConfig [[-Location] <String>] [[-ApplianceConnection] <Object>] [<CommonParameters>]

Description

Retrieves the configuration parameters of the primary network interface on the appliance, which can be captured into a customer object for further operation, or captured to a text file in json format.

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

-Location <String>

Aliases [-ExportFile] Directory to where the applinace network configuration will be exported to. Exported file name will be "{$ApplianceConnection.Name}_ApplianceNetConf.json".

Aliases	x, export, exportFile
Required?	false
Position?	0
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.