Skip to content

Set HPOVApplianceNetworkConfig

Jump to bottom
Chris Lynch edited this page Aug 13, 2016 · 44 revisions

Library Version 2.00

Library Version 1.20

HPE OneView 2.00 Library

Set-HPOVApplianceNetworkConfig

Update Appliance Date/Time Configuration.

SYNTAX

Set-HPOVApplianceNetworkConfig [-Hostname] <String> [-IPv4Type] <String> [-IPv4Addr] <String> [-IPv4Subnet] <String> [-IPv4Gateway] <String> [-IPv6Type] <String> [-IPv6Addr] <String> [-IPv6Subnet] <String> [-IPv6Gateway] <String> [-DomainName] <String> [-SearchDomains] <Array> [-IPv4nameServers] <Array> [-IPv6nameServers] <Array> [-NtpServers] <Array>[ [-ApplianceConnection] <Object>][ [-OverrideIPv4DhcpDns] <SwitchParameter>][ [-OverrideIPv6DhcpDns] <SwitchParameter>] [<CommonParameters>]
Set-HPOVApplianceNetworkConfig [-Device] <String> [-InterfaceName] <String> [-Hostname] <String> [-IPv4Type] <String> [-IPv4Addr] <String> [-IPv4Subnet] <String> [-IPv4Gateway] <String> [-IPv6Type] <String> [-IPv6Addr] <String> [-IPv6Subnet] <String> [-IPv6Gateway] <String> [-DomainName] <String> [-SearchDomains] <Array> [-IPv4nameServers] <Array> [-IPv6nameServers] <Array> [-NtpServers] <Array>[ [-ApplianceConnection] <Object>][ [-OverrideIPv4DhcpDns] <SwitchParameter>][ [-OverrideIPv6DhcpDns] <SwitchParameter>] [<CommonParameters>]
Set-HPOVApplianceNetworkConfig [-importFile] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

Updates any or all configuration parameters for the primary network interface on the appliance. All parameters are Current settings will be retained for any parameters NOT specified.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value.

Default Value: ${Global:ConnectSessions} | ? Default

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

-Device <String>

Name of the Ethernet device to be configured. Not applicable when configuring the primary Appliance network interface. Ex. eth1, eth2

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

-DomainName <String>

DNS domain name for the appliance: "my.com"

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

-Hostname <String>

Fully-qualified hostname for the appliance

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

-IPv4Addr <String>

"www.xxx.yyy.zzz" (leave blank for DHCP)

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

-IPv4Gateway <String>

"www.xxx.yyy.zzz" (leave blank for DHCP)

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

-IPv4Subnet <String>

"www.xxx.yyy.zzz" (leave blank for DHCP)

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

-IPv4Type <String>

"DHCP", "STATIC" or "UNCONFIGURE"

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

-IPv4nameServers <Array>

Aliases [-nameServers] Array of DNS servers: "www.xxx.yyy.zzz", "sss.ttt.uuu.vvv"

Aliases nameServers
Required? true
Position? 13
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-IPv6Addr <String>

"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)

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

-IPv6Gateway <String>

"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)

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

-IPv6Subnet <String>

"ffff:ffff:ffff:ffff:0:0:0:0" (leave blank for DHCP)

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

-IPv6Type <String>

"DHCP", "STATIC" or "UNCONFIGURE"

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

-IPv6nameServers <Array>

Array of DNS servers: "fe80::200:f8ff:fe21:67cf", "fe80::200:f8ff:fe21:89cb"

Aliases None
Required? true
Position? 14
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-InterfaceName <String>

Name that describes the usage of the interface. Valid values are Management or Deployment. Not applicable when configuring the primary Appliance network interface.

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

-NtpServers <Array>

This parameter is deprecated. Please use the Set-HPOVApplianceDateTime Cmdlet.

Aliases None
Required? true
Position? 15
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-OverrideIPv4DhcpDns <SwitchParameter>

Aliases [-overrideDhcpDns] Switch to override DHCP provided DNS Servers

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

-OverrideIPv6DhcpDns <SwitchParameter>

Switch to override DHCPv6 provided DNS Servers

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

-SearchDomains <Array>

Array of DNS search domains: "my.com", "other.com"

Aliases None
Required? true
Position? 12
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-importFile <Object>

Aliases [-i, -import] File containing JSON formatted input values for the appliance network configuration parameters.

Aliases i, import
Required? true
Position? named
Default value
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

System.Management.Automation.PSCustomObject Final Task status (for asynchronous appliance config).

Examples

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

PS C:\> Set-HPOVApplianceNetworkConfig -hostname "appliance1.my.com" -ipv4Type "DHCP" -ipv6Type "UNCONFIGURE" -domainName "my.com"

This example passes in updated values to set for the appliance networking configuration.

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

PS C:\> Set-HPOVApplianceNetworkConfig -importFile "c:\myNetworkInput.json" -ApplianceConnection $Connection1

This example passes the name of an input file containing JSON formatted properties and values for the appliance network configuration.

Related Links

HPE OneView 1.20 Library

Set-HPOVApplianceNetworkConfig

Updates the configuration parameters for the primary network interface on the appliance.

SYNTAX

