Set-SCVirtualNetworkAdapterConfiguration

Set-SCVirtualNetworkAdapterConfiguration

Modifies the virtual network adapter configuration contained within a virtual machine configuration.

Syntax

Parameter Set: Default
Set-SCVirtualNetworkAdapterConfiguration -VirtualNetworkAdapterConfiguration <VirtualNetworkAdapterConfiguration> [-IPv4Address <String> ] [-IPv4AddressPool <StaticIPAddressPool> ] [-IPv4PAAddress <String> ] [-IPv4PAAddressPool <StaticIPAddressPool> ] [-IPv6Address <String> ] [-IPv6AddressPool <StaticIPAddressPool> ] [-IPv6PAAddress <String> ] [-IPv6PAAddressPool <StaticIPAddressPool> ] [-JobVariable <String> ] [-MACAddress <String> ] [-MACAddressPool <MACAddressPool> ] [-PinIPv4AddressPool <Boolean> ] [-PinIPv4PAAddressPool <Boolean> ] [-PinIPv6AddressPool <Boolean> ] [-PinIPv6PAAddressPool <Boolean> ] [-PinMACAddressPool <Boolean> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMSubnet <VMSubnet> ] [ <CommonParameters>]

Detailed Description

The Set-SCVirtualNetworkAdapterConfiguration cmdlet modifies the virtual network adapter configuration information that is contained within a virtual machine configuration.

Parameters

-IPv4Address<String>

Specifies an IPv4 address.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv4AddressPool<StaticIPAddressPool>

Specifies a static address pool that contains IPv4 addresses.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv4PAAddress<String>

Specifies a provider IP address in IPv4 format.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv4PAAddressPool<StaticIPAddressPool>

Specifies a provider IP address pool that contains IP addresses in IPv4 format.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv6Address<String>

Specifies an IPv6 address.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv6AddressPool<StaticIPAddressPool>

Specifies a static address pool that contains IPv6 addresses.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv6PAAddress<String>

Specifies a provider IP address in IPv6 format.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv6PAAddressPool<StaticIPAddressPool>

Specifies a provider IP address pool that contains IP addresses in IPv6 format.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MACAddress<String>

Specifies the MAC address or a set of MAC addresses for a physical or virtual network adapter on a computer.

Example format for a single MAC address:

-MACAddress "00-15-5D-B4-DC-00"

Example formats for a set of MAC addresses:

-MACAddress "00-15-5D-B4-DC-00", "00-1A-A0-E3-75-29"

$Macs = "00-15-5D-B4-DC-00", "00-1A-A0-E3-75-29"

Set-SCPXEServer –MACAddress $Macs

NOTE: When used with New-SCPXEServer or Set-SCPXEServer, the MACAddress parameter updates the PXE interfaces from which the SCDM PXE Server listens for and responds to PXE requests.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MACAddressPool<MACAddressPool>

Specifies a MAC address pool.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PinIPv4AddressPool<Boolean>

Indicates whether the IPv4 address pool chosen by the user is retained during service deployment configuration.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PinIPv4PAAddressPool<Boolean>

Indicates whether the IPv4 provider address pool chosen by the user is retained during service deployment configuration.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PinIPv6AddressPool<Boolean>

Indicates whether the IPv6 address pool chosen by the user is retained during service deployment configuration.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PinIPv6PAAddressPool<Boolean>

Indicates whether the IPv6 provider address pool chosen by the user is retained during service deployment configuration.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PinMACAddressPool<Boolean>

Indicates whether the MAC address pool chosen by the user is retained during service deployment configuration.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VirtualNetworkAdapterConfiguration<VirtualNetworkAdapterConfiguration>

Specifies a virtual network adapter configuration object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMSubnet<VMSubnet>

Specifies a VM subnet object.

To obtain a VM subnet object, use the Get-SCVMSubnet cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • VirtualNetworkAdapterConfiguration

Examples

Example 1: Set the properties of the virtual network adapter configuration for a virtual machine configuration

The first command gets the service configuration object named Service01, and then stores the object in the $ServiceConfig variable.

The second command gets the computer tier configuration for the service configuration stored in $ServiceConfig, and then stores the object in the $TierConfig variable.

The third command gets the virtual machine configuration for the computer tier configuration stored in $TierConfig, and then stores the object in the $VMConfig variable.

The fourth command gets the virtual network adapter configuration for the first virtual machine configuration stored in $VMConfig, and then stores the object in the $VNAConfig variable.

The last command changes the IPv4Address property of the network adapter configuration stored in $VNAConfig, and pins the value of the IP address, which prevents it from being changed during placement.

PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $TierConfig = Get-SCComputerTierConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> $VMConfig = Get-SCVMConfiguration -ComputerTierConfiguration $TierConfig
PS C:\> $VNAConfig = Get-SCVirtualNetworkAdapterConfiguration -VMConfiguration $VMConfig[0]
PS C:\> Set-SCVirtualNetworkAdapterConfiguration -VirtualNetworkAdapterConfiguration $VNAConfig -IPv4Address "10.255.234.155" -PinIPv4AddressPool $True

Get-SCComputerTierConfiguration

Get-SCServiceConfiguration

Get-SCVirtualNetworkAdapterConfiguration

Get-SCVMConfiguration

Get-SCVMSubnet