# RAS PowerShell API

RAS PowerShell API は、RAS 管理業務の自動化を望む RAS 管理者を想定しています。この API には、RAS 管理タスクを実行するための多くのコマンドが含まれます。

**Parallels RAS の要件**

Parallels RAS PowerShell API のバージョンは、通信対象である RAS Connection Broker のバージョンと一致する必要があります。この 2 つのコンポーネントは別々にインストールできるため、これらのバージョンが一致していることを確認する必要があります。

**Microsoft Windows コンポーネントの要件**

次のコンポーネントが、Parallels RAS PowerShell コマンドレットを実行するコンピューターにインストールされている必要があります。

* Windows PowerShell 3.0 以降
* Microsoft .NET Framework 4.5.2 以降

**インストール**

Parallels RAS PowerShell をインストールするには、Parallels RAS の標準インストーラーを実行し、**\[カスタム]** インストールを選択して、**\[Parallels RAS PowerShell]** コンポーネントのインストールを選択します。画面の指示に従い、コンポーネントをインストールします。

**RAS PowerShell API のバージョン**

Parallels RAS 18 では、RAS PowerShell API が次のように変更されています。

* RAS PowerShell モジュール名が PSAdmin から RASAdmin に変更されました。
* ほとんどのコマンドには、RASGW や RASApply などの”RAS”プレフィックスが付記されるようになりました。
* API のバージョン: バージョン 2.0（最新）とバージョン 1.0 は、下位互換性を確保するためにサポートされています。

現在の RAS PowerShell モジュールでは、API バージョン 1.0 が引き続き使用できることに注意してください。古いモジュール名とコマンド名を使用する既存のスクリプトが存在する場合、最小限の変更でそれらを使用できます。これを行うには、RAS PowerShell モジュールをインポートするときに API バージョン 1.0 を読み込む必要があります。API バージョンの詳細については、以下を参照してください。

**バージョン 2.0**

このバージョンは、デフォルトでシステムによって読み込まれます。また、モジュールをインポートするときに、`-RequiredVersion` パラメーターが指定されていない場合も読み込まれます。\*\*「RAS PowerShell API の基本概念」\*\*の例を参照してください。

**バージョン 1.0**

このバージョンでは、古い PSAdmin モジュールとの下位互換性が維持されており、管理者が小さな変更を加えることで既存のスクリプトを使用できるようにします。このバージョンには次のものが含まれます。

* コマンドレットエイリアス
* エイリアスのパラメーター
* 古いプロパティと新しいプロパティの返還

**RAS PowerShell API の概念**

RAS PowerShell を手軽に始めるには、次の手順を実行します。

1. Windows PowerShell コンソールを開きます。
2. 次のいずれかのコマンドを使用して、Parallels RAS PowerShell モジュールをインポートします。
   * `Import-Module RASAdmin -` : 現在の API（バージョン 2.0）を読み込みます。
   * `Import-Module RASAdmin -RequiredVersion 1.0 -` : API（バージョン 1.0）を読み込みます。
3. `New-RASSession` コマンドレット（下の例を参照）を実行して Parallels RAS セッションを作成します。サーバー名（引用符内）は、お使いの Parallels RAS ライセンスサーバーの名前または IP アドレスに置き換えてください。入力を求められたら、RAS 管理者のユーザー名とパスワードを入力します。

   `New-RASSession -Server "server.company.dom"`
4. 次のコマンドレットを実行して、Parallels RAS PowerShell モジュールに含まれるコマンドレットのリストを確認します。

   `Get-Command -Module RASAdmin`
5. 他のコマンドレットを実行します。たとえば、`Get-GW` コマンドレットを実行して RAS Secure Gateway についての情報の取得してみます。下の例は、RAS ライセンスサーバーのサイトで利用できるすべての RAS Secure Gateway についての情報を返します。

   `Get-RASGW`
6. コマンドレットのヘルプを参照するには、コマンドレット名を渡して `Get-Help` を実行します。

   `Get-Help Get-RASGW`
7. ファームの構成に行った変更を適用するには、`Invoke-RASApply` コマンドレットを使用します（このコマンドレットでは、RAS Console の **\[適用]** ボタンと同じアクションが実行されます）。

   `Invoke-RASApply`
8. Parallels RAS ライセンスをアクティベートするには、`Invoke-RASLicenseActivate` コマンドレットを使用します。

   `Invoke-RASLicenseActivate`

   上述のコマンドレットを実行すると、Parallels アカウントのメールアドレスとパスワードの入力を求められます。オプションの `-Key` パラメーターを使用して Parallels RAS のライセンスキーを指定することができます。省略した場合は（上の例を参照）、Parallels RAS はトライアル版としてアクティベートされます。

**Parallels RAS PowerShell ガイド**

新しい **「Parallels RAS PowerShell ガイド」**（バージョン 2.0）は、Parallels ウェブサイト（[https://www.parallels.com/products/ras/resources](https://www.parallels.com/products/ras/resources/)）で、確認およびダウンロードしてください。