< Back
Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript
Post
NAME Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript
SYNOPSIS
This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that
customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary
parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply
copy-paste to their VPN device configurations.
SYNTAX
Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript [-DefaultProfile <IAzureContextContainer>] -DeviceFamily <String> -DeviceVendor
<String> -FirmwareVersion <String> -Name <String> -ResourceGroupName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that
customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary
parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply
copy-paste to their VPN device configurations.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DeviceFamily <String>
Name of the VPN device model/family.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DeviceVendor <String>
Name of the VPN device vendor.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FirmwareVersion <String>
Firmware version of the VPN device.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
The resource name of the connection for which the configuration is to be generated.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
System.String
NOTES
Example 1
PS C:\\> Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice -ResourceGroupName TestRG -Name TestGateway
PS C:\\> Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript -ResourceGroupName TestRG -Name TestConnection -DeviceVendor "Cisco-Test"
-DeviceFamily "IOS-Test" -FirmwareVersion "20"
The above example uses Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice to get the supported VPN Device brands, models, and firmware versions.
Then uses one of the returned models information to generate a VPN Device configuration script for the VirtualNetworkGatewayConnection
"TestConnection". The device used in this example has DeviceFamily "IOS-Test", DeviceVendor "Cisco-Test" and FirmwareVersion 20.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... nfigscript
SYNOPSIS
This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that
customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary
parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply
copy-paste to their VPN device configurations.
SYNTAX
Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript [-DefaultProfile <IAzureContextContainer>] -DeviceFamily <String> -DeviceVendor
<String> -FirmwareVersion <String> -Name <String> -ResourceGroupName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that
customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary
parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply
copy-paste to their VPN device configurations.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DeviceFamily <String>
Name of the VPN device model/family.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DeviceVendor <String>
Name of the VPN device vendor.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FirmwareVersion <String>
Firmware version of the VPN device.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
The resource name of the connection for which the configuration is to be generated.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
System.String
NOTES
Example 1
PS C:\\> Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice -ResourceGroupName TestRG -Name TestGateway
PS C:\\> Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript -ResourceGroupName TestRG -Name TestConnection -DeviceVendor "Cisco-Test"
-DeviceFamily "IOS-Test" -FirmwareVersion "20"
The above example uses Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice to get the supported VPN Device brands, models, and firmware versions.
Then uses one of the returned models information to generate a VPN Device configuration script for the VirtualNetworkGatewayConnection
"TestConnection". The device used in this example has DeviceFamily "IOS-Test", DeviceVendor "Cisco-Test" and FirmwareVersion 20.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... nfigscript