4.4.8 Acquiring a UPN list in the Active Directory
Function
This plug-in acquires a list of user principal names for the user registered within the specified domain for the Active Directory of the specified server. The acquisition result is output to the file specified in the output path (common.outputFilePath property). If no parent folder exists for the specified file, this plug-in creates that folder.
The prerequisite server for this plug-in is as follows:
- Execution target server
This server is used as the target for executing this plug-in. The Active Directory shown in the Prerequisite condition needs to be set up beforehand.
Scripts in this plug-in perform the following processing:
- Execution of the following command
csvde
-d "value-of-domain-id(Windows.domainName-property)"
[-t "value-of-port-number-for-connecting-Active-Directory(Windows.portNumber-property)"]
-f "value-of-output-file-path(common.outputFilePath-property)"
-l "DN,userPrincipalName"
-r "objectclass=user"
For details of the csvde command, see the relevant sections in the Microsoft library.
The following is a file output example for this plug-in:
- Output example
DN,userPrincipalName
"CN=Administrator,CN=Users,DC=example,DC=co,DC=jp",
"CN=Guest,CN=Users,DC=example,DC=co,DC=jp",guest@example.co.jp
Use situation
This plug-in is used to acquire a list of user principal names for the user registered in the domain specified in the Active Directory.
Prerequisites
For the latest support status of the following items, see the Release notes: Prerequisite product within the system, prerequisite products on the execution target server, and running OS on the execution target server.
Prerequisite product within the system:
- JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution target server:
(1) Active Directory domain service
(2) DNS server
Running OS on the execution target server:
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
Conditions of using prerequisite products on the execution target server:
None
Cautions
(1) Do not use a character string containing a double quotation mark (") or a single quotation mark (') in a plug-in property.
(2) If a file is already specified for the output file path (common.outputFilePath property), that file is overwritten.
Execution privilege
(1) A user who wants to connect to the execution server must have the administrator privilege.
Version
02.00.00
Plug-in tags
Gather Active Directory information,Windows,Active Directory
Plug-in name displayed in the task log
adGetUPN
Return code
0: Normal
12: Abnormal (user mistake), illegal property
21: Abnormal (illegal environment), command unfound (error detected in plug-in script)
27: Abnormal (Check the error details from the task log.)
41: Abnormal (error detected within the plug-in), property not entered (error detected in the plug-in script)
Property list
The following table lists the properties:
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
Windows.domainName |
Domain Identifier |
Specify an identifier of the domain for which you want to acquire a user principal name list, in a format beginning with DC=. |
-- |
Input |
R |
Windows.portNumber |
Port number for connecting the Active Directory |
Specify a port number for connecting the Active Directory. By default, the LDAP port number is used for connection. |
389 |
Input |
O |
common.outputFilePath |
Output file path |
Specify an output file by using a full path. |
-- |
Input |
R |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |