Installing CTERA Agent
  • 9 Minutes to read
  • Dark
    Light
  • PDF

Installing CTERA Agent

  • Dark
    Light
  • PDF

Article Summary

You can install a CTERA Agent using one of the following:

Installing a CTERA Agent Using the Setup Wizard

You can install a CTERA Agent using the CTERA Agent Setup Wizard or the msiexec command, described in Installing or Uninstalling CTERA Agent from the command Line.

To install CTERA Agent using the CTERA Agent Setup Wizard:

  1. Double-click the CTERA Agent installation file.
    The CTERA Agent Setup wizard is displayed.
    image.png
  2. Select one of the following:
    Agent per User – The CTERA Agent is installed separately for each user the first time the user logs in to the computer.
    • Each user has an independent CTERA Agent configuration and can connect to a different CTERA Portal.
    • Each user has permission to manage their own CTERA Agent.
    • Each user will have their own cache, not shared with other users.
    Note

    Since each user has an independent CTERA Agent, the CTERA Agents are displayed as separate CTERA Agent objects when connected to a CTERA Portal. Each user is licensed separately.

    Shared Agent for all Users – A single CTERA Agent configuration can be shared by all users of the computer.
  3. Click Next.
  4. Read and agree to the End User License Agreement and then continue to click Next and enter relevant information until the installation starts.
  5. When the installation is complete, click Close.
    A tray icon, image.png, is installed in the Windows taskbar and the Welcome to CTERA Agent window is displayed.
    image.png
    Note

    If the CTERA Agent tray icon is hidden, click the up-arrow in the notification area of the taskbar to display hidden icons.

  6. Enter the CTERA Portal's DNS name or IP address.
    Alternatively, if you want to configure CTERA Agent to connect to the CTERA Portal via a proxy click Advanced. For details, see Setting Up Connection Via a Web Proxy.
  7. Click Continue.
    Note

    If the CTERA Portal does not have a valid certificate installed, a warning is displayed to the end user when logging the agent into the portal, offering the option to proceed anyway.
    image.png

    The sign-in window is displayed unless single sign-on (SSO) has been defined configured and you then use SSO to access the CTERA Agent.
    image.png
  8. In the Username and Password fields, enter your user name and password for accessing the CTERA Portal and click Sign in.
    A message that the login was successful is displayed, the CTERA Agent tray icon changes to image.png.

If the CTERA Agent is not licensed for backup, and only CTERA Drive Share is available, the CTERA Agent window is displayed.
image.png

If the CTERA Agent is licensed for backup, the Your Subscription Includes window is displayed.
image.png

The Your Subscription Includes window shows the services you are subscribed to.

  1. Click Continue.
    The Set Up Your Cloud Backup window is displayed.
    image.png

  2. Optionally, in the Files to Back UP section click Add Files and Folders to add files to be backed up to the cloud.

    Note

    You can create or change the list of folders and files to backup later.

    The Files to Backup window is displayed.
    image.png

    1. Select the files you want to backup.
      • To select specific folders, expand the folder tree in the left pane, then make sure only the folders you want are checked.
      • To select individual files in a folder, select the folder in the left pane and then select the individual files in the right pane.
    2. Click Save.
  3. Optionally, in the Schedule section, click Change to override portal settings and configure a schedule for automatic cloud backup.

    Note

    You can create or change the schedule later.

    The Backup Schedule window is displayed.

    Windows PCWindows Server
    image.pngimage.png
    1. Complete the Backup Schedule fields.
      Periodically – Automatic backups are performed every specified number of hours or minutes.
      • Start Every – The interval between backups.
        Note

        If a given backup extends past the scheduled time for the next automatic backup, the next automatic backup will commence immediately upon completion of the prior backup.

      Specific Time – Automatic backups are performed at a specified time on one or more specified days.
      • Start Time – The time at which a backup starts.
      • Stop Time – Either on completion of the backup or at a specific time, after which the backup is stopped even if it hasn’t completed.
      • On Days – The days backups occur. Click Every Day to backup every day.
      Note

      When the agent is installed on a Windows Server, an option is displayed, Transaction Log Backup, for backing up Microsofty SQL Server. This option is currently not supported.

    2. Click Save.
  4. Optionally, secure the backup folder with your own secret passphrase. In the Encryption section click Change. By default, CTERA Agent will use an automatically generated encryption key to protect the backup folder.

    Note

    You can only set the passphrase when setting up the cloud backup for the first time.

    The Initialization Required window is displayed.
    image.png

    1. Select Use my own secret passphrase, enter the desired passphrase in the Secret Passphrase and Retype Passphrase fields. The passphrase must contain at least one, letter, one digit, and one special character.
    2. Click Save.

    If you later sign out and sign your agent into CTERA Portal, you will need to enter this passphrase.

  5. Click All Done!
    The CTERA Agent screen is displayed.
    image.png

Installing or Uninstalling CTERA Agent from the command Line

To install CTERA Agent using msiexec:

  • Run the following command: msiexec /i agent-install.msi AGENTMODEBUTTON=0|1 /qn
    where:
    agent-install.msi is the CTERA Agent installation msi file.
    AGENTMODEBUTTON determines whether to install in a single instance for all users (x=0) or a CTERA Agent per user (x=1).
    /qn means that the UI level is set to no UI.

