New-OSCustomizationNicMapping

This cmdlet adds NIC settings mappings to the specified OS customization specifications. If the given specification is server-side, it is updated on the server. If it is client-side, the reference that is kept in-memory is updated but the variable that is passed to the cmdlet is not modified.

Syntax

-OSCustomizationSpec  <OSCustomizationSpec>
[[-SubnetMask]  <String>]
[[-DefaultGateway]  <String>]
[[-Dns]  <String[]>]
[-AlternateGateway  <String>]
[-IpAddress  <String>]
[-IpMode  <OSCustomizationIPMode>]
[-Server  <VIServer[]>]
[-VCApplicationArgument  <String>]
[-Wins  <String[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
OSCustomizationSpec
OSCustomizationSpec named
  • wildcards
  • pipeline
  • Specifies the OS customization specification to which you want to add the NIC setting mapping. Passing multiple values to this parameter is obsolete.
    optional
    SubnetMask
    String 1 Specifies a subnet mask.
    optional
    DefaultGateway
    String 2 Specifies a default gateway.
    optional
    Dns
    String[] 3 Specifies a DNS address. This parameter applies only to Windows operating systems.
    optional
    AlternateGateway
    String named Specifies an alternate gateway.
    optional
    IpAddress
    String named Specifies an IP address. Using this parameter automatically sets the IpMode parameter to UseStaticIp.
    optional
    IpMode
    OSCustomizationIPMode named Specifies the IP configuration mode. The valid values are UseDhcp, PromptUser, UseVCApplication, and UseStaticIP.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    VCApplicationArgument
    String named Specifies an optional argument you want to pass to the vCenter Server to obtain an IP address.
    optional
    Wins
    String[] named
  • wildcards
  • Specifies WINS servers. This parameter applies only to Windows operating systems.

    -OSCustomizationSpec  <OSCustomizationSpec>
    [[-SubnetMask]  <String>]
    [[-DefaultGateway]  <String>]
    [[-Dns]  <String[]>]
    [-AlternateGateway  <String>]
    [-IpAddress  <String>]
    [-IpMode  <OSCustomizationIPMode>]
    [-NetworkAdapterMac  <String[]>]
    [-Server  <VIServer[]>]
    [-VCApplicationArgument  <String>]
    [-Wins  <String[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    OSCustomizationSpec
    OSCustomizationSpec named
  • wildcards
  • pipeline
  • Specifies the OS customization specification to which you want to add the NIC setting mapping. Passing multiple values to this parameter is obsolete.
    optional
    SubnetMask
    String 1 Specifies a subnet mask.
    optional
    DefaultGateway
    String 2 Specifies a default gateway.
    optional
    Dns
    String[] 3 Specifies a DNS address. This parameter applies only to Windows operating systems.
    optional
    AlternateGateway
    String named Specifies an alternate gateway.
    optional
    IpAddress
    String named Specifies an IP address. Using this parameter automatically sets the IpMode parameter to UseStaticIp.
    optional
    IpMode
    OSCustomizationIPMode named Specifies the IP configuration mode. The valid values are UseDhcp, PromptUser, UseVCApplication, and UseStaticIP.
    optional
    NetworkAdapterMac
    String[] named Specifies the MAC addresses of the network adapters to which you want to map the new OS customization specifications.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    VCApplicationArgument
    String named Specifies an optional argument you want to pass to the vCenter Server to obtain an IP address.
    optional
    Wins
    String[] named
  • wildcards
  • Specifies WINS servers. This parameter applies only to Windows operating systems.

    -OSCustomizationSpec  <OSCustomizationSpec>
    [[-SubnetMask]  <String>]
    [[-DefaultGateway]  <String>]
    [[-Dns]  <String[]>]
    [-AlternateGateway  <String>]
    [-IpAddress  <String>]
    [-IpMode  <OSCustomizationIPMode>]
    [-Position  <Int32[]>]
    [-Server  <VIServer[]>]
    [-VCApplicationArgument  <String>]
    [-Wins  <String[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    OSCustomizationSpec
    OSCustomizationSpec named
  • wildcards
  • pipeline
  • Specifies the OS customization specification to which you want to add the NIC setting mapping. Passing multiple values to this parameter is obsolete.
    optional
    SubnetMask
    String 1 Specifies a subnet mask.
    optional
    DefaultGateway
    String 2 Specifies a default gateway.
    optional
    Dns
    String[] 3 Specifies a DNS address. This parameter applies only to Windows operating systems.
    optional
    AlternateGateway
    String named Specifies an alternate gateway.
    optional
    IpAddress
    String named Specifies an IP address. Using this parameter automatically sets the IpMode parameter to UseStaticIp.
    optional
    IpMode
    OSCustomizationIPMode named Specifies the IP configuration mode. The valid values are UseDhcp, PromptUser, UseVCApplication, and UseStaticIP.
    optional
    Position
    Int32[] named Specifies the position of the NIC to which you want to map the OS customization specification.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    VCApplicationArgument
    String named Specifies an optional argument you want to pass to the vCenter Server to obtain an IP address.
    optional
    Wins
    String[] named
  • wildcards
  • Specifies WINS servers. This parameter applies only to Windows operating systems.

    Output

    VMware.VimAutomation.ViCore.Types.V1.OSCustomization.OSCustomizationNicMapping

    Examples


    Example 1

    New-OSCustomizationNicMapping -OSCustomizationSpec $spec -IpMode UseStaticIP -IPAddress 10.0.0.1 -SubnetMask 255.255.255.0 -DefaultGateway 10.0.0.253 -DnsServer 10.0.0.253

    Creates a new NIC mapping for the OS customization spec stored in $spec.

    Related Commands

    Feedback

    Was this page helpful?