パラメータ
適用先: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
トピックの最終更新日: 2007-06-20
ほとんどのコマンドレットはパラメータに依存しています。パラメータとは、操作するオブジェクトおよびオブジェクトの属性を識別するか、またはコマンドレットがタスクを実行する方法を制御する情報を、コマンドレットに提供する要素です。次のように、パラメータの名前の前にはハイフン (-) があり、後にはパラメータの値があります。
Verb-Noun -ParameterName <ParameterValue>
この簡単な例では、パラメータ名の前にあるハイフンは、ハイフンの直後に続く語がコマンドレットに渡すパラメータであり、パラメータの後にある次の独立した語がパラメータの値であることを、Exchange 管理シェルに知らせています。
位置パラメータ
位置パラメータとは、パラメータの名前を指定せずにパラメータの値を指定できるパラメータです。Parameter Position 属性が整数である場合、パラメータは位置パラメータです。この整数は、コマンドレットがパラメータの値を見つけることができるコマンド ライン上の位置を示しています。
ほとんどのコマンドレットは、Identity という位置パラメータを 1 つだけ持っています。コマンドレット上で利用可能な場合、Identity は常に位置 1 にあります。位置パラメータでないパラメータは、named パラメータと見なされます。named パラメータでは、パラメータ名とパラメータ値を指定する必要があります。
次の 2 つのコマンドは、受信コネクタ "Contoso" の構成情報を返すという同じタスクを実行します。
Get-ReceiveConnector -Identity "Contoso"
Get-ReceiveConnector "Contoso"
パラメータの詳細
Get-Help コマンドレットで取得される情報の Parameters セクションには、メタデータとも呼ばれる各パラメータの詳細が含まれています。次の例は、Get-Service コマンドレットの場合です。
PARAMETERS
-ServiceName System.String[]
Parameter required? false
Parameter position? 1
Default value *
Accept pipeline input? true
Accept wildcard characters? True
この Get-Service コマンドレットの例には、ServiceName パラメータに渡すことができる値の種類に関するいくつかのきわめて具体的な詳細が含まれています。すべてのコマンドレットにこのような詳細が含まれているとは限りません。ただし、表 1 に示すように、ほとんどのコマンドレットには各パラメータに対するいくつかの設定が含まれています。
表 1 パラメータ設定
| 設定 | 説明 |
|---|---|
Required? |
この設定は、パラメータを指定しなかった場合にコマンドレットが動作するかどうかを示しています。Required? が |
Position? |
この設定は、パラメータ値の前にパラメータ名を置く必要があるかどうかを示しています。Position? が Position? が整数に設定されている場合、必要なのは値だけでパラメータ名は不要です。 |
Default value |
この設定は、他の値を指定しなかった場合のこのパラメータの既定値を示しています。 |
Accept pipeline input? |
この設定は、パラメータが他のコマンドレットからパイプラインを介した入力としてパラメータ値を取得できるかどうかを示しています。 |
Accept wildcard characters? |
この設定は、パラメータの値にワイルドカード文字を使用して、複数のオブジェクトを検索することができるかどうかを示しています。 |
ブール値パラメータ
ブール値パラメータは、機能またはオプションが有効 ($True) か無効 ($False) かを判断するために Exchange 管理シェルで使用します。ブール値パラメータに割り当てる値は、変更しているオブジェクトの構成に格納されます。ブール値パラメータに値を指定する場合は、$True (つまり 1) または $False (つまり 0) の値を使用する必要があります。$True および $False には、ドル記号 ($) が含まれている必要があります。いくつかのコマンドでは、ブール値パラメータの名前とブール値の間にコロン (:) が挿入されます。ブール値パラメータでは、このコロンは省略可能です。次の例では、受信コネクタ "Contoso.com" を無効にしています。
Set-ReceiveConnector "Contoso.com" -Enabled $False
スイッチ パラメータ
スイッチ パラメータは、コマンドの即時実行に対する状態を設定するために Exchange 管理シェルで使用します。この状態はコマンド間は保存されません。スイッチ パラメータはブール値パラメータに似ていますが、用途が異なり、必要な構文も異なっています。スイッチ パラメータに値は必要ありません。既定では、コマンド ラインで値のないスイッチ パラメータを指定すると、パラメータは $True と評価されます。スイッチ パラメータは、ブール値パラメータと同様に、$True (つまり 1) または $False (つまり 0) だけを受け付けます。$True および $False には、ドル記号 ($) が含まれている必要があります。ブール値パラメータとは異なり、スイッチ パラメータの名前とスイッチ値の間にはコロン (:) が必要です。次の最初の例では、EdgeSync 同期の開始を許可する前に確認プロンプトを表示するよう、Exchange 管理シェルに指示しています。2 番目の例では、受信コネクタ "Contoso.com" を削除する前に確認プロンプトを表示しないよう、Exchange 管理シェルに指示しています。
Start-EdgeSynchronization -Confirm
Remove-ReceiveConnector "Contoso.com" -Confirm:$False
共通パラメータ
共通パラメータは、Exchange 管理シェルによってすべてのコマンドに自動的に追加されるパラメータです。これらのパラメータは、実行の対象となるコマンドと併用できない (またはコマンドが使用できない) 機能を実行します。表 2 は、Exchange 管理シェルで使用できるすべての共通パラメータの一覧です。コマンドレットには、WhatIf、Confirm、ValidateOnly の 3 つの追加パラメータも追加される場合があります。これらの追加パラメータの詳細については、「WhatIf、Confirm、および ValidateOnly パラメータ」を参照してください。
表 2 Exchange 管理シェルの共通パラメータ
| パラメータ名 | 必須かどうか | 種類 | 説明 | ||
|---|---|---|---|---|---|
Verbose |
省略可能 |
System.Boolean |
このパラメータでは、コマンドに操作に関する詳細情報を提供するよう指示します。
|
||
Debug |
省略可能 |
System.Boolean |
このパラメータでは、コマンドに操作に関するプログラマ レベルの詳細を提供するよう指示します。 |
||
ErrorAction |
省略可能 |
System.Enum |
このパラメータでは、エラーが発生したときのコマンドの動作を制御します。値は以下のとおりです。
|
||
ErrorVariable |
省略可能 |
System.String |
このパラメータでは、コマンドが処理中に発生したエラーを格納するために使用する変数の名前を指定します。 |
||
OutVariable |
省略可能 |
System.String |
このパラメータでは、このコマンドから出力されるオブジェクトにコマンドが使用する変数の名前を指定します。これは、コマンドを |
.gif "note")
注 :参照している情報が最新であることを確認したり、他の Exchange Server 2007 ドキュメントを見つけたりするには、Exchange Server TechCenter を参照してください。