Share via

Set-SCVMNetworkGateway

  • Reference
Module:
VirtualMachineManager

Sets the properties of a virtual machine network gateway.

Syntax

Set-SCVMNetworkGateway
   [-VMMServer <ServerConnection>]
   [-VMNetworkGateway] <VMNetworkGateway>
   [-Name <String>]
   [-Description <String>]
   [-EnableBGP <Boolean>]
   [-AutonomousSystemNumber <UInt32>]
   [-NetworkRoutes <NetworkRoute[]>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Set-SCVMNetworkGateway cmdlet updates the properties of a virtual machine network gateway.

Examples

Example 1: Modify the properties of a virtual machine network gateway

PS C:\> $VmNetworkGateway = Get-SCVMNetworkGateway -Name "VMGateway01"
PS C:\> Set-SCVMNetworkGateway -VMNetworkGateway $VmNetworkGateway -EnableBGP $False

The first command gets a virtual machine network gateway named VMGateway01, and then stores it in the $VmNetworkGateway variable.

The second command disables the BGP for the virtual machine network gateway in $VmNetworkGateway.

Parameters

-AutonomousSystemNumber

Specifies an Autonomous System Number (ASN).

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

-Description

Specifies a description for the network gateway.

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

-EnableBGP

Indicates whether Border Gateway Protocol (BGP) is enabled.

Type:Boolean
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

-Name

Specifies the name of a VMM object.

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

-NetworkRoutes

Specifies an array of network routes.

Type:NetworkRoute[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

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

-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Type:UserRole
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

-VMMServer

Specifies a VMM server object.

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

-VMNetworkGateway

Specifies a virtual machine network gateway object.

To obtain a virtual machine network gateway object, use the Get-SCVMNetworkGateway cmdlet.

Type:VMNetworkGateway
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False