< Back
Add-VpnConnectionTriggerApplication
Post
NAME Add-VpnConnectionTriggerApplication
SYNOPSIS
Adds applications that automatically trigger a VPN connection when launched.
SYNTAX
Add-VpnConnectionTriggerApplication [-ConnectionName] <String> [-ApplicationID] <String[]> [-CimSession <CimSession[]>] [-Force] [-PassThru]
[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Add-VpnConnectionTriggerApplication cmdlet adds applications to a VPN connection object. The applications automatically trigger a VPN connection
when launched.
PARAMETERS
-ApplicationID <String[]>
Specifies an array of unique identifiers for an application. For legacy desktop applications, the application identifier is the application path.
For modern applications, it is the Package Family Name of the application.
Required? true
Position? 3
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CimSession [<CimSession[]>]
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or
Get-CimSession cmdlet. The default is the current session on the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ConnectionName <String>
Specifies the name of a VPN connection profile. To view existing VPN connection profiles, use the Get-VpnConnection cmdlet.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. If you specify this
parameter, the cmdlet returns the VpnConnectionTriggerApplication object that contains the trigger application settings.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is
entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.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.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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#VpnConnectionTriggerApplication
Example 1: Add an application to a trigger list
PS C:\\> Add-VpnConnectionTriggerApplication -ConnectionName "Contoso" -ApplicationID
"C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe","Microsoft.RemoteDesktop_Contoso0987" -PassThru
ConnectionName : Contoso
ApplicationID : {C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe, Microsoft.RemoteDesktop_Contoso0987}
This command uses the Add-VpnConnectionTriggerApplication cmdlet to add applications to a trigger list. The command specifies the ConnectionName and
ApplicationID parameters.
RELATED LINKS
Remove-VpnConnectionTriggerApplication
SYNOPSIS
Adds applications that automatically trigger a VPN connection when launched.
SYNTAX
Add-VpnConnectionTriggerApplication [-ConnectionName] <String> [-ApplicationID] <String[]> [-CimSession <CimSession[]>] [-Force] [-PassThru]
[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Add-VpnConnectionTriggerApplication cmdlet adds applications to a VPN connection object. The applications automatically trigger a VPN connection
when launched.
PARAMETERS
-ApplicationID <String[]>
Specifies an array of unique identifiers for an application. For legacy desktop applications, the application identifier is the application path.
For modern applications, it is the Package Family Name of the application.
Required? true
Position? 3
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CimSession [<CimSession[]>]
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or
Get-CimSession cmdlet. The default is the current session on the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ConnectionName <String>
Specifies the name of a VPN connection profile. To view existing VPN connection profiles, use the Get-VpnConnection cmdlet.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. If you specify this
parameter, the cmdlet returns the VpnConnectionTriggerApplication object that contains the trigger application settings.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is
entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.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.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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#VpnConnectionTriggerApplication
Example 1: Add an application to a trigger list
PS C:\\> Add-VpnConnectionTriggerApplication -ConnectionName "Contoso" -ApplicationID
"C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe","Microsoft.RemoteDesktop_Contoso0987" -PassThru
ConnectionName : Contoso
ApplicationID : {C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe, Microsoft.RemoteDesktop_Contoso0987}
This command uses the Add-VpnConnectionTriggerApplication cmdlet to add applications to a trigger list. The command specifies the ConnectionName and
ApplicationID parameters.
RELATED LINKS
Remove-VpnConnectionTriggerApplication