Share via

Get-SCVMNetworkGateway

  • Reference
Module:
VirtualMachineManager

Gets a virtual machine network gateway object.

Syntax

Get-SCVMNetworkGateway
   [-VMMServer <ServerConnection>]
   -VMNetwork <VMNetwork>
   [-Name <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCVMNetworkGateway
   [-VMMServer <ServerConnection>]
   -ID <Guid>
   [-Name <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Get-SCVMNetworkGateway cmdlet gets one or more virtual machine network gateway objects.

Examples

Example 1: Get a virtual machine network gateway

PS C:\> $VmNetworkGateway = Get-SCVMNetworkGateway -Name "VMGateway01"

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

Parameters

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

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

-Name

Specifies the name of a network object.

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

-VMMServer

Specifies a Virtual Machine Manager (VMM) server object.

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

-VMNetwork

Specifies a virtual machine network object.

To get a virtual machine network object, use the Get-SCVMNetwork cmdlet.

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