Set HPOVApplianceNetworkConfig - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Set-HPOVApplianceNetworkConfig

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

SYNTAX

Set-HPOVApplianceNetworkConfig [-Hostname] <String> [-IPv4Type] <String> [-IPv4Addr] <IPAddress> [-IPv4Subnet] <String> [-IPv4Gateway] <IPAddress> [-IPv6Type] <String> [-IPv6Addr] <IPAddress> [-IPv6Subnet] <String> [-IPv6Gateway] <String>[ [-OverrideIPv4DhcpDns] <SwitchParameter>][ [-OverrideIPv6DhcpDns] <SwitchParameter>] [-DomainName] <String> [-SearchDomains] <Array> [-IPv4NameServers] <Array> [-IPv6NameServers] <Array> [-NtpServers] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Set-HPOVApplianceNetworkConfig [-Hostname] <String> [-IPv4Addr] <IPAddress> [-IPv4Subnet] <String> [-IPv4Gateway] <IPAddress> [-ServiceIPv4Node1] <IPAddress> [-ServiceIPv4Node2] <IPAddress> [-IPv4Type] <String> [-IPv6Type] <String> [-IPv6Addr] <IPAddress> [-IPv6Subnet] <String> [-IPv6Gateway] <String>[ [-ServiceIPv6Node1] <IPAddress>][ [-ServiceIPv6Node2] <IPAddress>][ [-OverrideIPv4DhcpDns] <SwitchParameter>][ [-OverrideIPv6DhcpDns] <SwitchParameter>] [-DomainName] <String> [-SearchDomains] <Array> [-IPv4NameServers] <Array> [-IPv6NameServers] <Array>[ [-ApplianceConnection] <Object>] [<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:ConnectedSessions} | ? Default

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

-DomainName <String>

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

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

-Hostname <String>

Fully-qualified hostname for the appliance

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

-IPv4Addr <IPAddress>

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

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

-IPv4Gateway <IPAddress>

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

Aliases	None
Required?	true
Position?	named
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?	named
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?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-IPv4Type <String>

"DHCP", "STATIC" or "UNCONFIGURE"

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

-IPv6Addr <IPAddress>

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

Aliases	None
Required?	true
Position?	named
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?	named
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?	named
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?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-IPv6Type <String>

"DHCP", "STATIC" or "UNCONFIGURE"

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

-NtpServers <Object>

Deprecated parameter. NTP Server configuration is now controlled in the Set-HPOVApplianceDateTime Cmdlet. Please update your scripts accordingly.

Aliases	None
Required?	true
Position?	named
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?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-ServiceIPv4Node1 <IPAddress>

Reserved for Synergy.

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

-ServiceIPv4Node2 <IPAddress>

Reserved for Synergy.

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

-ServiceIPv6Node1 <IPAddress>

Reserved for Synergy.

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

-ServiceIPv6Node2 <IPAddress>

Reserved for Synergy.

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

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

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

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.

HPE OneView 4.00 Library