Citrix CPSM V10 Integration Manual
Customer Name
Cortex Release Version
10
Document Version
1.4 Last updated: 12 Aug 13
BackupAgent Service Manager
Installation Guide
1.1 Prerequisites
Citrix CPSM v10 (formerly known as Cortex) integrates with BackupAgent using the
BackupAgent Active Directory Synchronisation feature. This feature needs to be working for
BackupAgent before the Cortex Integration will succeed.
1.2 Create the initial set of Service Access Levels
BackupAgent’s Active Directory Synchronisation relies on users being made member of Active
Directory Security groups with specially crafted names. These groups have to be in the format:
BackupAgent_<Plan>_<Quota>_<Storage Group ID>
Where:
<Plan> is either Home or Professional where Home is for desktop backups and
Professional is for Server backups including Microsoft Exchange and Microsoft SQL
server.
<Quota> is the maximum storage space in gigabytes or megabytes e.g 500MB or 10GB
<Storage Group ID> is the internal BackupAgent ID for the particular storage group.
CloudPortal puts users in and out of these groups as part of the actions when a user is put in a
specific Service Access Level. For this to occur, each Service Access Level needs to have the
following properties set
1
Therefore we would expect an access level to have the following properties analogous to the
group name format:
1. Plan (either Home or Professional)
2. Quota (Integer number)
3. Quota unit(either MB or GB)
4. Storage Group ID
The location of the Security groups that the Service Provider has created when testing the
BackupAgent service is set out in the Preparation Form. As a courtesy, it is usual to create a
Service Access Level for the groups that they are managing.
CloudPortal creates these groups automatically and are put under the CortexSystem OU in
Active Directory
1.3 Configure the customer’s Organizational Structure
BackupAgent designed their Active Directory integration around Microsoft’s HMC solution
which always has the user at the root of the customer’s Organizational Unit. Cortex allows for
much more flexibility in terms of where the users can go in the Active Directory structure
however if the customer wants to use BackupAgent service then they must have their users at
the root of their Organizational Unit.
There are two options to meet this pre-requisite. They are:
1. Set the User Structure Configuration property of cortex to be blanked out so that by
default all users for all customers are created at the root of the customer’s OU. This
configuration will be enforced for all customers.
2. The customers who are given the BackupAgent service must be in the User Specified
Organization Structure option and users given the BackupAgent service must be
provisioned (or moved) to the Root of the Customer’s OU. This can be done on a
customer by customer basis and Cortex does not enforce the user’s OU when
provisioning the service to a user so it is a procedure that the customer must follow for it
to work.
2
1. Configured Cortex to put users at the root of the customer’s OU, or
2. Discussed the other option with the Service Provider.
1.4 Configuring the OU structure for the customer
As described in the paragraph above users should be placed in the root OU.
To do so run the following SQL command on the SQL Server where the cortexdatabases are
installed:
Use [OLMReports]
Update Settings set Value = '' where Property = 'OrganisationalStructure'
Go
Do an iisreset on frontend server after this command
1.5 Installing the BackupAgent Service on the CloudPortal
1.5.1 Make sure the admin user that installs the service has the Schema Admin role
1. Go to the ISP customer and go to USERS
2. Click on the user you are going to import the service with(perhaps the same as the logged
on user) and click on “Edit User”
3. Click on “Account Settings” and then on “Advanced Options”
4. Make sure the “All Services Schema Administrator” and “Service Schema Administrator”
are both selected
5. Click on “Provision” to apply the changes
1.5.2 Import the service
6. Go to Configuration -> System Manager->Service Schema
7. On the left side click on “Import a service”
8. On the “Import a Service from File” screen click on Browse and select the
“CloudBackup.Package” file you have downloaded. Then click on preview
3
Loading...