Get-CsUser
トピックの最終更新日: 2012-03-23
Microsoft Lync Server 2010 または以前のバージョンのソフトウェア (Microsoft Office Communications Server 2007 R2 など) が有効な、組織内のすべてのユーザーに関する情報を戻します。
構文
Get-CsUser [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LdapFilter <String>] [-OnLyncServer <SwitchParameter>] [-OnOfficeCommunicationServer <SwitchParameter>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>] [-UnAssignedUser <SwitchParameter>]
解説
コマンドレット Get-CsAdUser と Get-CsUser を併せて使用すると、Active Directory のすべてのユーザー アカウントに関する詳細な情報を戻すことができます。Get-CsAdUser を実行すると、Lync Server 2010 または Office Communications Server が有効なユーザーと Lync Server または Office Communications Server が有効ではないユーザーの両方のユーザーを含め、すべてのユーザー アカウントに関する情報が戻されます。これは、Lync Server または Office Communications Server が有効なアカウントを持つユーザーの情報のみ戻される Get-CsUser とは異なります。
この 2 つの間には共通点もありますが、Get-CsUser と Get-CsAdUser では、戻される情報の種類が異なります。Get-CsUser を実行すると、通常は、Lync Server と特に関連する Active Directory の属性値が戻されます。たとえば、Get-CsUser を実行すると、ユーザーに割り当てられている Lync Server ポリシー、ユーザーに割り当てられている回線の Uniform Resource Identifier (URI) と、回線サーバーの URI、ユーザーのエンタープライズ VoIP が有効であるかどうかなどの情報が戻されます。ユーザーの Lync Server が有効でない場合、これらの属性はユーザー アカウントの一部とはなりません。
一方、Get-CsAdUser を実行すると、Active Directory の汎用の属性値が戻されます。これらの属性は、基本的な Active Directory のユーザー アカウントの一部であり、ユーザーが Lync Server で有効であるかどうかに関係なく表示されます。たとえば、Get-CsAdUser を実行すると、ユーザーの所属する部署や組織、役職、電話番号、会社の住所などの情報が戻されます。
Get-CsUser によって戻されるすべての属性値の一覧を表示するには、Windows PowerShell コマンド プロンプトで以下のコマンドを入力します。
Get-CsUser | Get-Member
Get-CsUser を実行すると、さまざまな方法で、コマンドレットの実行時に実際に戻されるユーザーのコレクションをフィルター処理できます。たとえば、Lync Server のすべてのユーザー アカウントを戻す必要がない場合は、Filter パラメーターや LDAPFilter パラメーターなどのオプション パラメーターを適用できます(これらのパラメーターを同時に使用することはできません。コマンドで Filter を使用する場合は、同じコマンドで LDAPFilter を使用することはできません。また逆の場合も同様です)。Filter パラメーターを使用すると、指定した Lync Server の条件に適合するユーザーに戻されるデータを制限できます。たとえば、指定したレジストラー プールにアカウントがあるユーザーのみを戻したり、エンタープライズ VoIP が有効なユーザーのみを戻すことができます。LDAPFilter パラメーターを使用すると、戻されるデータを、Active Directory に基づく他の条件に適合するユーザーに限定できます。たとえば、指定の都道府県で勤務しているユーザーや、ポケットベルを持っている (または持っていない) ユーザー、指定の役職のユーザーなどに戻されるデータを限定できます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが、Get-CsUser コマンドレットをローカルで実行することを承認されています。RTCUniversalUserAdmins、RTCUniversalServerAdmins、RTCUniversalReadOnlyAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsUser\b"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
UserIDParameter |
取得するユーザー アカウントの Identity を指定します。ユーザーの Identity は、以下の 4 つの形式のうちの 1 つを使用して指定できます。1) ユーザーの SIP アドレス、2) ユーザーのユーザー プリンシパル名 (UPN)、3) ドメイン\ログオン形式 (たとえば、litwareinc\kenmyer) のユーザーのドメイン名とログオン名、および 4) ユーザーの Active Directory 表示名 (たとえば、Ken Myer)。ユーザー アカウントは、ユーザーの Active Directory 識別名を使用して参照することもできます。 表示名をユーザーの Identity として使用する場合は、アスタリスク (*) ワイルドカード文字を使用できます。たとえば、"* Smith" という Identity は、末尾が " Smith" という文字列値の表示名を持つすべてのユーザーを戻します。 |
Credential |
省略可能 |
PSCredential オブジェクト |
別の資格情報で Get-CsUser コマンドレットを実行できます。これは、Windows へのログオン時に使用したアカウントが、ユーザー オブジェクトの使用に必要な権限を持たない場合に、必要となる可能性があります。 Credential パラメーターを使用するには、まず、Get-Credential コマンドレットを使用して、PSCredential オブジェクトを作成する必要があります。詳細については、Get-Credential コマンドレットのヘルプ トピックを参照してください。 |
DomainController |
省略可能 |
文字列 |
指定したドメイン コントローラーに接続して、ユーザー情報を取得できます。特定のドメイン コントローラーに接続するには、DomainController パラメーターの後に、完全修飾ドメイン名 (FQDN) (たとえば、atl-cs-001.litwareinc.com) を追加します。 |
Filter |
省略可能 |
文字列 |
Lync Server 固有の属性をフィルター処理することで、戻されるデータを制限できます。たとえば、特定の音声ポリシーに割り当てられている (または割り当てられていない) ユーザーに対する戻されるデータを制限できます。 Filter パラメーターは、Where-Object コマンドレットと同じ Windows PowerShell フィルター処理構文を使用します。たとえば、エンタープライズ VoIP が有効なユーザーのみを戻すフィルターは次のようになります。ここで、EnterpriseVoiceEnabled は Active Directory 属性を、-eq は比較演算子 (等号) を、$True (組み込みの Windows PowerShell 変数) はフィルター値を表します。 {EnterpriseVoiceEnabled -eq $True} |
LDAPFilter |
省略可能 |
文字列 |
汎用の Active Directory 属性 (つまり、Lync Server 固有ではない属性) をフィルター処理することで、戻されるデータを制限できます。たとえば、特定の部署に所属していたり、特定のマネージャーや役職を持っているユーザーに戻されるデータを制限できます。 LDAPFilter パラメーターは、フィルターの作成時に LDAP クエリ言語を使用します。たとえば、Redmond 市内で働くユーザーだけを戻すフィルターは次のようになります。"l=Redmond"。"l" (小文字のエル) は Active Directory 属性 (地域)、"=" は比較演算子 (と等しい)、"Redmond" はフィルター値をそれぞれ表します。 |
OnOfficeCommunicationServer |
省略可能 |
スイッチ パラメーター |
以前のバージョンの Lync Server (Office Communications Server 2007 R2 など) に所属しているユーザーのコレクションが戻されます。このパラメーターを使用する場合、現在のバージョンのソフトウェアでアカウントを持つユーザーは戻されません。 |
OnLyncServer |
省略可能 |
スイッチ パラメーター |
Lync Server 2010 に所属しているユーザーのコレクションが戻されます。このパラメーターを使用する場合、以前のバージョンのソフトウェアでアカウントを持つユーザーは戻されません。 |
OU |
省略可能 |
識別名 |
特定の組織単位 (OU) またはコンテナー内のユーザー アカウントに関する情報を戻すことができます。OU パラメーターにより、指定の OU およびそのすべての子 OU からデータが戻されます。たとえば、財務 OU に AccountsPayable と AccountsReceivable という 2 つの子 OU がある場合、これら 3 つの OU のデータがそれぞれ戻されます。 OU を指定する際には、そのコンテナーの識別名 (DN) を使用します。次に例を示します。-OU "OU=Finance,dc=litwareinc,dc=com"Users コンテナーからユーザー アカウントを戻すには、次の構文を使用します。-OU "cn=Users,dc=litwareinc,dc=com"。 |
ResultSize |
省略可能 |
整数 |
このコマンドレットによって戻されるレコード数を制限できます。たとえば (フォレスト内のユーザー数に関わらず) 7 ユーザーを戻すには、ResultSize パラメーターを追加してパラメーター値を 7 に設定します。必ずしも 7 ユーザーが戻されるわけではないことに注意してください。 結果サイズは、0 ～ 2147483647 の範囲の整数に設定できます。0 に設定すると、コマンドは実行されますが、データは戻りません。フォレスト内に 3 ユーザーしかいない場合は、ResultSize を 7 に設定しても、その 3 ユーザーが戻され、エラーなしでコマンドが完了します。 |
UnassignedUser |
省略可能 |
スイッチ パラメーター |
Lync Server が有効であるが、レジストラー プールに現在割り当てられていない、すべてのユーザーのコレクションを戻すことができます。レジストラー プールに割り当てられていない場合、ユーザーは Lync Server にログオンできません。 |
入力の種類
文字列。Get-CsUser は Lync Server 2010 で有効にされているユーザー アカウントの Identity を表す、パイプライン処理された文字列値を受け入れます
戻り値の種類
Get-CsUser を実行すると、Microsoft.Rtc.Management.ADConnect.Schema.ADUser オブジェクトのインスタンスが戻されます。
例
-------------------------- 例 1 --------------------------
Get-CsUser
上記の例では、Lync Server または Office Communications Server が有効なすべてのドメイン ユーザーのコレクションを戻すために、パラメーターを指定せずに Get-CsUser を呼び出しています。
-------------------------- 例 2 --------------------------
Get-CsUser | Format-Table -Property DisplayName, SipAddress, EnterpriseVoiceEnabled -AutoSize
例 2 では、Get-CsUser が、Lync Server または Office Communications Server が有効なすべてのドメイン ユーザーのコレクションを戻しています。既定では、Get-CsUser を実行すると、所定の状況ではほとんど重要でない非常に多くのプロパティとプロパティ値が戻されます。そのため、この例では、取得したデータを Format-Table コマンドレットにパイプ処理しています。次に、Format-Table により、Property パラメーターを使用して DisplayName、SipAddress、および EnterpriseVoiceEnabled の各プロパティを選択し、これらのプロパティとプロパティ値を表に示します。
-------------------------- 例 3 --------------------------
Get-CsUser -Identity "Pilar Ackerman"
例 3 では、Identity パラメーターを使用して、Pilar Ackerman という Identity (この場合は表示名) を持つユーザー アカウントに、戻されるデータを制限しています。
-------------------------- 例 4 --------------------------
Get-CsUser -Identity "Pilar*"
例 4 では、ユーザーの Identity を指定する際に、ワイルドカード文字 (*) を使用しています。これにより、Get-CsUser を実行すると、先頭が "Pilar" という文字列の Identity を持つすべてのユーザーが戻されます。
-------------------------- 例 5 --------------------------
Get-CsUser -Filter {VoicePolicy -eq $Null}
例 5 のコマンドを実行すると、ユーザーごとの音声ポリシーが割り当てられていないユーザーのコレクションが戻されます。これを行うには、Filter パラメーターの後にフィルター VoicePolicy -eq "$Null を指定します。Get-CsUser で使用するフィルターを構成する場合、プロパティ名 (VoicePolicy) の後に比較演算子 (この場合、"等しい" ことを示す比較演算子 "eq") を指定する必要があります。比較演算子の直後に、テストする値を指定します。この例ではこの値は $Null で、これは Null 値を表す Windows PowerShell 変数です。
音声ポリシーが割り当てられたユーザーのコレクションを戻すには、以下のコマンドを使用します。
Get-CsUser -Filter {VoicePolicy -ne $Null}
-------------------------- 例 6 --------------------------
Get-CsUser -LDAPFilter "Department=Finance"
上記のコマンドでは、LDAPFilter パラメーターを使用して、財務部門に所属するユーザーに戻されるデータを制限しています。これは、LDAP フィルター値 "Department=Finance" を使用して実行します。
-------------------------- 例 7 --------------------------
Get-CsUser -LDAPFilter "&(Department=Finance)(Title=Manager)"
例 7 は、LDAPFilter パラメーターとともに AND クエリを使用する方法を示しています。このクエリ (アンパサンド文字 "&" を使用して AND クエリを表示) で、"Department=Finance" および "Title=Manager" の 2 つの条件を指定しています。このクエリでユーザー アカウントが戻されるためには、ユーザーが財務部門に所属しているという条件とマネージャーであるという条件の両方の条件を満たしている必要があります。
-------------------------- 例 8 --------------------------
Get-CsUser -LdapFilter "|(Title=Supervisor)(Title=Manager)"
例 8 のコマンドでは、LDAPFilter パラメーターで OR クエリ (パイプ シンボル "|" で表示) を使用しています。例 7 の AND クエリでは、ユーザー アカウントが戻されるためには、両方の条件を満たしている必要がありました。OR クエリでは、アカウントが戻されるためには、1 つの条件のみ満たしている必要があります。この場合、ユーザーが責任者であるかユーザーがマネージャーである場合に、ユーザー アカウントが戻されます。
-------------------------- 例 9 --------------------------
Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com"
例 9 では、財務 OU にアカウントを持つすべてのユーザーのユーザー アカウント情報が戻されます。
-------------------------- 例 10 --------------------------
Get-CsUser -UnassignedUser
上記のコマンドを実行すると、Lync Server または Office Communications Server が有効であるが、レジストラー プールに現在割り当てられていないすべてのユーザーのコレクションが戻されます。