Get-​Azure​Rm​Server​Management​Gateway

Gets one or more Server Management Gateways.

Syntax

Get-AzureRmServerManagementGateway
   [-ResourceGroupName] <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Get-AzureRmServerManagementGateway
   [-ResourceGroupName] <String>
   [-GatewayName] <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Get-AzureRmServerManagementGateway
   [-Gateway] <Gateway>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Get-AzureRmServerManagementGateway cmdlet gets one or more Azure Server Management Gateways.

Examples

Example 1: Get all gateways in a subscription

PS C:\>Get-AzureRmServerManagementGateway
Resource Group Location       Auto Upgrade Gateway Name
-------------- --------       ------------ ------------
groupOne       centralus      Off          mygateway
groupOne       centralus      Off          othergateway
groupTwo       centralus      On           privategateway

This command gets all Server Management Gateways in the subscription.

Example 2: Get gateways in a resource group

PS C:\>Get-AzureRmServerManagementGateway -ResourceGroupName "Group001"
Resource Group Location       Auto Upgrade Gateway Name
-------------- --------       ------------ ------------
myGroup        centralus      Off          mygateway

This command gets all Server Management Gateways that belong to the resource group named Group001.

Example 3: Get all installed instances of a gateway

PS C:\>(Get-AzureRmServerManagementGateway -ResourceGroupName "Group002" -GatewayName "Gateway01").Instances
Name             Installed              Version         Operating System
----             ---------              -------         ----------------
GATEWAYPC        4/13/2016 6:35:04 PM   1.0.1104.0      Microsoft Windows 10 Enterprise

This command gets all instances of a Server Management Gateway named Gateway01 that belong to the resource group named Group002.

Required Parameters

-Gateway

Specifies a gateway that this cmdlet gets.The cmdlet uses the ResourceGroupName and GatewayName parameters through the specified Gateway to perform the action.

When this parameter is specified, this cmdlet will include detailed status for the gateway.

Type:Gateway
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-GatewayName

Specifies the name of the Server Management Gateway for which this cmdlet gets gate.When you specify the GatewayName parameter, this cmdlet will include detailed status on the gateway.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group for which this cmdlet gets gateways.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

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

Notes

  • If this cmdlet is use without parameters, it will return all the gateways associated with the subscription.