Get-CsAdUser

 

トピックの最終更新日: 2012-03-23

Active Directory ドメイン サービス (AD DS) にあるすべてのユーザー アカウントに関する情報を戻します。これには、Microsoft Lync Server 2010 で有効なユーザー アカウントと、Lync Server 2010 で有効でないアカウントが含まれます。

構文

Get-CsAdUser [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LDAPFilter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]

解説

Get-CsAdUser を実行すると、Active Directory 内のすべてのユーザー アカウントに関する情報が戻されます。この情報には、Lync Server で有効なユーザー アカウントと有効でないユーザー アカウントの両方が含まれます。Lync Server または以前のバージョンのソフトウェア (Microsoft Office Communications Server 2007 R2 など) で有効なアカウントを持つユーザーの情報のみを戻す Get-CsUser とは、この点が異なります。

コマンドレット Get-CsAdUser および Get-CsUser 間には共通点もありますが、戻される情報の種類が異なります。Get-CsUser を実行すると、通常は、Lync Server と特に関連する Active Directory の属性値が戻されます。たとえば、Get-CsUser は、ユーザーに割り当てられた Lync Server ポリシー、そのユーザーに割り当てられた回線 URI (Uniform Resource Identifier)、およびユーザーがエンタープライズ VoIP に対して有効にされているかどうかを示すことができます。ユーザーの Lync Server が有効でない場合、これらの属性はユーザー アカウントの一部とはなりません。

一方、Get-CsAdUser を実行すると、汎用 Active Directory 属性値が戻されます。つまり、基本的な Active Directory のユーザー アカウントの一部であり、ユーザーが Lync Server で有効であるかどうかに関係なく存在する属性に関する情報が戻されます。たとえば、Get-CsAdUser は、ユーザーの所属する部署や組織、役職、電話番号、会社の住所などの情報を戻します。Get-CsAdUser によって戻されるすべての属性値の一覧を表示するには、Windows PowerShell プロンプトで以下のコマンドを入力します。

Get-CsAdUser | Get-Member

Get-CsAdUser には、コマンドレットの実行時に戻されるユーザーのコレクションをフィルター処理する方法がいくつか用意されています。たとえば、Active Directory の特定のユーザー アカウントが戻されるようにする場合は、Filter や LdapFilter などのオプション パラメーターを適用できます。これらの値は同時に使用することができません。コマンドで Filter を使用する場合は、同じコマンドで LdapFilter を使用することはできません。また逆の場合も同様です。Filter パラメーターを使用すると、戻されるデータは、Lync Server 固有の属性の指定の基準を満たすユーザーに限定されます。たとえば、Filter パラメーターを使用して、Lync Server で有効になっている、または有効になっていないユーザーのコレクションを戻すことができます。LdapFilter パラメーターを使用すると、戻されるデータを、汎用 Active Directory 属性に基づく他の条件に適合するユーザーに限定できます。たとえば、特定の都道府県で勤務しているユーザーや、ポケットベルを持っている (または持っていない) ユーザー、特定の役職のユーザーなどに戻されるデータを限定できます。

Get-CsAdUser コマンドレットで注意しなければならないのは、ユーザーが Lync Server に対して有効かどうかを判断する Enabled 属性がブール値であるにもかかわらず、このプロパティには次の 3 つの値があるという点です。

True。ユーザーが Lync Server に対して有効です。

False。ユーザーの Lync Server アカウントが一時的に無効です。これを実行するには、通常、Set-CsUser コマンドレットを使用して、Enabled パラメーターを $False に設定します。

Null。ユーザーが Lync Server に対して有効になっていません。

つまり、Lync Server に対して有効になっていないユーザーの一覧を戻すには、Enabled 属性が null のユーザーすべてを戻すコマンドを使用する必要があります。

Get-CsAdUser -Filter {Enabled –eq $Null}

一方、次のコマンドは、Lync Server アカウントが一時的に無効になっているユーザーのみを戻します。

Get-CsAdUser -Filter {Enabled -eq $False}

上記のコマンドで、Lync Server に対して有効になっていないユーザーが戻されることはありません。

このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが Get-CsAdUser コマンドレットをローカルで実行することを承認されています。RTCUniversalUserAdmins、RTCUniversalServerAdmins、RTCUniversalReadOnlyAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsAdUser"}

パラメーター

パラメーター 必須かどうか 説明

Identity

省略可能

UserID パラメーター

取得するユーザー アカウントの 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-CsAdUser コマンドレットを実行できます。これは、Windows へのログオン時に使用したアカウントが、ユーザー オブジェクトの使用に必要な権限を持たない場合に、必要となる可能性があります。

Credential パラメーターを使用するには、まず、Get-Credential コマンドレットを使用して、PSCredential オブジェクトを作成する必要があります。詳細については、Get-Credential のヘルプ トピックを参照してください。

DomainController

省略可能

文字列

