Bulk onboarding of devices

All Zmanda Pro Clients have to be registered under a user created on the Zmanda Pro Server to be able to configure protected items(source to be backed up) and trigger backups/restores.

ZPAT provides capabilities for onboarding Zmanda Pro Client devices automatically without having to create users on the Zmanda Pro Server. The Zmanda Pro Clients are required to be in an Unregistered state for ZPAT to be able to onboard them

Base Requirements

1. An instance of Self-hosted Zmanda Pro Server

2. One or more devices which you want to backup

   1. The Zmanda Pro Client Software will be installed on this device

   2. The Zmanda Pro Client Software must perform a silent installation, this can be done in two ways

      1. Using the packaged installation automation scripts

      2. Running the Zmanda Pro Client installation command

3. The onboard-devices.csv & onboard-devices-overrides.csv files in /opt/zmandapro/automations/config/ configured

4. Admin credentials to access your server

The Onboarding Process

The ZPAT onboard-devices command runs as a process for a maximum time of 30 minutes. Default configurations that may be applicable to all devices can be configured in the onboard-devices.csv file. Any devices that are in the Unregistered state and are configured in the onboard-devices-overrides.csv file will be processed for onboarding.

CSV Configuration

The onboard-devices command of ZPAT relies on two configuration files,

1. onboard-devices.csv : This file contains a single line entry with defaults which apply to each Device being onboarded. For example, the AccountName, Emails, Destination configurations and Policies which may be the same for all users can be specified in this file. This file will be referred to as the Defaults file henceforth in this document

2. onboard-devices-overrides.csv : All fields except the password fields [ PasswordFormat, PasswordHash, PasswordRecovery, AllowPasswordLogin ] from the onboard-devices.csv can be overridden in this file. Each record in this file will correspond to the configuration of 1 Zmanda Pro client device. If you don’t want to override any values, you may specify just the DeviceName in this file. This file will be referred to as the Overrides file henceforth in this document

Fields which can be overridden in the onboard-devices-overrides.csv file are specified in the below table

	Header	Description
1	AccountName type: string override true	The Zmanda Pro Server users can be logically grouped into Accounts. This field in the CSV specifies the AccountName to which the onboarding device will belong to. The account name can be edited later from the UI if required.
2	DeviceName type: string override: true	The specific client device name which is to be onboarded. Default must remain | in the onboard-devices.csv file and the specific hostname of the devices must be specified in the onboard-devices-overrides.csv NOTE: This device must be in the Unregistered state
3	Username type: string override: true	The Zmanda Pro Server username to which the client device will be registered to. A user with this specific name will be created on your Zmanda Pro Server. The password will be a random 80 characters string. Multiple devices can be registered to one specified username depending upon your onboard-devices-overrides.csv NOTE: The usernames CANNOT be edited later, however, the passwords can be reset from your Zmanda Pro Server UI. Keeping | in the Defaults file and NOT specifying an explicit Username in the Overrides file will create a user with that same name as that of the Device name in lowercase on your Zmanda Pro Server.
4	LocalTimezone type: string override: true	The Localization of a specific device. Example format: America/Chicago (OR) EST NOTE: Defaults file contains an empty field for this record, this tells your Zmanda Pro Server to pick the default Timezone of that specific device. This can be overriden in the Overrides file with a value that conforms with one of the above formats
5	LanguageCode type: string override: true	One of the Zmanda Pro Supported Languages which can be viewed on your Server Defaults: en_US
6	Emails type: string override: true	The email-ids for that specific user to which reporting can be configured Defaults: blank
7	DestinationType type: string override: true	Supported Types SFTP NOTE: For overriding a specific destination type their corresponding fields have to be mentioned in the Overrides file as well.
8	SendEmailReports type: bool override: true	Toggle email reporting if you have set the Email-id. Defaults: false
9	PolicyJSON type: string override: true	The JSON string which contains the Policy details Read how to extract and format the PolicyJSON here

1. Common default values (onboard-devices.csv )can be

   1. AccountName

   2. Storage Configurations (SFTP configuration)

   3. Emails

   4. PolicyJSON

   5. LocalTimezone

   6. LanguageCode

2. Required fields in the Overrides files

   1. Devicename

Supported Storage Configuration

SFTP

	SFTP Config	Description
1	SFTPServer type: string override: true	The SFTP server which you can route your backup data to. You can mention the IP address as well as the domain name for this server. For domains, ensure that your organization’s DNS server has the A name record for this SFTP server
2	SFTPUsername type: string override: true	The SFTP user using which you’ll be routing your backup data on the SFTP server
3	SFTPRemotePath type: string override: true	The path on the SFTP Server where you want your backups to be stored. NOTE: If this configuration is specified in the Defaults file, for each entry in the Overrides file, a subfolder under this path with the same name as that of your device name will be created and your backups will reside there
4	SFTPAuthMode type: integer override: true	The authentication method Password: 1 PrivateKey: 2
5	SFTPPassword type: string override: true	If authmode is 1 then the Password for that specific user must be specified in this field
6	SFTPCustomPrivateKey type: string override: true	If authmode is 2 then the entire Private key must be specified in this field enclosed in double quotes

Command Execution

Refer Common flags here.

/opt/zmandapro/automations/zpat onboard-devices