Set-SCVMNetworkGateway

Sets the properties of a virtual machine network gateway.

Syntax

Set-SCVMNetworkGateway [-VMNetworkGateway] <VMNetworkGateway> [-AutonomousSystemNumber <UInt32>]
 [-Description <String>] [-EnableBGP <Boolean>] [-JobVariable <String>] [-Name <String>]
 [-NetworkRoutes <NetworkRoute[]>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>] [-RunAsynchronously] [-VMMServer <ServerConnection>] [<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
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description for the network gateway.

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

Indicates whether Border Gateway Protocol (BGP) is enabled.

Type:Boolean
Required:False
Position:Named
Default value:None
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
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of a VMM object.

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

Specifies an array of network routes.

Type:NetworkRoute[]
Required:False
Position:Named
Default value:None
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
Required:False
Position:Named
Default value:None
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
Required:False
Position:Named
Default value:None
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
Required:False
Position:Named
Default value:None
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
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
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
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False