Share via

New-SCVMHostNetworkAdapterProfile

  • Reference
Module:
VirtualMachineManager

Creates a host network adapter profile.

Syntax

New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsPhysicalNetworkAdapter]
   [-SetAsGenericNIC]
   [-ConsistentDeviceName <String>]
   [-UseDhcpForIPConfiguration]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsPhysicalNetworkAdapter]
   [-SetAsManagementNIC]
   [-ConsistentDeviceName <String>]
   [-UseDhcpForIPConfiguration]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsPhysicalNetworkAdapter]
   [-SetAsGenericNIC]
   [-ConsistentDeviceName <String>]
   [-UseStaticIPForIPConfiguration]
   -LogicalNetwork <LogicalNetwork>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsPhysicalNetworkAdapter]
   [-ConsistentDeviceName <String>]
   -LogicalSwitch <LogicalSwitch>
   -UplinkPortProfileSet <UplinkPortProfileSet>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsPhysicalNetworkAdapter]
   [-SetAsManagementNIC]
   [-ConsistentDeviceName <String>]
   [-UseStaticIPForIPConfiguration]
   -LogicalNetwork <LogicalNetwork>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsVirtualNetworkAdapter]
   [-SetAsManagementNIC]
   -TransientManagementNetworkAdapter <PhysicalComputerNetworkAdapterProfile>
   [-UseStaticIPForIPConfiguration]
   -LogicalSwitch <LogicalSwitch>
   [-PortClassification <PortClassification>]
   -VMNetwork <VMNetwork>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsVirtualNetworkAdapter]
   [-SetAsGenericNIC]
   [-UseDhcpForIPConfiguration]
   -LogicalSwitch <LogicalSwitch>
   [-PortClassification <PortClassification>]
   -VMNetwork <VMNetwork>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsVirtualNetworkAdapter]
   [-SetAsGenericNIC]
   [-UseStaticIPForIPConfiguration]
   -LogicalSwitch <LogicalSwitch>
   [-PortClassification <PortClassification>]
   -VMNetwork <VMNetwork>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
New-SCVMHostNetworkAdapterProfile
   [-VMMServer <ServerConnection>]
   [-SetAsVirtualNetworkAdapter]
   [-SetAsManagementNIC]
   -TransientManagementNetworkAdapter <PhysicalComputerNetworkAdapterProfile>
   [-UseDhcpForIPConfiguration]
   -LogicalSwitch <LogicalSwitch>
   [-PortClassification <PortClassification>]
   -VMNetwork <VMNetwork>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The New-SCVMHostNetworkAdapterProfile cmdlet creates a network adapter profile.

Note that after you have created a network adapter profile, it cannot be updated. To change a network adapter profile, you must remove the network adapter profile and then re-create it.

Examples

Example 1: Create a generic physical host network adapter profile by using DHCP

PS C:\> New-SCVMHostNetworkAdapterProfile -SetAsPhysicalNetworkAdapter -SetAsGenericNIC -UseDhcpForIPConfiguration -ConsistentDeviceName "Physical host network adapter profile 01"

This command creates a physical host network adapter profile.

The switches used in this command indicate that this is a physical network adapter and that the network adapter is not the management network adapter for the host. Additionally, DHCP is used to obtain an IP address for the network adapter.

Example 2: Create a physical network adapter profile with a logical switch

PS C:\> $LogSwitch = Get-SCLogicalSwitch -Name "LogicalSwitch01"
PS C:\> $UplinkPortProfSet = Get-SCUplinkPortProfileSet -Name "UplinkPortProfileSet01"
PS C:\> New-SCVMHostNetworkAdapterProfile -SetAsPhysicalNetworkAdapter -LogicalSwitch $LogSwitch -UplinkPortProfileSet $UplinkPortProfSet -ConsistentDeviceName "Physical host network adapter profile 02"

The first command gets the logical switch object named LogicalSwitch01 and stores the object in the $LogSwitch variable.

The second command gets the uplink port profile set object named UplinkPortProfileSet01 and stores the object in the $UplinkPortProfSet variable.

The last command creates a physical host network adapter profile using LogicalSwitch01 and UplinkPortProfileSet01.

Example 3: Create a management virtual host network adapter profile by using a static IP address

PS C:\> $TransMgmtNIC = Get-SCVMHostNetworkAdapterProfile -ID "259f47c7-c5a9-429d-a421-d232f9b34991"
PS C:\> $LogSwitch = Get-SCLogicalSwitch -Name "LogicalSwitch01"
PS C:\> $VMNetwork = Get-SCVMNetwork -Name "VMNetwork01"
PS C:\> New-SCVMHostNetworkAdapterProfile -SetAsVirtualNetworkAdapter -SetAsManagementNIC -TransientManagementNetworkAdapter $TransMgmtNIC -UseStaticIPForIPConfiguration -LogicalSwitch $LogSwitch -VMNetwork $VMNetwork

The first command gets the host network adapter profile object with the ID of 259f47c7-c5a9-429d-a421-d232f9b34991 and stores the object in the $TransMgmtNIC variable.

The second command gets the logical switch object named LogicalSwitch01 and stores the object in the $LogSwitch variable.

The third command gets the VM network object named VMNetwork01 and stores the object in the $VMNetwork variable.

The last command creates a virtual host network adapter prfile as a management network adapter using LogicalSwitch01 and VMNetwork01.

Parameters

-ConsistentDeviceName

Specifies a consistent device name for a network adapter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LogicalNetwork

Specifies a logical network. A logical network is a named grouping of IP subnets and VLANs that is used to organize and simplify network assignments.

Type:LogicalNetwork
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LogicalSwitch

Specifies a logical switch object.

Type:LogicalSwitch
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PortClassification

Specifies the port classification of the switch to which the virtual network adapter connects.

Type:PortClassification
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SetAsGenericNIC

Indicates that the network adapter is not the management network adapter for the host.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SetAsManagementNIC

Indicates that the network adapter is the management network adapter for the host.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SetAsPhysicalNetworkAdapter

Indicates that the network adapter is a physical network adapter.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SetAsVirtualNetworkAdapter

Indicates that the network adapter is a virtual network adapter.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TransientManagementNetworkAdapter

Specifies the physical network adapter that the management virtual network adapter binds to during the initial operating system deployment phase. This property is used temporarily before the host is deployed.

Type:PhysicalComputerNetworkAdapterProfile
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UplinkPortProfileSet

Specifies an uplink port profile set object.

To obtain an uplink port profile set object, use the Get-SCUplinkPortProfileSet cmdlet.

Type:UplinkPortProfileSet
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UseDhcpForIPConfiguration

Indicates that the IP address for the network adapter is obtained by using DHCP.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UseStaticIPForIPConfiguration

Indicates that the network adapter is configured with a static IP address.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMNetwork

Specifies a VM network object.

To get a VM network object, use the Get-SCVMNetwork cmdlet.

Type:VMNetwork
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

HostNetworkAdapterProfile

This cmdlet returns a HostNetworkAdapterProfile object.