< Back
Set-OSCustomizationNicMapping
Post
NAME Set-OSCustomizationNicMapping
SYNOPSIS
This cmdlet modifies the provided OS customization NIC mappings.
SYNTAX
Set-OSCustomizationNicMapping [[-IpAddress] <String>] [[-SubnetMask] <String>] [[-DefaultGateway] <String>]
[[-Dns] <String[]>] [-AlternateGateway <String>] [-IpMode <OSCustomizationIPMode>] [-NetworkAdapterMac <String>]
-OSCustomizationNicMapping <OSCustomizationNicMapping[]> [-Server <VIServer[]>] [-VCApplicationArgument <String>]
[-Wins <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-OSCustomizationNicMapping [[-IpAddress] <String>] [[-SubnetMask] <String>] [[-DefaultGateway] <String>]
[[-Dns] <String[]>] [-AlternateGateway <String>] [-IpMode <OSCustomizationIPMode>] -OSCustomizationNicMapping
<OSCustomizationNicMapping[]> [-Position <Int32>] [-Server <VIServer[]>] [-VCApplicationArgument <String>] [-Wins
<String[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
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
-AlternateGateway <String>
Specifies an alternate gateway.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultGateway <String>
Specifies a default gateway.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Dns <String[]>
Specifies a DNS address. This parameter applies only to Windows operating systems.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IpAddress <String>
Specifies an IP address. Using this parameter automatically sets the IpMode parameter to UseStaticIp.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IpMode <OSCustomizationIPMode>
Specifies the IP configuration mode. The valid values are UseDhcp, PromptUser, UseVCApplication, and
UseStaticIP.
Required? false
Position? named
Default value UseDhcp
Accept pipeline input? False
Accept wildcard characters? false
-NetworkAdapterMac <String>
Specifies the MAC address of the network adapter to which you want to map the OS customization specification.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OSCustomizationNicMapping <OSCustomizationNicMapping[]>
Specifies the OS customization NIC mapping you want to configure.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Position <Int32>
Specifies the position of the mapping you want to modify.
Required? false
Position? named
Default value Last
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-SubnetMask <String>
Specifies a subnet mask.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VCApplicationArgument <String>
Specifies a new argument you want to pass to VCApplication in order to obtain an IP address.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Wins <String[]>
Specifies WINS servers. This parameter applies only to Windows operating systems.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more modified OSCustomizationNicMapping objects
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... pping.html
Get-OSCustomizationNicMapping
New-OSCustomizationNicMapping
Remove-OSCustomizationNicMapping
SYNOPSIS
This cmdlet modifies the provided OS customization NIC mappings.
SYNTAX
Set-OSCustomizationNicMapping [[-IpAddress] <String>] [[-SubnetMask] <String>] [[-DefaultGateway] <String>]
[[-Dns] <String[]>] [-AlternateGateway <String>] [-IpMode <OSCustomizationIPMode>] [-NetworkAdapterMac <String>]
-OSCustomizationNicMapping <OSCustomizationNicMapping[]> [-Server <VIServer[]>] [-VCApplicationArgument <String>]
[-Wins <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-OSCustomizationNicMapping [[-IpAddress] <String>] [[-SubnetMask] <String>] [[-DefaultGateway] <String>]
[[-Dns] <String[]>] [-AlternateGateway <String>] [-IpMode <OSCustomizationIPMode>] -OSCustomizationNicMapping
<OSCustomizationNicMapping[]> [-Position <Int32>] [-Server <VIServer[]>] [-VCApplicationArgument <String>] [-Wins
<String[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
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
-AlternateGateway <String>
Specifies an alternate gateway.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultGateway <String>
Specifies a default gateway.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Dns <String[]>
Specifies a DNS address. This parameter applies only to Windows operating systems.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IpAddress <String>
Specifies an IP address. Using this parameter automatically sets the IpMode parameter to UseStaticIp.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IpMode <OSCustomizationIPMode>
Specifies the IP configuration mode. The valid values are UseDhcp, PromptUser, UseVCApplication, and
UseStaticIP.
Required? false
Position? named
Default value UseDhcp
Accept pipeline input? False
Accept wildcard characters? false
-NetworkAdapterMac <String>
Specifies the MAC address of the network adapter to which you want to map the OS customization specification.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OSCustomizationNicMapping <OSCustomizationNicMapping[]>
Specifies the OS customization NIC mapping you want to configure.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Position <Int32>
Specifies the position of the mapping you want to modify.
Required? false
Position? named
Default value Last
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-SubnetMask <String>
Specifies a subnet mask.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VCApplicationArgument <String>
Specifies a new argument you want to pass to VCApplication in order to obtain an IP address.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Wins <String[]>
Specifies WINS servers. This parameter applies only to Windows operating systems.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more modified OSCustomizationNicMapping objects
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... pping.html
Get-OSCustomizationNicMapping
New-OSCustomizationNicMapping
Remove-OSCustomizationNicMapping