Set-HPOVApplianceNetworkConfig[ [-hostname] <hostname>][ [-ipv4Type] <ipv4Type>][ [-ipv4Addr] <ipv4Addr>][ [-ipv4Subnet] <ipv4Subnet>][ [-ipv4Gateway] <ipv4Gateway>][ [-ipv6Type] <ipv6Type>][ [-ipv6Addr] <ipv6Addr>][ [-ipv6Subnet] <ipv6Subnet>][ [-ipv6Gateway] <ipv6Gateway>][ [-overrideIpv4DhcpDns] <overrideIpv4DhcpDns>][ [-overrideIpv6DhcpDns] <overrideIpv6DhcpDns>][ [-domainName] <domainName>][ [-searchDomains] <searchDomains>][ [-ipV4nameServers] <ipV4nameServers>][ [-ipV6nameServers] <ipV6nameServers>][ [-ntpServers] <ntpServers>] [<CommonParameters>]
Set-HPOVApplianceNetworkConfig [-device] <device> [-interfaceName] <interfaceName> [-hostname] <hostname>[ [-ipv4Type] <ipv4Type>][ [-ipv4Addr] <ipv4Addr>][ [-ipv4Subnet] <ipv4Subnet>][ [-ipv4Gateway] <ipv4Gateway>][ [-ipv6Type] <ipv6Type>][ [-ipv6Addr] <ipv6Addr>][ [-ipv6Subnet] <ipv6Subnet>][ [-ipv6Gateway] <ipv6Gateway>][ [-overrideIpv4DhcpDns] <overrideIpv4DhcpDns>][ [-overrideIpv6DhcpDns] <overrideIpv6DhcpDns>][ [-domainName] <domainName>][ [-searchDomains] <searchDomains>][ [-ipV4nameServers] <ipV4nameServers>][ [-ipV6nameServers] <ipV6nameServers>][ [-ntpServers] <ntpServers>] [<CommonParameters>]
Set-HPOVApplianceNetworkConfig [-importFile] <importFile> [<CommonParameters>]

Detailed Description

Updates any or all configuration parameters for the primary network interface on the appliance. All parameters are optional. Current settings will be retained for any parameters NOT specified.

Parameters

-device <device>

Name of the Ethernet device to be configured. Not applicable when configuring the primary Appliance network interface. Ex. eth1, eth2

Aliases None.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-interfaceName <interfaceName>

Name that describes the usage of the interface. Valid values are Management or Deployment. Not applicable when configuring the primary Appliance network interface.

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

-hostname <hostname>

Fully-qualified hostname for the appliance

Aliases None.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-ipv4Type <ipv4Type>

"DHCP", "STATIC" or "UNCONFIGURE"

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

-ipv4Addr <ipv4Addr>

"www.xxx.yyy.zzz" (leave blank for DHCP)

Aliases None.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-ipv4Subnet <ipv4Subnet>

"www.xxx.yyy.zzz" (leave blank for DHCP)

Aliases None.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-ipv4Gateway <ipv4Gateway>

"www.xxx.yyy.zzz" (leave blank for DHCP)

Aliases None.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-ipv6Type <ipv6Type>

"DHCP", "STATIC" or "UNCONFIGURE"

Aliases None.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-ipv6Addr <ipv6Addr>

Aliases None.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-ipv6Subnet <ipv6Subnet>

"ffff:ffff:ffff:ffff:0:0:0:0" (leave blank for DHCP)

Aliases None.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-ipv6Gateway <ipv6Gateway>

"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)

Aliases None.
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-overrideIpv4DhcpDns <overrideIpv4DhcpDns>

Aliases [-overrideDhcpDns] Switch to override DHCP provided DNS Servers

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

-overrideIpv6DhcpDns <overrideIpv6DhcpDns>

Switch to override DHCPv6 provided DNS Servers

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

-domainName <domainName>

DNS domain name for the appliance: "my.com"

Aliases None.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-searchDomains <searchDomains>

Array of DNS search domains: "my.com", "other.com"

Aliases None.
Required? false
Position? 11
Default value @()
Accept pipeline input? false
Accept wildcard characters?    false

-ipV4nameServers <ipV4nameServers>

Aliases [-nameServers] Array of DNS servers: "www.xxx.yyy.zzz", "sss.ttt.uuu.vvv"

Aliases None.
Required? false
Position? 12
Default value @()
Accept pipeline input? false
Accept wildcard characters?    false

-ipV6nameServers <ipV6nameServers>

Array of DNS servers: "fe80::200:f8ff:fe21:67cf", "fe80::200:f8ff:fe21:89cb"

Aliases None.
Required? false
Position? 13
Default value @()
Accept pipeline input? false
Accept wildcard characters?    false

-ntpServers <ntpServers>

Array of NTP servers: "ntp.local.com", "backup.ntp.com"

Aliases None.
Required? false
Position? 14
Default value @()
Accept pipeline input? false
Accept wildcard characters?    false

-importFile <importFile>

Aliases None.
Required? true
Position? named
Default value
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

System.Management.Automation.PSCustomObject Final Task status (for asynchronous appliance config).

Examples

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

PS C:\> Set-HPOVApplianceNetworkConfig -hostname "appliance1.my.com" -ipv4Type "DHCP" -ipv6Type "UNCONFIGURE" -domainName "my.com"

This example passes in updated values to set for the appliance networking configuration.

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

PS C:\> Set-HPOVApplianceNetworkConfig -importFile "c:\myNetworkInput.json"

This example passes the name of an input file containing JSON formatted properties and values for the appliance network configuration.

Related Links

Wiki Table of Contents

Clone this wiki locally