4.4.2 Active Directoryオブジェクト検索
機能
この部品は,指定したサーバのActive Directoryに対して,オブジェクトを検索します。検索結果は,出力ファイルのパス(common.outputFilePathプロパティ)に指定したファイルに出力されます。指定したファイルの親フォルダが存在しない場合は,この部品でフォルダを作成します。
この部品が前提とするサーバを次に示します。
・実行対象サーバ
この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。
この部品では,次に示すオブジェクトを検索することができます。
・グループ
・ユーザー
・連絡先
・OU(Organizational Unit)
この部品内のスクリプトでは次に示す処理を行います。
・次のコマンドを実行します。
dsquery
"オブジェクトの種類(Windows.objectTypeプロパティ)の値"
"検索開始ノード(Windows.startNodeプロパティ)の値"
[-name "オブジェクト名(Windows.objectNameプロパティ)の値"]
[-desc "説明(Windows.descriptionプロパティ)の値"]
[-upn "ユーザープリンシパル名(Windows.userPrincipalNameプロパティ)の値"]
-limit "0"
dsqueryコマンドの詳細については,Microsoftのライブラリ内で記載している箇所を参照してください。
この部品のファイル出力例を次に示します。
・出力例
"OU=SampleOU1,OU=testOU,DC=example,DC=co,DC=jp"
"OU=SampleOU2,OU=testOU,DC=example,DC=co,DC=jp"
利用場面
Active Directoryでオブジェクトを検索する場合に使用します。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
(1) Active Directory ドメイン サービス
(2) DNS サーバー
【実行対象サーバの稼働OS】
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
【実行対象サーバ内前提製品の使用条件】
なし。
注意事項
(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) 出力ファイルのパス(common.outputFilePathプロパティ)に出力ファイル名と同名のファイルが既に存在する場合は上書きします。
バージョン
02.00.01
部品のタグ
Gather Active Directory information,Windows,Active Directory
タスクログに表示される部品の名称
adSearchObject
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
21 |
異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知) |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
Windows.objectType |
オブジェクトの種類 |
検索するオブジェクトの種類を指定します。指定可能な値は,"group","user","contact","ou"です。 |
− |
入力 |
○ |
Windows.startNode |
検索開始ノード |
検索を開始するノードを指定します。検索開始ノードには,"forestroot","domainroot",またはドメインの識別名をDC=で始まる形式で指定できます。 |
domainroot |
入力 |
○ |
Windows.objectName |
オブジェクト名 |
検索するオブジェクトの名前を指定します。ワイルドカードとして,"*"を使用できます。 |
− |
入力 |
△ |
Windows.description |
説明 |
検索するオブジェクトの説明を指定します。ワイルドカードとして,"*"を使用できます。 |
− |
入力 |
△ |
Windows.userPrincipalName |
ユーザープリンシパル名 |
検索するオブジェクトのユーザープリンシパル名を指定します。検索するオブジェクトの種類が"user"の場合に指定できます。 |
− |
入力 |
△ |
common.outputFilePath |
出力ファイルのパス |
出力するファイルをフルパスで指定します。 |
− |
入力 |
○ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |