Syntax
Set-OSCustomizationNicMapping -OSCustomizationNicMapping <OSCustomizationNicMapping[]> [-Position <Int32>] [-Server <VIServer[]>] [-IpMode <OSCustomizationIPMode>] [-VCApplicationArgument <String>] [[-IpAddress] <String>] [[-SubnetMask] <String>] [[-DefaultGateway] <String>] [-AlternateGateway <String>] [[-Dns] <String[]>] [-Wins <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet modifies the provided OS customization NIC mappings. If the parent spec of the provided NIC mapping is a server-side spec, it is updated on the server. If the parent spec is client-side, the reference that is kept in the memory is updated, but the variable that is passed to the cmdlet is not modified.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| IpAddress | String | Specifies an IP address. Using this parameter automatically sets the IpMode parameter to UseStaticIp. | false | false | |
| SubnetMask | String | Specifies a subnet mask. | false | false | |
| DefaultGateway | String | Specifies a default gateway. | false | false | |
| Dns | String[] | Specifies a DNS address. This parameter applies only to Windows operating systems. | false | false | |
| AlternateGateway | String | Specifies an alternate gateway. | false | false | |
| Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | false | |
| IpMode | OSCustomizationIPMode | Specifies the IP configuration mode. The valid values are UseDhcp, PromptUser, UseVCApplication, and UseStaticIP. | false | false | |
| NetworkAdapterMac | String | Specifies the MAC address of the network adapter to which you want to map the OS customization specification. | false | false | |
| OSCustomizationNicMapping | OSCustomizationNicMapping[] | Specifies the OS customization NIC mapping you want to configure. | true | true (ByValue) | |
| Position | Int32 | Specifies the position of the mapping you want to modify. | false | false | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | false | |
| VCApplicationArgument | String | Specifies a new argument you want to pass to VCApplication in order to obtain an IP address. | false | false | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false | |
| Wins | String[] | Specifies WINS servers. This parameter applies only to Windows operating systems. | false | false |
Return Type
Zero or more modified OSCustomizationNicMapping objectsNotes
Examples
-------------- Example 1 --------------
Get-OSCustomizationSpec Spec | Get-OSCustomizationNicMapping | Set-OSCustomizationNicMapping -IpAddress 10.0.0.2
Modifies the IP address of the specified NIC mapping that uses static IP mode.
-------------- Example 2 --------------
Get-OSCustomizationSpec Spec | Get-OSCustomizationNicMapping | Set-OSCustomizationNicMapping -VcApplicationArgument "subnet2"
Modifies the VCApplication argument of the specified NIC mapping.
-------------- Example 3 --------------
Get-OSCustomizationSpec Spec | Get-OSCustomizationNicMapping | Set-OSCustomizationNicMapping -IpMode UseStaticIp -IpAddress 10.10.0.1 -SubnetMask 255.255.255.0 -DefaultGateway 10.10.0.1 -AlternateGateway 10.10.0.1 -Dns 10.10.150.1 -PrimaryWins 10.10.150.2
Modifies the attributes of a NIC mapping.
-------------- Example 4 --------------
Set-OSCustomizationNicMapping -OSCustomizationNicMapping $nicMapping1, $nicMapping2 -IPMode UseVCApplication -VcApplicationArgument "subnet2"
Modifies the specified NIC mapping using VCApplication.