SecurEnds Agent Deployment
5 article
Updating the Generic Agent
Last Updated: January 18, 2022Uninstalling the Old Generic Agent Access the server that the agent was originally installed Open command prompt as an Admin Change directory to the “C:\securends” folder Type “Generic_Agent.exe stop” to stop the service. Once stopped, type “Generic_Agent.exe uninstall” and hit enter to execute This will uninstall the current GA service Installing the Updated Generic Agent Files Open a file explorer and navigate to the “C:\securends” folder Open an additional file explorer and navigate to the downloaded “SecurEnds-GA_XXXX_DD-MMM-YYYY.zip” files File names, dates and versions will vary Within this folder there will be three files: Generic_Agent.xml Generic_Agent.bat Generic_Agent-v2.NNN.jar Copy these three files across to the “C:\securends” folder The “Generic_Agent.xml” and “Generic_Agent.bat” files will replace the existing files, and the “Generic_Agent-v2.NNN.jar” will copy over without replacing an existing file OPTIONAL Delete the “Generic_agent-v2.NNN.jar” file that exists within the “C:\securends” folder (the most up to date version of the JAR file will be used so this isn’t required but is recommended for housekeeping) Installing and Running the New Generic Agent Navigate back to the command prompt (reopen and run as Admin if required) From the “C:\securends” directory, type “Generic_Agent.bat” and hit enter to execute This will execute the batch file to update the configuration variables Once that is complete, type “Generic_Agent.exe install” to install the service Once that is complete, type “Generic_Agent.exe start” to start the service Open a Services window and confirm the “Generic Agent” service remains running for 1 – 2 minutes
Overview
Last Updated: January 3, 2022SecurEnd deploys the Generic Agent to function within your organization’s on premise environment to connect with your on-premise applications. The agent is housed in a docker container and is installed to communicate between your organization’s on premise and our cloud environment. Customers with any Active Directory with Single Domain, Tree, or Forest will likely require Generic Agent deployment(s). Utilizing our generic agent allows your on premise data to be securely brought into the cloud. LDAP protocol is used to communicate with Active Directory on port 389 and requests data to be extracted as an encrypted (AES 256) CSV format file. The encrypted file is then pushed to controller through Secure Port 443 to the SecurEnds Web/SAAS App. Most organization’s use their on-premises databases (ex. Active Directory) as a System of Record within SecurEnds to compare matches, conduct reviews and check identity accesses across other applications. The SecurEnds UI shows that the remote Agent Status is not working as shown below. What do I do? If you see that the on-premises Active Directory or Database Flex connector applications are not syncing, you should check the status of the remote Agent. (Administration->Generic Agent Status). The agent should be restarted. Go to the server where the agent is installed. Click on Windows and search for services. With the list of services, search for generic agent. Right click on the service and restart the GA. Deploying the agent has certain requirements found within this help center.
Deployment Prerequisites
Last Updated: May 28, 2021Hardware Requirements OS: Windows Server 2012 R2 or higher Minimum system memory : 8 GB RAM Hard Disk : 100 GB Software Requirements JDK 1.8 White List Ports The ports may vary from customer to customer due to variances in Active Directory environments and/or choices on which port the Generic Agent will be installed on, but these are the baseline that will need to be whitelisted by default: https://client_name.securends.com/login Outbound Ports: 443 and 8082 443: Secure outbound communication to SecurEnds web applications. 8082: Port for Generic Agent to be installed on. Please specify another port if 8082 is not available. White List IP Addresses Client’s SecurEnds instance IP addresses will also need to be whitelisted to allow communication. Contact SecurEnds for your instance IPs.
Installation
Last Updated: October 5, 2021Step 1: Generic Agent Files Download the files from the password Encrypted URL which will be provided to you by SecurEnds Implementation Consultant, and place it in the C: drive of the appropriate server/machine. Rename the folder to “securends“ The URL hosts a .zip folder and contains the below files: ssl folder ( has SSL Certificate ) Generic_Agent-vx.xx.jar Generic_Agent.bat Generic_Agent.exe Generic_Agent.xml jdk-8u191-windows-x64.exe (optional) npp.7.6.6.Installer.exe (optional) Step 2: Verify Java Version Open a command prompt by clicking Windows + R, then type cmd and click enter. Type in “java –version” The Java version should be 1.8. If the server/machine does not have Java installed or Java 1.8, access the link below to download & install java in Windows and check the Java version again to verify. https://java.com/en/download/help/windows_manual_download.xml Note: Make certain you have the administrative privileges required for installation on your system. Step 3: Configuration Navigate to the Generic_Agent.bat in the Generic_Agent folder and modify the following parameters”: Change the below port, If you want run the agent on different port. GENERIC_AGENT_PORT “8082” Change the below paths if they are different. GENERIC_AGENT_LOG “C:/securends/logs/GenericAgent/genericAgent.log” JAR_FILE_PATH “C:/securends/jar/” GSUITE_PKFILE_PATH “C:/securends/ssl/securendsuar-278414-ea94f99f7ee1.p12” PKS_FILE_PATH “C:/securends/ssl/” Save the Generic_Agent.bat file. Open Windows command prompt in Administrator mode. Navigate to the Generic Agent folder path and select Generic_Agent.bat 5. Click enter to add the environment variables. Step 4: Installation To install Generic Agent as windows service, Run the below commands. Navigate to the Generic Agent folder path and select Generic_Agent.exe Generic_Agent.exe install (To install service) Generic_Agent.exe start (To start Generic Agent Service ) Generic_Agent.exe stop (To stop Generic Agent Service ) Generic_Agent.exe uninstall (To uninstall Generic Agent Service) Step 5: Validate Check the install generic agent service in Windows Services. Confirm the generic agent is installed and have “Running” status. Additional Generic Agent Installs Multiple Generic Agent installs, click here.
Installation for Multiple Domains
Last Updated: March 8, 2022Step 1 Download the files from the password Encrypted URL provided to you by SecurEnds Implementation Consultant OR copy them from an existing Generic Agent folder if a Generic Agent has already been setup for a domain. The URL hosts a .zip folder and contains the below files: ssl folder ( has SSL Certificate ) Generic_Agent-vx.xx.jar Generic_Agent.bat Generic_Agent.exe Generic_Agent.xml jdk-8u191-windows-x64.exe (optional) npp.7.6.6.Installer.exe (optional) Note: Make certain you have the administrative privileges required for installation on your system. Access the link below to download & install java in Windows. https://java.com/en/download/help/windows_manual_download.xml Step 2 Once installation is complete, check the Java Version on your system, opening a command prompt by clicking Windows + R. Then, type cmd and click enter. Then, type java –version Step 3 Open Generic_Agent folder containing all the files Edit the Generic_Agent.bat file and modify the below parameters. Change the below port, If you want run the agent on different port. GENERIC_AGENT_PORT “8082” Change the below paths if they are different. GENERIC_AGENT_LOG “E:/securends/logs/GenericAgent/genericAgent.log” JAR_FILE_PATH “E:/securends/jar/” GSUITE_PKFILE_PATH “E:/securends/ssl/securendsuar-278414-ea94f99f7ee1.p12” PKS_FILE_PATH “E:/securends/ssl/” Modify the JAR_LOCATION parameter with a unique value (ie. “sedayforce”) A unique JAR_LOCATION value is needed for each Active Directory domain. Provide the JAR_LOCATION values to SecurEnds. Open Windows command prompt in Administrator mode. Navigate to the Generic Agent folder path and select Generic_Agent.bat 5. Click enter to add the environment variables. Step 4 To install Generic Agent as windows service, Run the below commands. Navigate to the Generic Agent folder path and select Generic_Agent.exe Generic_Agent.exe install (To install service) Generic_Agent.exe start (To start Generic Agent Service ) Generic_Agent.exe stop (To stop Generic Agent Service ) Generic_Agent.exe uninstall (To uninstall Generic Agent Service) Step 5 Check the install generic agent service in Windows Services.
