Remedy - Server - [ ARS v.8.1.x and 9.x ] How to configure the LDAP plugins in a separate plugin server?

Version 3
    Share:|

    This document contains official content from the BMC Software Knowledge Base. It is automatically updated when the knowledge article is modified.


    PRODUCT:

    Remedy AR System Server


    COMPONENT:

    AR System


    APPLIES TO:

    Remedy AR System Server v.8.1.x and v.9.x



    QUESTION:

    How to configure the LDAP plugins in a separate plugin server?


    ANSWER:

    Configuring Java LDAP plugins on a separate Plugin Server
    The following steps will guide you through setting up  LDAP plugin server(s) on an AR System where a primary plugin server is already configured and working.
    This document assumes that an existing AR System server and Plugin server are already successfully configured and running with LDAP.
    These steps are written for Windows but the same methodology would apply to Unix/Linux as well. 

    Note: There are some small differences between AR version 8.1.x and version 9.x which will be highlighted in the article.

    Steps
    1- Create a new directory for the LDAP Java Plugin Server under the ..\ARSystem\pluginsvr .directory.
           ....\BMC Software\ARSystem\pluginsvr\LDAP

                   User-added image


    2- Copy the below files from the main ..\ARSystem\pluginsvr into the new created directory  ....\BMC Software\ARSystem\pluginsvr\LDAP
          - ardbcldapplugin{version_build}.jar
          - arealdapplugin{version_build}.jar
          - pluginsvr_config.xml
          - log4j_pluginsvr.xml
          - log4j-1.2.14.jar

         For example In version 8.1.x the jar files are
          -ardbcldapplugin81_build001.jar
          -arealdapplugin81_build001.jar

          And in version 9.1.x the jar files are called:
          -arealdapplugin91_build001.jar
          -ardbcldapplugin91_build001.jar


                   User-added image



    3- Edit the the main pluginsvr_config.xml file from the ..\ARSystem\pluginsvr directory to comment the existing LDAP plugins so these will not be read and loaded by the main Java Plugin server.
        The XML tags to use to do this are <!-- and -->

                   User-added image

        Save the file.

    4- Go to the new created LDAP directory  ....\BMC Software\ARSystem\pluginsvr\LDAP

         a) Edit the log4j_pluginsvr.xml file for the new LDAP Plugin Server.
              Locate the appender called "org.apache.log4j.RollingFileAppender" and set the value to have a log file for the LDAP of your choosing.
              By default is arjavaplugin.log but change it to identify the log generated will be for the LDAP activity, an example is below:

                   User-added image


              Save the file.

         b) Edit the pluginsvr_config.xml file for the new LDAP Plugin Server.
              For AR version 8.1.x and 9.0.x:
                        - Change the port for another available and unused port in the network (for this example we will use port 10000).
                        - Set the numCoreThreads to 10.
                          Example:
                        ............................................
                        <pluginsvr_config>
                                 
    <port>10000</port>
                                  <regPortMapper>false</regPortMapper>
                                  <encryptionPolicy>2</encryptionPolicy>
                                  <publicKeyAlg>4</publicKeyAlg>
                                  <publicKeyExpiry>86400</publicKeyExpiry>
                                  <dataEncryptionAlg>1</dataEncryptionAlg>
                                  <dataKeyExpiry>2700</dataKeyExpiry>
                                 
    <numCoreThreads>10</numCoreThreads>
                                  <numSelectorThreads>2</numSelectorThreads>
                                  <workQueueMonitorLogInterval>0</workQueueMonitorLogInterval>
                                  <workQueueTaskThreshold>5</workQueueTaskThreshold>
                        ............................................


              For AR version 9.1.x
                        - Change the port for another available and unused port in the network (for this example we will use port 10000).
                        - Set the numCoreThreads to 10.
                        - Change the value of the PluginSvrName to note the new port.
                        - Set the logging level to pluginSvrLogFile with the log filename set in the previous step 4a
                        - Set the logging level to DEBUG until it is working properly.
                        - Change the value of pluginSvrAlwaysOnLogName to note the new port.
                          Example:
                        ............................................
                        <pluginsvr_config>
                                 
    <port>10000</port>
                                  <regPortMapper>false</regPortMapper>
                                  <encryptionPolicy>2</encryptionPolicy>
                                  <publicKeyAlg>4</publicKeyAlg>
                                  <publicKeyExpiry>86400</publicKeyExpiry>
                                  <dataEncryptionAlg>1</dataEncryptionAlg>
                                  <dataKeyExpiry>2700</dataKeyExpiry>
                                 
    <numCoreThreads>10</numCoreThreads>
                                  <numSelectorThreads>2</numSelectorThreads>
                                  <workQueueMonitorLogInterval>0</workQueueMonitorLogInterval>
                                  <workQueueTaskThreshold>5</workQueueTaskThreshold>
                                 
    <pluginSvrName>PluginServer_{AR_Server_Name}_10000_IDGAAC47E473VAPHEG6KPGH8UGG4FQ</pluginSvrName>
                                  <reloadDelay>30000</reloadDelay>
                                  <enableNativeBridge>false</enableNativeBridge>
                                  <maxThreads>10</maxThreads>
                                  <excessCoreThreadsIdleKeepAliveTimeInSecond>0</excessCoreThreadsIdleKeepAliveTimeInSecond>
                                  <supportNativePluginHost>false</supportNativePluginHost>
                                  <loadNativePluginHost>false</loadNativePluginHost>
                                  <pluginSvrLogEnable>True</pluginSvrLogEnable>
                                 
    <pluginSvrLogFile>C:/Program Files/BMC Software/ARSystem/ARServer/Db/_LDAP_arjavaplugin.log</pluginSvrLogFile>
                                  <pluginSvrLogLevel>DEBUG</pluginSvrLogLevel>
                                  <pluginSvrLogMaxFileSize>5242880</pluginSvrLogMaxFileSize>
                                  <pluginSvrLogMaxHistory>10</pluginSvrLogMaxHistory>
                                 
    <pluginSvrAlwaysOnLogName>C:\\Program Files\\BMC Software\\ARSystem\\ARServer\\Db\\pluginsvr_{AR_Server_Name}_10000_alwayson.log</pluginSvrAlwaysOnLogName>
                                  <pluginSvrAlwaysOnCopies>20</pluginSvrAlwaysOnCopies>
                                  <pluginSvrAlwaysOnBufferSize>5242880</pluginSvrAlwaysOnBufferSize>
                        ............................................


              For all versions:         
                        - Remove all the plugins between the <plugins>  and </plugins>.
                        - Add the following lines between the <plugins>  and </plugins> tags.  Substitute the correct path to the new LDAP directory and the related jar file(s).
                        ............................................
                                  <plugin>
                                        <name>ARSYS.AREA.AREALDAP</name>
                                        <pathelement type="location">
    C:/Program Files/BMC Software/ARSystem/pluginsvr/LDAP/arealdapplugin{version_build}.jar</pathelement>
                                        <classname>com.bmc.arsys.plugins.arealdap.AREALdapPlugin</classname>
                                  </plugin>
                                  <plugin>
                                        <name>ARSYS.ARDBC.LDAP</name>
                                        <pathelement type="location">
    C:/Program Files/BMC Software/ARSystem/pluginsvr/LDAP/ardbcldapplugin{version_build}.jar</pathelement>
                                        <classname>com.bmc.arsys.plugins.ardbcldap.ARDBCLDAPPlugin</classname>
                                  </plugin>
                        ............................................

              Save the file.
     

    5- Edit the main ar.cfg (Windows) / ar.conf (Unix/Linux) and armonitor.cfg (Windows) / armonitor.conf (Unix/Linux).

         a) Changes in the ar.cfg / ar.conf file.
              Locate the entries for 
                        Server-Plugin-Alias: AREA AREA {AR_SERVER_NAME}:9999
                        Server-Plugin-Alias: ARSYS.ARDBC.LDAP ARSYS.ARDBC.LDAP {AR_SERVER_NAME}:9999

              Comment them by adding # at the start of the line so they will be ignored.

                   User-added image

              Add the exact same parameters but making sure the new port is the one used:

                   User-added image

              Remove any "Plugin:" parameter lines that reference ardbcldap, arealdap, areahub or AREA-Hub-Plugin.  
              None of these will be needed when using Java LDAP.

              Save the file.

         b) Changes in the armonitor.cfg / armonitor.conf file.
              Duplicate the line for the main Java Plugin Server.
              For example:
              --- Version 8.1.x (same applies for v.9.0.x) ---
              "C:\Program Files\Java\jre1.8.0_92\bin\java" -Xmx512m -classpath "C:\Program Files\BMC Software\ARSystem\pluginsvr;C:\Program Files\BMC Software\ARSystem\pluginsvr\arpluginsvr81_build001.jar;
              C:\Program Files\BMC Software\ARSystem\approval\bin\armaskingImpl81_build001.jar;C:\Program Files\BMC Software\ARSystem\arserver\api\lib\arcmnapp81_build001.jar"
              com.bmc.arsys.pluginsvr.ARPluginServerMain -x {AR_SERVER_NAME} -i "C:\Program Files\BMC Software\ARSystem" -m


              --- Version 9.1.x ---
              "C:\Program Files\Java\jre1.8.0_92\bin\java" -Xmx512m -classpath "C:\Program Files\BMC Software\ARSystem\pluginsvr;C:\Program Files\BMC Software\ARSystem\pluginsvr\arpluginsvr91_build001.jar;
              C:\Program Files\BMC Software\ARSystem\approval\bin\armaskingImpl91_build001.jar;C:\Program Files\BMC Software\ARSystem\arserver\api\lib\arcmnapp91_build001.jar"
              com.bmc.arsys.pluginsvr.ARPluginServerMain -x {AR_SERVER_NAME} -i "C:\Program Files\BMC Software\ARSystem" -m


              Locate the -classpath portion which points to the main Java Plugin Server directory and change it to point to the new LDAP directory.
              Also make sure to remove the entries related to the Approval server since it is already being used by the main Java Plugin Server process.
              Example:
              --- Version 8.1.x (same applies for v.9.0.x) ---
              [ Original ]
              "C:\Program Files\Java\jre1.8.0_92\bin\java" -Xmx512m -classpath "C:\Program Files\BMC Software\ARSystem\pluginsvr;C:\Program Files\BMC Software\ARSystem\pluginsvr\arpluginsvr81_build001.jar;
              C:\Program Files\BMC Software\ARSystem\approval\bin\armaskingImpl81_build001.jar;C:\Program Files\BMC Software\ARSystem\arserver\api\lib\arcmnapp81_build001.jar"
              com.bmc.arsys.pluginsvr.ARPluginServerMain -x {AR_SERVER_NAME} -i "C:\Program Files\BMC Software\ARSystem" -m

              [ Modified ]
              "C:\Program Files\Java\jre1.8.0_92\bin\java" -Xmx512m -classpath "C:\Program Files\BMC Software\ARSystem\pluginsvr\LDAP;C:\Program Files\BMC Software\ARSystem\pluginsvr\arpluginsvr81_build001.jar;
              ;C:\Program Files\BMC Software\ARSystem\arserver\api\lib\arcmnapp81_build001.jar" com.bmc.arsys.pluginsvr.ARPluginServerMain -x {AR_SERVER_NAME} -i "C:\Program Files\BMC Software\ARSystem" -m


              Note: this portion was removed: C:\Program Files\BMC Software\ARSystem\approval\bin\armaskingImpl81_build001.jar

              --- Version 9.1.x ---
              [ Original ]
              "C:\Program Files\Java\jre1.8.0_92\bin\java" -Xmx512m -classpath "C:\Program Files\BMC Software\ARSystem\pluginsvr;C:\Program Files\BMC Software\ARSystem\pluginsvr\arpluginsvr91_build001.jar;
              C:\Program Files\BMC Software\ARSystem\approval\bin\armaskingImpl91_build001.jar;C:\Program Files\BMC Software\ARSystem\arserver\api\lib\arcmnapp91_build001.jar"
              com.bmc.arsys.pluginsvr.ARPluginServerMain -x {AR_SERVER_NAME} -i "C:\Program Files\BMC Software\ARSystem" -m

              [ Modified ]
              "C:\Program Files\Java\jre1.8.0_92\bin\java" -Xmx512m -classpath "C:\Program Files\BMC Software\ARSystem\pluginsvr\LDAP;C:\Program Files\BMC Software\ARSystem\pluginsvr\arpluginsvr91_build001.jar;
              ;C:\Program Files\BMC Software\ARSystem\arserver\api\lib\arcmnapp91_build001.jar" com.bmc.arsys.pluginsvr.ARPluginServerMain -x {AR_SERVER_NAME} -i "C:\Program Files\BMC Software\ARSystem" -m


              Note: this portion was removed: C:\Program Files\BMC Software\ARSystem\approval\bin\armaskingImpl91_build001.jar

              You can add a commented line in the armonitor file preceded by # if you want to have a note to know the process in question related to the LDAP plugins but this is totally your choice, for example:

                   User-added image

              Save the file.


    5- A restart of AR System is required for all these changes take effect.

    6- In version 9.1.x we can check the plugin configuration form selecting the Plugin server using the port 1000 and we will see the settings for LDAP Plugins.
         Example:

                   User-added image



    7- Use the Configuration forms for AREA LDAP and ARDBC LDAP to create the correct settings.
         
    8- Configure External Authentication from the EA table of the Server Admin Console.
         This is needed to launch the new Plugin Server and for arserver to read the new Server-Plugin-Alias parameter.

    9- Test  to login using the AREA LDAP to confirm is working as expected.

    10- If testing ARDBDC LDAP,  create a new vendor form using the new ARDBCLDAP Plugin Servers and test the vendor form.

     


    Article Number:

    000130446


    Article Type:

    FAQ/Procedural



      Looking for additional information?    Search BMC Support  or  Browse Knowledge Articles