This cmdlet is part of the Vexasoft Cmdlet Library. You can download it now or click here to find out more.

Add-NetworkAdapterGateway

Synopsis

Adds the specified gateway address to the configuration of a network adapter on a local or remote computer.

Syntax

  • Add-NetworkAdapterGateway [-Name] [-Gateway] [-ComputerName] [-Credential]
  • Add-NetworkAdapterGateway [-MACAddress] [-Gateway] [-ComputerName] [-Credential]

Description

The Add-NetworkAdapterGateway cmdlet is used to add additional gateway addresses to the configuration of a network adapter on a local or remote computer. Adapters can be identified by name or MAC address.

Parameters

  • Name The name of the network adapter to configure. This parameter cannot be used when the MACAddress parameter has been specified.
  • Gateway The gateway address to add.
  • MACAddress The MAC address of the network adapter to configure. This parameter cannot be used when the name parameter has been specified.
  • ComputerName The computer against which to run the cmdlet. By default this cmdlet will be populated with the name of the local computer.
  • Credential The credentials under which to run the cmdlet. By default this cmdlet will run as the current user. Using this parameter and the Get-PSCredential cmdlet you can specify an alternate set of credentials under which to execute this command.

Inputs

Add-NetworkAdapterGateway accepts the output of Get-NetworkAdapter as an input object. The Name, MACAddress and ComputerName parameters each accept pipeline input by property name.

Outputs

Add-NetworkAdapterGateway makes changes directly to Windows and does not output any Powershell objects.

Notes

The Request-NetworkAdapterIPAddress cmdlet requires that the Remote Registry and RPC services are started on the computer it is trying to access and that DNS services are available to resolve target host names.

Example 1

This command will add an additional gateway to the configuration of adapter "Local Area Connection" on the remote computer PC01:

C:\PS>Add-NetworkAdapterGateway "Local Area Connection" -Gateway 192.168.0.44 -Computer PC01

Example 2

This command will add an additional gateway to the configuration of adapter "Local Area Connection" on the local computer:

C:\PS>Add-NetworkAdapterGateway "Local Area Connection" -Gateway 192.168.0.44

Example 3

Add-NetworkAdapterGateway can also be used in conjunction with Get-NetworkAdapter. In this example, Get-NetworkAdapter fetches the network adapter "Local Area Connection" on the remote computer PC01 and Add-NetworkAdapterGateway appends the gateway 192.168.1.44.

C:\PS>Get-NetworkAdapterGateway "Local Area Connection" -Computer PC01 | Add-NetworkAdapterGateway 192.168.1.44