Automate - Configure Just-In-Time ECC Agent Deployment

The material in this document is for informational purposes only. The products it describes are subject to change without prior notice, due to the manufacturer’s continuous development program. Rampiva makes no representations or warranties with respect to this document or with respect to the products described herein. Rampiva shall not be liable for any damages, losses, costs or expenses, direct, indirect or incidental, consequential or special, arising out of, or related to the use of this material or the products described herein.

Introduction

This article outlines the process of configuring ECC server for Rampiva Automate and deploying ECC collections with agent deployment through Rampiva Automate.

Prerequisites 


Instructions

A. Create a Deployable ECC Client MSI

1

Download the ECC Client Installer from the Nuix download page which can be found here: https://download.nuix.com/releases/collection.

Ensure you download the correct ECC Client Installer for your version of ECC and OS.

2

Login to ECC Administrator Console.

3

In the top right, click the three dots.

4

Select Client Deployment… from menu options.

5

Enter the Server URL.

The Server URL is the URL to your ECC server. For example, if my ECC server is hosted on the IP Address 10.5.0.2 then my Server URL would be http://10.5.0.2.

6

Enter the Port.

7

In the Export Settings, Select Embed in a Windows MSI Installer file.

8

Check the option Set installer to include Network Capture Worker.

9

Click Export, choose the ECC Client Installer that was downloaded in Step 1.

10

Navigate to the MSI file in File Explorer and Move the MSI file into a File Share that is available to all Active Directory computers.

 

B. Creating ECC Configuration with Predefined Inputs

1

Login to ECC Administrator Console.

2

On the left side of the window click Configurations.

3

At the top right of the window click the outlined button to create a new configuration.

4

Type Collect Documents for the name of the configuration.

5

Set Simple (single task) for the sequence.

6

In the Scheduling section, select now for start.

7

This step is optional. Click 4. Destination in the numbered list on the left side.

8

This step is optional. Select the type Native Files.

9

Click 5. Custodians & Targets in the numbered list on the left side.

10

On the right hand side click the Add… button.

11

Select Local Path.

12

In this step you will provide the path for each computer to collect from.

Type C:\Users for the local path of the configuration, computers that run a collection using this configuration will collect from this path.

13

Click ok.

C. Mapping Active Directory Users to Computers

1

Login to one of your Active Directory Domain Controllers.

2

Open Active Directory Users and Computers.

3

Navigate to Computers from your domain tree on the left side.

4

Double click the computer that will be assigned a user.

5

At the top of the window, select the Managed By tab.

6

Click the Change… button under the name input field.

7

Enter the name of the user to be assigned to this computer, for example test1.

8

Click Check Names.

9

Click OK.

10

Click OK.

D. Create a ECC Profile with CMD Deployment Settings

1

From the Settings page, select ECC Profiles from the settings tree.

2

Click the Add + button to create a new ECC Profile.

3

Type Deployable ECC Profile for the name of the ECC Profile.

4

Enter the Server URL of the ECC Profile.

5

Type api for the username of the ECC profile.

6

Type defaultPassword1234 for the password of ECC profile.

7

In this step we will enable synchronization with Active Directory, enabling synchronization with Active Directory will enable computers from Active Directory to install the ECC Client before a collection starts and uninstall the ECC Client after an ECC collection finishes.

Toggle Sync with AD.

8

In this step we will decide if ECC Clients will be deployed when a collection starts.

Check Deploy agent before collection.

9

Check Uninstall agent after collection.

10

In this step we will decide what scope the collection can collect from.

Select AD and ECC Items for the collection scope.

11

Check Retry running command if install fails.

12

In this step we will set the timeout for installing/uninstalled ECC Clients.

Type 2 for the Timeout of the ECC profile. The timeout is the amount of time in minutes that a command can run, after the timeout is reach the command is stopped.

13

In this step we will select the Remote Method for installing ECC Clients on remote computer.

Select CMD for the Remote Method.

 

14

Enter the Install Command. The install command will run the specified command on a computer before the ECC collection starts. The default command for installing clients is WinRS https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/winrs. WinRS requires you to have remote management setup for all of your domain computers. For example, Rampiva Automate is installed on domain controller DC01 and I want to install ECC Clients on domain computers CC01 and CC02. The domain controller DC01 and computers CC01 and CC02 will need the WinRM entries required to remotely manage from DC01. Alternatively you can install clients using PsExec https://docs.microsoft.com/en-us/sysinternals/downloads/psexec.


The WinRS command to install clients:

winrs /r:{computer_name} /u:SERVICE_ACCOUNT /p:{password} "msiexec.exe /i PATH_TO_INSTALLER /q /norestart"


The PsExec command to install clients:

PATH_TO_PSEXEC \\{computer_name} -u SERVICE_ACCOUNT -p {password} -nobanner -s msiexec.exe /i PATH_TO_INSTALLER /q /norestart

The SERVICE_ACCOUNT is a domain user used to run commands on remote computers, for example:

RAMPIVA\Administrator

The PATH_TO_INSTALLER is the path to deployable ECC Client Installer, for example:

\\Storage\Installers\ECC_Client_Installer.msi

The PATH_TO_PSEXEC is the path to the PsExec executable, for example:

C:\SysInternals\psexec.exe.

15

Enter the Uninstall Command. The uninstall command will run the specified command on a computer after the ECC collection finishes. The default command for uninstalling clients is WinRS . WinRS requires you to have remote management setup for all of your domain computers. For example, Rampiva Automate is installed on domain controller DC01 and I want to uninstall ECC Clients on domain computers CC01 and CC02. The domain controller DC01 and computers CC01 and CC02 will need the WinRM entries required to remotely manage from DC01. Alternatively you can uninstall clients using PsExec .


The WinRS command to uninstall clients:

winrs /r:{computer_name} /u:SERVICE_ACCOUNT /p:{password} "msiexec.exe /x PATH_TO_INSTALLER /q /norestart"


The PsExec command to uninstall clients:

The SERVICE_ACCOUNT is a domain user used to run commands on remote computers, for example:

RAMPIVA\Administrator

The PATH_TO_INSTALLER is the path to deployable ECC Client Installer, for example:

\\Storage\Installers\ECC_Client_Installer.msi

The PATH_TO_PSEXEC is the path to the PsExec executable, for example:

C:\SysInternals\psexec.exe.

16

Enter the Remote Deployment Password.

17

In the bottom right, click Add Source.