To uninstall CTERA Agent using msiexec:

  • msiexec /uninstall agent-install.msi CLEANME=1
    where:
    agent-install.msi is the CTERA Agent installation msi file.

Centrally Installing CTERA Agent Via Active Directory

Note

The following procedure describes installation using a Windows 2012 Active Directory domain. It is similar for other Windows Server versions.

To centrally install CTERA Agent:

  1. Perform the following steps to prepare the CTERA Agent installation file for central use:
    1. On the Active Directory machine, create a shared folder called Agent under C:\ .
    2. Copy the CTERA Agent installation file to a local disk, for example, C:\Agent.
    3. Right-click the folder and then click Properties.
      The Agent Properties window is displayed.
    4. Select the Sharing tab.
    5. Click Share.
      The File Sharing window is displayed.
    6. Perform the following steps for each user or user group for which you would like to install CTERA Agent.
      1. Specify the user/group, either by typing the user/group's name in the field, or by clicking the drop-down list arrow and then clicking Find people.
        To enable installing CTERA Agent for all users/groups, select Everyone.
      2. Click Add.
        The user/group is displayed in the file sharing list.
      3. In the user/group's row, click on the arrow in the Permission Level column, then click Read.
      4. Click Share.
        The File Sharing window displays a success message.
    7. Click Done.
    8. Click Close to close the Agent Properties window.
  2. Create a policy that controls the installation of CTERA Agent:
    1. In the Start menu, select Administrative Tools > Group Policy Management.
      The Group Policy Management console is displayed.
      This console enables you to create domain-wide policies or policies for specific organizational units.
    2. In the navigation pane, drill-down to the domain or organizational unit for which you want to create the policy, right-click it and select Create a new GPO in this domain and Link it here.
      The New GPO window is displayed.
    3. Enter a name for the policy and click OK.
    4. In the navigation pane, select the domain and in the right pane, select the Linked Group Policy Objects tab.
    5. Double-click the policy to display the policy.
      Note

      If a Group Policy Management Console message is displayed, click OK.

      The policy details are displayed:
    6. In the Security Filtering area, perform the following steps for each user or user group for which you would like to install CTERA Agent.
      1. Click Add.
        The Select User, Computer, or Group window is displayed.
      2. In the Enter the object name to select area, type the name of the user/group.
        To enable installing CTERA Agent for all users/groups, type Everyone.
      3. Click OK.
    7. Right-click the policy you created and select Edit.
      The Group Policy Management Editor is displayed.
    8. In the navigation pane, expand User Configuration > Policies > Software Settings, right-click Software Installation and select New > Package.
      The Open window is displayed.
    9. Specify the network location of the shared folder containing the CTERA Agent installation file that you created above.
    Note

    The network location of the shared folder is displayed in the folder's Properties window, in the Sharing tab.

    1. Click Open.
      The Deploy Software window is displayed.
    2. Select Assigned.
      This option ensures that when a user or group specified in the policy's Security Filtering area logs in to the domain, CTERA Agent is automatically installed on the user or group's computer.
    3. Click OK .
  3. Add the ctera-agent.adm file to Domain Group Policy as an administrative template using the following steps.
    Note

    The ctera-agent.adm file contains the agent deployment settings. The file is available from the Download Center.

    1. Right-click the policy you created and select Edit.
      The Group Policy Management Editor is displayed.
    2. In the navigation pane, expand Computer Configuration > Policies > Administrative Templates, right-click Administrative Templates and select Add/Remove Templates.
      The Add/Remove Templates window is displayed.
    3. Click Add and select the ctera-agent.adm file and then click Open.
    4. Click Close.
    5. In the navigation pane, expand Computer Configuration > Policies > Administrative Templates > Classic Administrative Templates and click the CTERA Agent Settings node.
    6. Right-click Enable CTERA Agent automatic deployment and select Edit.
    7. Specify the following:
      Enabled – Set the Enabled option.
      Sign into server – Type the fully qualified DNS name of the CTERA Portal to which the CTERA Agent should connect.
    8. Click OK.

Example ctera-agent.adm File Using Python

CLASS MACHINE
 
CATEGORY !!CteraAgent
  KEYNAME "Software\Policies\CTERA\Agent"
 
  POLICY !!USESSO
    EXPLAIN !!USESSO_Explain
    VALUENAME "SSO"
    VALUEON NUMERIC 1
    VALUEOFF NUMERIC 0
    PART !!SSO_Server EDITTEXT REQUIRED
      VALUENAME "SSOServer"
    END PART
    PART !!SSO_Tip TEXT
    END PART
  END POLICY
END CATEGORY
 
[strings]
USESSO="Enable CTERA Agent automatic deployment"
USESSO_Explain="With this policy you can automatically deploy CTERA Agents.\n\n When this policy is disabled, or not configured, each CTERA agent must be manually connected to a CTERA portal or CTERA Cloud-Attached-Storage appliance.\n\n When this policy is enabled, the CTERA Agent installed on the computer automatically signs into the CTERA portal or appliance designated by the policy. When a user logs on to the machine for the first time, CTERA agent immediately signs into the designated server, using the credentials of that user."
SSO_Server="Sign into server"
SSO_Tip="Use the Fully-Qualified DNS name of a CTERA portal or a CTERA appliance. The target server must be a member of this Active Directory domain."
CteraAgent="CTERA Agent Settings"

Was this article helpful?