指定したドメイン コントローラーに接続して、ユーザー情報を取得できます。特定のドメイン コントローラーに接続するには、DomainController パラメーターを含めて、続けて完全修飾ドメイン名 (FQDN) (たとえば、atl-cs-001.litwareinc.com) を指定します。

Filter

省略可能

文字列

Lync Server 固有の属性をフィルター処理することで、戻されるデータを制限できます。

Filter パラメーターは、Where-Object コマンドレットと同じ Windows PowerShell フィルター処理構文を使用します。たとえば、Lync Server が有効になっていないユーザーのみを戻すフィルターは、{Enabled -ne $True} のようになります。ここで、Enabled は Active Directory 属性を、-ne は比較演算子 (等しくない) を、$True (組み込みの Windows PowerShell 変数) は値 True を表します。

LdapFilter

省略可能

文字列

汎用の Active Directory 属性 (つまり、Lync Server 固有ではない属性) をフィルター処理することで、戻されるデータを制限できます。たとえば、特定の部署に勤務していたり、特定のマネージャーや役職を持っていたりするユーザーに戻されるデータを制限できます。

LdapFilter パラメーターでは、フィルターの作成時に LDAP クエリ言語を使用します。たとえば、Redmond 市で勤務しているユーザーのみを戻すフィルターは "l=Redmond" のようになります。ここで、"l" (小文字のエル) は Active Directory 属性 (地域) を、"=" は比較演算子 (と等しい) を、"Redmond" はフィルター値を表します。

OU

省略可能

識別名

特定の Active Directory 組織単位 (OU) またはコンテナーからユーザーを戻すことができます。このパラメーターを使用すると、指定の OU およびそのすべての子 OU からデータが戻されます。たとえば、財務 OU に AccountsPayable と AccountsReceivable という 2 つの子 OU がある場合、これら 3 つの OU のデータがそれぞれ戻されます。

OU を指定する際には、そのコンテナーの識別名 (DN) を使用します。次に例を示します。OU=Finance,dc=litwareinc,dc=comユーザー コンテナーからユーザーを戻すには、次の構文を使用します。cn=Users,dc=litwareinc,dc=com。

ResultSize

省略可能

整数

このコマンドレットによって戻されるレコード数を制限できます。たとえば (フォレスト内のユーザー数に関わらず) 7 ユーザーを戻すには、ResultSize パラメーターを追加してパラメーター値を 7 に設定します。必ずしも 7 ユーザーが戻されるわけではないので注意してください。

結果サイズは、0 ~ 2147483647 の範囲の整数に設定できます。0 に設定すると、コマンドは実行されますが、データは戻りません。フォレスト内に 3 ユーザーしかいない場合は、ResultSize を 7 に設定しても、その 3 ユーザーが戻され、エラーなしでコマンドが完了します。

入力の種類

文字列。Get-CsAdUser は、Active Directory ユーザー アカウントの Identity を表す、パイプライン処理された文字列値を受け入れます。

戻り値の種類

Get-CsAdUser を実行すると、Microsoft.Rtc.Management.ADConnect.Schema.CSADUser オブジェクトのインスタンスが戻されます。

-------------------------- 例 1 --------------------------

Get-CsAdUser

例 1 のコマンドを実行すると、Active Directory のドメイン内における全ユーザー アカウントのコレクションが戻されます。

-------------------------- 例 2 --------------------------

Get-CsAdUser -Identity "Pilar Ackerman"

例 2 では、Get-CsAdUser を実行して Pilar Ackerman のユーザー アカウント情報を戻しています。この例では、ユーザーの表示名がユーザーの Identity を指定するために使用されています。

-------------------------- 例 3 --------------------------

Get-CsAdUser -OU "ou=Finance,dc=litwareinc,dc=com"

例 3 では、財務組織単位内のすべてのユーザーユーザー アカウント情報を戻します。このタスクを実行するには、OU の DN を OU パラメーターに渡す必要があります。

-------------------------- 例 4 --------------------------

Get-CsAdUser -Filter {Enabled -ne $True} | Select-Object DisplayName

上記のコマンドでは、Lync Server 2010 または Office Communications Server で有効になっていないすべてのユーザーが戻されます。これを実行するため、Filter パラメーターを Get-CsAdUser で使用して、戻されるデータを、Enabled プロパティが True と等しくないユーザー アカウントに制限します。このフィルターを設定して Get-CsAdUser を実行すると、Lync Server または Office Communications Server で使用できないユーザー アカウントのみが戻されます。データの取得後、この情報は Select-Object コマンドレットにパイプ処理され、実際に画面上に表示されるプロパティ (この場合は DisplayName) のみが識別されます。

-------------------------- 例 5 --------------------------

Get-CsAdUser -LdapFilter "Department=Finance"

例 5 では、LdapFilter パラメーターを使用して、戻されるデータを財務部門で働くユーザーに限定します。この処理を行うため、LDAP のフィルター値として "Department=Finance" を使用しています。

関連項目

その他のリソース

Get-CsUser