4.4.16 Changing the attribute of the contact in the Active Directory
Function
This plug-in changes the contact attribute for the Active Directory of the specified server.
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
dsmod contact
"value-of-contact-identifier(Windows.contactName-property)"
[-fn "value-of-first-name(Windows.firstName-property)"]
[-mi "value-of-initials(Windows.initial-property)"]
[-ln "value-of-last-name(Windows.lastName-property)"]
[-display "display-name(Windows.displayName-property)"]
[-desc "value-of-explanation(Windows.description-property)"]
[-office "value-of-office(Windows.office-property)"]
[-tel "value-of-telephone-number(Windows.officePhone-property)"]
[-email "value-of-email-address(Windows.emailAddress-property)"]
[-hometel "value-of-home-telephone-number(Windows.homePhone-property)"]
[-pager "value-of-pager-number(Windows.pagerNumber-property)"]
[-mobile "value-of-mobile-telephone-number(Windows.mobilePhone-property)"]
[-fax " value-of-fax-number(Windows.faxNumber-property)"]
[-iptel "value-of-ip-telephone-number(Windows.ipPhone-property)"]
[-title " value-of-position(Windows.title-property)"]
[-dept "value-of-department(Windows.department-property)"]
[-company "value-of-company-name(Windows.company-property)"]
For details of the dsmod contact command, see the relevant sections in the Microsoft library.
Use situation
This plug-in is used to change the contact attribute 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 you specify no value for the plug-in property, the attribute value corresponding to the plug-in property does not change.
Execution privilege
(1) When connecting to the execution server, the user needs to be a member of the Account Operators group, Domain Admins group, or Enterprise Admins group of the Active Directory domain service; and have proper authority.
Version
02.00.00
Plug-in tags
Configure Active Directory,Windows,Active Directory
Plug-in name displayed in the task log
adChangeContactAttribute
Return code
0: Normal
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.contactName |
Identifier of the contact |
Specify an identifier of the contact to add, in a format beginning with CN=. |
-- |
Input |
R |
|
Windows.firstName |
First name |
Specify the first name of the contact. |
-- |
Input |
O |
|
Windows.initial |
Initials |
Specify the initials of the contact. |
-- |
Input |
O |
|
Windows.lastName |
Last name |
Specify the last name of the contact. |
-- |
Input |
O |
|
Windows.displayName |
Display name |
Specify a display name of the contact. |
-- |
Input |
O |
|
Windows.description |
Explanation |
Specify an explanation of the contact. |
-- |
Input |
O |
|
Windows.office |
Office |
Specify an office of the contact. |
-- |
Input |
O |
|
Windows.officePhone |
Telephone number |
Specify a telephone number of the contact. |
-- |
Input |
O |
|
Windows.emailAddress |
Email address |
Specify an email address of the contact. |
-- |
Input |
O |
|
Windows.homePhone |
Home telephone number |
Specify a home telephone number of the contact. |
-- |
Input |
O |
|
Windows.pagerNumber |
Pager number |
Specify a pager number of the contact. |
-- |
Input |
O |
|
Windows.mobilePhone |
Mobile phone number |
Specify a mobile phone number of the contact. |
-- |
Input |
O |
|
Windows.faxNumber |
FAX number |
Specify a FAX number of the contact. |
-- |
Input |
O |
|
Windows.ipPhone |
IP telephone number |
Specify an IP telephone number of the contact. |
-- |
Input |
O |
|
Windows.title |
Position |
Specify a position of the contact. |
-- |
Input |
O |
|
Windows.department |
Department |
Specify a department to which the contact belongs. |
-- |
Input |
O |
|
Windows.company |
Company name |
Specify the name of the company with which the contact works. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |