Get-CsAnalogDevice
トピックの最終更新日: 2012-03-23
Microsoft Lync Server 2010 で管理できる、アナログ デバイスの情報を戻します。アナログ デバイスとは、公衆交換電話網に接続された電話機などのデバイスです。
構文
Get-CsAnalogDevice [-Identity] <UserIdParameter>] [-Filter <String>] [-LdapFilter <String>] [-OU <OUIdParameter>] [-DomainController <Fqdn>] [-Credential <PSCredential>] [-ResultSize <Unlimited`1>] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>]
解説
アナログ デバイスには、公衆交換電話網 (PSTN) に接続された電話機、FAX 機、モデム、テレタイプ/聴覚障碍者用文字電話機 (TTY/TDD) などのデバイスがあります。エンタープライズ VoIP (マイクロソフトが提供しているボイス オーバー IP (VoIP)) を利用できるデバイスと異なり、アナログ デバイスはデジタル パケットによる情報送信を行いません。代わりに、連続信号を使用して情報を送信します。"アナログ デバイス" という用語は、この信号が一般にアナログ信号と呼ばれていることに由来します。
アナログ電話機、エンタープライズ VoIP 対応電話機以外の種類の電話機として、非 IP デジタル電話機があります。これはセットで購入する構内交換機 (PBX) システム専用の電話機で、Lync Server 2010 コマンドレットを使って管理することはできません。
Lync Server 2010 では、管理者が組織のアナログ デバイスを管理できるようにするために、アナログ デバイスを Active Directory の連絡先オブジェクトに関連付けることができます。デバイスを連絡先オブジェクトに関連付けた後、連絡先に対するポリシーやダイヤル プランの割り当てなどを行って、アナログ デバイスを管理することができます。
Get-CsAnalogDevice コマンドレットでは、組織内で使用するために構成したアナログ デバイスの情報を取得できます。Get-CsAnalogDevice をパラメーターを指定せずに呼び出すと、すべてのアナログ デバイスの情報が戻ります。オプション パラメーターを指定することにより、さまざまな方法で情報を絞り込むことができます。たとえば、特定の OU 内の連絡先オブジェクトを持つすべてのデバイスを戻したり、特定の建物内にあるすべてのアナログ デバイスを戻したりできます。
このコマンドレットを実行できるユーザー: 既定では、Get-CsAnalogDevice コマンドレットをローカルで実行する権限があるのは、RTCUniversalUserAdmins、RTCUniversalServerAdmins、および RTCUniversalReadOnlyAdmins グループのメンバーです。このコマンドを特定のサイトまたは Active Directory OU に対して実行する権限は、Grant-CsOUPermission コマンドレットを使って割り当てることができます。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsAnalogDevice"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
ユーザー ID パラメーター |
アナログ デバイスの一意の識別子です。アナログ デバイスは、関連付けられた連絡先オブジェクトの Active Directory 識別名によって識別されます。既定では、アナログ デバイスは GUID (グローバル一意識別子) を共通名として使用します。したがって、各デバイスの Identity は一般的に次のようになります。CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com。 |
Credential |
省略可能 |
PS 資格情報オブジェクト |
Get-CsAnalogDevice コマンドレットを別の資格情報で実行できます。これは、Windows へのログオン時に使用したアカウントが、連絡先オブジェクトの使用に必要な権限を持たない場合に、必要となる可能性があります。 Credential パラメーターを使用するには、まず Get-Credential コマンドレットを使用して、PSCredential オブジェクトを作成します。詳細については、Get-Credential コマンドレットのヘルプ トピックを参照してください。 |
DomainController |
省略可能 |
文字列 |
指定したドメイン コントローラーに接続して、連絡先情報を取得できます。特定のドメイン コントローラーに接続するには、DomainController パラメーターの後に、コンピューターの完全修飾ドメイン名 (FQDN) (atl-cs-001.litwareinc.com など) を指定します。 |
Filter |
省略可能 |
文字列 |
Lync Server 2010 固有の属性をフィルター処理することで、戻りデータを制限できます。たとえば、返りデータを、特定の音声ポリシーに割り当てられている (または割り当てられていない) アナログ デバイスの連絡先オブジェクトに制限することができます。 Filter パラメーターは、Where-Object コマンドレットと同じ Windows PowerShell フィルター処理構文を使用します。たとえば、FAX 機のみを戻すフィルターは次のようになります。ここで、AnalogFax は Active Directory 属性を、-eq は比較演算子 (等号) を、$True (組み込みの Windows PowerShell 変数) はフィルター値を表します。 -Filter {AnalogFax -eq $True} |
LdapFilter |
省略可能 |
文字列 |
Active Directory の一般の属性 (つまり、Lync Server 2010 固有ではない属性) をフィルタリングして、返りデータを限定できます。たとえば、返りデータを特定の組織に割り当てられた、または特定の建物にある連絡先オブジェクトに制限することができます。 LdapFilter パラメーターでは、LDAP クエリ言語を使ってフィルターを作成します。たとえば、Redmond 市内のアナログ デバイスを表す連絡先オブジェクトだけを戻すフィルターは次のようになります。 -LdapFilter "l=Redmond" このフィルターの "l" は Active Directory 属性 (ローカリティ)、"=" は比較演算子 (等しい)、"Redmond" はフィルター値を表します。 |
OU |
省略可能 |
Active Directory の識別名 |
特定の Active Directory 組織単位 (OU) の連絡先オブジェクトを戻すことができます。これにより、指定の OU およびそのすべての子 OU からデータが戻されます。たとえば、財務 OU に AccountsPayable と AccountsReceivable という 2 つの子 OU がある場合、これらの各 OU からアナログ デバイスの情報が戻されます。 OU 指定時には、該当コンテナーの識別名を使用します。次に例を示します。-OU "OU=Finance,dc=litwareinc,dc=com"。 |
ResultSize |
省略可能 |
整数 |
このコマンドによって戻されるレコード数を制限できます。たとえば、(フォレスト内にいくつのアナログ デバイスがあるかに関係なく) 7 つのアナログ デバイスを戻す場合は、ResultSize パラメーターを指定して、パラメーター値を 7 に設定します。ただし、どの 7 つの電話機を戻すかを指定する方法はありません。フォレスト内に 3 つのアナログ デバイスしかない場合は、ResultSize を 7 に設定しても、その 3 つのデバイスが戻され、エラーなしでコマンドが完了します。 結果サイズは、0 ～ 2147483647 の範囲の整数に設定できます。0 に設定すると、コマンドは実行されますが、データは戻りません。 |
入力の種類
文字列。Get-CsAnalogDevice は、アナログ デバイスの Identity を表す文字列値を、パイプ処理で受け入れます。
戻り値の種類
Get-CsAnalogDevice は、Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact オブジェクトのインスタンスを戻します。
例
-------------------------- 例 1 ------------------------
Get-CsAnalogDevice
例 1 に示すコマンドは、組織で使用するために現在構成されているすべてのアナログ デバイスのコレクションを戻します。Get-CsAnalogDevice をパラメーターを指定せずに呼び出すことで、これを実行しています。
-------------------------- 例 2 ------------------------
Get-CsAnalogDevice | Select-Object DisplayName, LineUri
例 2 では、組織内のすべてのアナログ デバイスの DisplayName および LineUri の 2 つのプロパティ値のみが戻されます。このタスクを実行するため、まず Get-CsAnalogDevice をパラメーターを指定せずに呼び出し、組織内のすべてのアナログ デバイスのプロパティ値すべてを戻します。次に、このコレクションを Select-Object コマンドレットへパイプ処理し、DisplayName および LineUri プロパティの値のみを選択して表示します。
-------------------------- 例 3 ------------------------
Get-CsAnalogDevice -Filter {DisplayName -eq "Building 14 Receptionist"}
例 3 は、Active Directory 表示名が "Building 14 Receptionist" であるアナログ デバイスの情報を戻します。これを行うため、Get-CsAnalogDevice に Filter パラメーターを指定して呼び出します。フィルター値 {DisplayName -eq "Building 14 Receptionist"} により、DisplayName プロパティが "Building 14 Receptionist" に等しいアナログ デバイスの項目のみが戻るようにします。
-------------------------- 例 4 ------------------------
Get-CsAnalogDevice -Filter {Gateway -eq "192.168.0.240"}
このコマンドは、ゲートウェイ 192.168.0.240 に対して構成されているアナログ デバイスをすべて戻します。これを実行するため、Get-CsAnalogDevice に Filter パラメーターを指定して呼び出します。フィルター値 "192.168.0.240" により、戻されたオブジェクトを Gateway プロパティが 192.168.0.240 に等しいアナログ デバイス オブジェクトのみが戻るようにします。
-------------------------- 例 5 ------------------------
Get-CsAnalogDevice -Filter {AnalogFax -eq $True}
例 5 に示すコマンドは、組織内のすべてのアナログ FAX 機器に関する情報を戻します。このタスクを実行するため、Get-CsAnalogDevice に Filter パラメーターを指定して呼び出します。フィルター値 {AnalogFax -eq $True} は戻されるオブジェクトを次の FAX 機器に制限します。AnalogFax プロパティが True に等しいアナログ デバイスです。
-------------------------- 例 6 ------------------------
Get-CsAnalogDevice -Filter {LineUri -eq "tel:+14255556001"}
例 6 では、次の 1 つのアナログ デバイスが戻されます。LineUri (電話番号) が +14255556001 に等しいデバイスです。
-------------------------- 例 7 ------------------------
Get-CsAnalogDevice -Filter {LineUri -like "tel:+1425555*"}
例 7 は、市外局番が 425 で市内局番が 555 のアナログ デバイスをすべて戻します。このタスクを実行するため、Get-CsAnalogDevice に Filter パラメーターを指定して使用します。フィルター値 {LineUri -like "tel:+1425555*"} により、LineUri プロパティが "tel:+1425555" という文字列で始まるデバイスのデータのみが戻るようにします。これは 1425555 という数字で始まる電話番号 (たとえば、1-425-555-1298) と同じです。
-------------------------- 例 8 ------------------------
Get-CsAnalogDevice -OU "ou=Telecommunications,dc=litwareinc,dc=com"
このコマンドは、Active Directory ドメイン サービス (AD DS) の Telecommunications OU にある連絡先オブジェクトを持つアナログ デバイスすべてのコレクションを戻します。これを行うため、Get-CsAnalogDevice に OU パラメーターを指定して呼び出します。パラメーター値により、識別名が ou=Telecommunications,dc=litwareinc,dc=com の OU 内に連絡先オブジェクトを持つアナログ デバイス オブジェクトのみが戻るようにします。
-------------------------- 例 9 ------------------------
Get-CsAnalogDevice | Grant-CsVoicePolicy -PolicyName "AnalogVoicePolicy"
例 9 のコマンドは、アナログ デバイスのコレクションを戻し、そのコレクション内の各デバイスに対して音声ポリシーを割り当てる方法を示しています。これを行うため、まず Get-CsAnalogDevice をパラメーターを指定せずに呼び出し、組織内で使用するよう構成されているすべてのアナログ デバイスのコレクションを戻します。次に、このコレクションを Grant-CsVoicePolicy コマンドレットにパイプ処理し、コレクション内の各デバイスに対して、音声ポリシー AnalogVoicePolicy を割り当てています。