Get-VpnConnection
Get-VpnConnection
Retrieves the specified VPN connection profile information.
構文
Parameter Set: Get0
Get-VpnConnection [[-Name] <String[]> ] [-AllUserConnection] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
詳細説明
The Get-VpnConnection cmdlet retrieves the specified VPN connection profile and its properties. If you do not specify a profile name, the cmdlet returns a list of all VPN connections in the phone book.
パラメーター
-AllUserConnection
Indicates that the VPN connection is retrieved from the global phone book.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-AsJob
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。
エイリアス |
Session |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Name<String[]>
Specifies an array of names of VPN connection profiles.
エイリアス |
ConnectionName |
必須? |
false |
位置は? |
2 |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-ThrottleLimit<Int32>
このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
Microsoft.Management.Infrastructure.CimInstance#VpnConnection[]
Microsoft.Management.Infrastructure.CimInstanceオブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。
The VpnConnection object contains the VpnConnection configuration settings.
例
Example 1: Get all available VPN connections
This command returns a list of all available VPN connections in the user's local phone book.
PS C:\> Get-VpnConnection
Example 2: Get all available VPN connections from the global phonebook
This command retrieves all the available VPN connections from the global phone book.
PS C:\> Get-VpnConnection -AllUserConnection
Example 3: Get a specific VPN connection from the global phone book
This command retrieves the VPN connection named Test3 from the global phone book.
PS C:\> Get-VpnConnection -Name "Test3" –AllUserConnection
Example 4: Get multiple VPN connections
This command retrieves multiple specified VPN connections from the global phone book.
PS C:\> Get-VpnConnection -Name "Test3", "Test4", "test5" –AllUserConnection