Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Reference


4.4.15 Add a member to an existing Active Directory group

Function

This plugin can add a member to an existing group on the Active Directory instance of the specified server.

The required server is shown as follows:

- Execution-target server

This is a server on which this plugin runs. The Active Directory instance as described in the prerequisites must have been set up.

This plugin can specify the following objects as users to be added:

- Group

- User

The scripts in this plugin perform the following processing:

- Execute the following command.

dsmod group

group-name (the value of the Windows.groupName property)

-addmbr member-name (the value of the Windows.member property)

For details on the dsmod group command, refer to the descriptions in the Microsoft library.

Use situation

Use this plugin to add a member to an existing group on the Active Directory instance.

Prerequisites

For the most recent information about the prerequisite product in the system, prerequisite products on the execution-target server, and supported OSs for the execution-target server, see the Release Notes.

Prerequisite product in the system:

JP1/Automatic Operation 11-00 or later

Prerequisite products on the execution-target server:

(1) Active Directory domain service

(2) DNS server

Supported OSs for 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 for using the prerequisite products on the execution-target server:

None

Cautions

(1) Do not specify character strings that include a double quotation mark (") or a single quotation mark (') for the properties of the plugin.

Execution privilege

(1) To access the execution-target server, the user must be a member of the Account Operators group of the Active Directory domain service, the Domain Admins group, or the Enterprise Admins group. If the user is not a member of such a group, the user must have an appropriate permission.

Version

02.00.00

Plug-in tags

Configure Active Directory,Windows,Active Directory

Plug-in name displayed in the task log

adAddGroupMember

Return code

0: Normal

21: Error (environmental error) No command found (An error was detected in the component script.)

27: Error (Check with the task log regarding the error details.) Unidentified error

41: Error (error detected in the component) Property not entered (An error was detected in the component 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.groupName

Group identifier

Specify the identifier of the group to be added a member in the format beginning with CN=.

--

Input

R

Windows.member

Member identifier

Specify the identifier of the member to be added to a group in the format beginning with CN=.

--

Input

R

common.returnValue

Return value for the plugin

The return value of this plugin stored.

--

Output

O