✎ [V7] FAQ: Silent install command for installation / deployment of AhsayOBM / ACB (for Windows) [Ahsay Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
=====[V7] FAQ: Silent install command for installation / deployment of AhsayOBM / ACB (for Windows) =====

<html>
 <b>
  Article ID</b>:
 5302
 <br/>
 <b>
  Reviewed</b>:
  2018-02-21
 <br/>
 <br/>
 <b>
  Product Version</b>:
 <br/>
 AhsayACB / AhsayOBM: 7.5.2.2 to 7.x
 <br/>
 OS: Windows 
</html>



<html>
<FONT COLOR=red SIZE=+1>
<B>ATTENTION</B>
1st January, 2022: v7 officially End-of-Life [<A HREF=https://wiki.ahsay.com/doku.php?id=public:announcement:ahsay_v7_eol>details</A>]
</FONT>
</html>

===== Description =====
This document contains information on the silent install command (e.g. client installation without user interaction) for AhsayOBM / ACB.


===== Contents =====
<html>
Table of Contents:
 <br>
 <ul>
  <li>
   <a href="#Installer%20name">
    Installer name
   </a>
  </li>
  <li>
   <a href="#Automate%20client%20user%20login%20and%20backup">
    Automate client user login and backup
   </a>
  </li>
  <li>
   <a href="#Silent%20install%20command%20and%20options">
    Silent install command and options
   </a>
  </li>
 </ul>

<br>
<b><a name="Installer%20name">Installer name</a></b>:<br>

Before you can perform a silent install (directly via command prompt or a script), the AhsayOBM / ACB installer must be renamed to include the application type, backup server URL, backup protocol, backup port and owner settings:<br>
<br>
For example, 

AhsayOBM, backup server URL 10.1.0.20, backup protocol https, backup port 443, and owner ID 123, the installer must be renamed to
<br>
<br>
obm-win-443-10.1.0.20-https-123O.exe
<br>
<br>
The naming convention of the installation file is
<br>
<br>
${application_type}-win-${backup_port}-${backup_server_url}-${backup_protocol}-${owner_id}O.exe
<br>
<br>
<font size=2>
<ul>
<li><font color=black><u>application_type (obm / acb)</u><br>
AhsayOBM or AhsayACB client installer.</li></font>
<br>
<li><font color=black><u>backup_port</u><br>
HTTP / HTTPS port of the backup server which the client will connect to.</li></font>
<br>
<li><font color=black><u>backup_server_url</u><br>
Backup Server URL of the backup server which the client will connect to.</li></font>
<br>
<li><font color=black><u>backup_protocol (http / https)</u><br>
Backup Protocol of the backup server which the client will connect to.
<br>
<br>
Note:<br>
The Backup Server URL, Backup Protocol and Backup Port settings, correspond to the settings configured under AhsayCBS web console at
<br>
<br>
<ol>
<li><font color=black>On the main menu, under <b>System Settings</b>, select <b>Basic</b>.</font></li><br>
<li><font color=black>Select <b>Administrative Access</b>, the system account, and then <b>Rebrand Clients</b>.</font></li><br>
<li><font color=black>Settings under <b>Application Settings - OBM</b> or <b>Application Settings - ACB</b>.</font></font>
<br>
<br>
<img src="http://wiki.ahsay.com/lib/exe/fetch.php?media=public:Silent_install_7.png" style="width:65%; border:thin solid black"/></li></li>
</ol>
<br>
<li><font color=black><u>owner_id</u><br>
Owner ID of the system account that the backup user belongs to.
<br>
<br>
Obtain the owner ID of a system account on the AhsayCBS web console at:
<br>
<br>
<ol>
<li><font color=black>On the main menu, under <b>System Settings</b>, select <b>Basic</b>.</font></li><br>
<li><font color=black>Select <b>Administrative Access</b>, then the system account.</font></li><br>
<li><font color=black>Copy the URL from the browser to a text editor, the owner ID is listed at the end of id=
<br>
<br>
http://backup_server_url/cbs/system/config/accounts/EditSysUser.do?id=ower_id
<br>
<br>
For example
<br>
<br>
http://10.1.0.20/cbs/system/config/accounts/EditSysUser.do?id=<font color=red>1480067614863</font>
<br>
<br>
The owner ID is <font color=red>1480067614863</font></font></li>
</li>
</ol></li>
</font></ul>
<br></font>

<b><a name="Automate%20client%20user%20login%20and%20backup">Automate client user login and backup</a></b>:<br>
<font color=red>Important</font>: This feature is only available for AhsayOBM / ACB version 7.15.2.2 or above.
<br>
<br>
You can automate the user login and backup process (e.g. for mass deployment) by creating the backup user, backup sets, and local user settings file "config.ini" on the corresponding client computer, before installing AhsayOBM / ACB (for both silent and normal installation method).  
<br>
<br>
The config.ini file contains backup client settings, such as the backup server URL, backup protocol, username, user password, save password setting, and most importantly, encryption settings of all backup sets of the backup user, are read by AhsayOBM / ACB upon completion to the installation process, AhsayOBM / ACB services restart, or client user interface login.
<br>
<br>
Scheduled backup jobs can then be perform and backup sets' ownership are handled automatically with absolutely no user interaction (e.g. scheduled backup job are performed in the background without the need for the end user to login to AhsayOBM / ACB). 
<br>
<br>
Refer to the following steps to create the backup user, backup sets, and config.ini file
<br>
<br>
<ol>
<li><font color=black>Login to the AhsayCBS web console.</font></li><br>
<li><font color=black>On the main menu, under <b>Backup / Restore</b>, select <b>Users, Groups & Policies</b>.</font></li><br>
<li><font color=black>Create the backup user account.
<br>
<br>
Note:<br>
Refer to the AhsayCBS Administrator’s Guide for details on how to create a backup user:
<br><a href="https://www.ahsay.com/download/download_document_cbs-admin.jsp">https://www.ahsay.com/download/download_document_cbs-admin.jsp</a></font></li>
<br>
<li><font color=black>Create backup set for the backup user.
<br>
<br>
Note:<br>
Refer to the AhsayCBS User’s Guide for details on how to create a backup set:
<br><a href="https://www.ahsay.com/download/download_document_cbs-user.jsp">https://www.ahsay.com/download/download_document_cbs-user.jsp</a>
<br>
<br>
Create a <b>Backup Schedule</b> for the backup set if you want to automate the backup process.</font></li>
<br>

<li><font color=black>Obtain the backup set ID of the newly created backup set on the AhsayCBS web console at:

<br>
<br>
<ul>
<li><font color=black>On the main menu, under <b>Backup / Restore</b>, select <b>Users, Groups & Policies</b>.</font></li>
<li><font color=black>Under <b>Backup User</b>, select the corresponding backup user, and then <b>Backup Set</b>. </font></li> 
<li><font color=black>Select the backup set under <b>Manage Backup Set</b>.</font></li>
<li><font color=black>The backup set ID is listed under <b>General</b>
<br>
<br>
Perform the same steps for each backup set created.</font></li></ul>
<br>
<li><font color=black>On the client computer, create the ".obm" / ".acb" folder under the corresponding Windows user’s profile, for example, at
<br>
<br>
C:\Users\Administrator\.obm
<br>
<br>
Note:<br>
It is important that the .obm / .acb folder is created at the correct location (e.g. the Windows user to be running AhsayOBM / ACB).</font></li>
<br>
<li><font color=black>Create a "home.txt" file containing the path to the .obm / .acb folder (created in the previous step), for example
<br>
<br>
C:\Users\Administrator\.obm
<br>
<br>
Create the following directories path and place the home.txt file in 
<br>
<br>
C:\ProgramData\AhsayOBM\home.txt&nbsp;&nbsp;or<br>
C:\ProgramData\AhsayACB\home.txt
<br>
<br>
Note:<br>
ProgramData is a hidden folder, you may need to change the folder settings in Windows Explorer in order to see it.</font></li>
<br>
<li><font color=black>Create the local user settings file "config.ini" with a text editor.
<br>
<br>
Format of contents in the config.ini file 
<br>
<br>
ID=${username}<br>
PWD=${password}<br>
LANG=en<br>
HOST=${backup_server_url}<br>
PROTOCOL=${backup_protocol}<br>
SAVE_PWD=${Y/N}<br>
BSET-${backupset_id}=PKCS7Padding,${encryption_algorithm-bits},${encryption_method},${encryption_key}<br>
<br>
<font size=2>
<ul>
<li><font color=black><u>ID</u><br>
Username of the corresponding backup user.</font></li>
<br>
<li><font color=black><u>PWD</u><br>
Login password of the corresponding backup user.</font></li>
<br>
<li><font color=black><u>HOST</u><br>
Backup Server URL of the backup server which the client will connect to.</font></li>
<br>
<li><font color=black><u>PROTOCOL (http / https)</u><br>
Backup Protocol of the backup server which the client will connect to.</font></li>
<br>
<li><font color=black><u>SAVE_PWD (Y / N)</u><br>
Save password setting of AhsayOBM / ACB.  This option correspond to the following option on the user interface:
<br>
<br>
<img style="width:45%" src="http://wiki.ahsay.com/lib/exe/fetch.php?media=public:Silent_install_5.png"/></font>
<br>
<br>
<li><font color=black><u>BSET-${backupset_id}</u><br>
The backupset_id can be obtained with the instruction provided in Step 5 above.
<br>
<br>
Encryption setting of backup set can be configured with the following parameters  
<br>
<br>
BSET-${backupset_id}=PKCS7Padding,${encyrption_algorithm-bits},${encryption_method},${encryption_key}
<br>
<br>
<ul>
<li><font color=black><u>encyrption_algorithm-bits (Twofish-128 / Twofish-256 / DESede-128 / DESede-256 / AES-128 / AES-256)</u><br>
Encryption Algorithm and Key Length for the backup set.</font></li>
<br>
<li><font color=black><u>encryption_method (ECB / CBC)</u><br>
Encryption Method of the backup set.</font></li>
<br>
<li><font color=black><u>encryption_key</u><br>
Encryption Key of the backup set.</font></li>
</ul>
<br>
For example
<br>
<br>
To configure a backup set with ID 1518496233192, Encryption Algorithm AES, Key Length 256-bit, Encryption Method CBC and Encryption Key 123456
<br>
<br>
BSET-1518496233192=PKCS7Padding,AES-256,CBC,123456
<br>
<br>
To configure a backup set with ID 1518502501989, No Encryption 
<br>
<br>
BSET-1518502501989=,,,</li></font></font>
<br>
Create the config.ini file according to the server, user login credentials and backup set(s) that you have created.
<br>
<br>
For example, with the following server, user login credentials, and encryption settings
<br>
<br>
Username = username<br>
User password = P@ssw0rd<br>
Backup Server URL = 10.1.0.20<br>
Backup Protocol = https<br>
Save Password = No<br>
Backup Set ID = 1518496233192<br>
Encryption Algorithm = AES<br>
Key Length = 256-bit<br>
Encryption Method = CBC<br>
Encryption Key = 123456<br>
<br>
Content of the config.ini file will look like this
<br>
<br>
ID=username<br>
PWD=P@ssw0rd<br>
LANG=en<br>
HOST=10.1.0.20<br>
PROTOCOL=https<br>
SAVE_PWD=N<br>
BSET-1518496233192=PKCS7Padding,AES-256,CBC,123456
<br>
<br>
Note:<br>
For backup user with multiple backup sets, simply list the encryption settings at the end of the file.
<br>
<br>
For example<br>
…<br>
PROTOCOL=https<br>
SAVE_PWD=N<br>
BSET-1518496233192=PKCS7Padding,AES-256,CBC,123456<br>
BSET-1518502501989=PKCS7Padding,AES-256,ECB,abc123<br>
BSET-1518502439761=PKCS7Padding,AES-256,CBC,xyz456<br>
</font>
</ul>
</font>
<br>
<li><font color=black>Place the "config.ini" file in the .obm / .acb folder created in Step 6, for example, at
<br>
<br>
C:\Users\Administrator\.obm\config\config.ini
<br>
<br>
Note:<br>
It is important that the config.ini file is placed in the correct location (e.g. in the .obm / .acb folder of the Windows user to be running AhsayOBM / ACB).</font></li>
<br>
<li><font color=black>Refer to the next section to perform the silent installation of AhsayOBM / ACB.</font></li>
</ol>
</font>
<br>
<b><a name="Silent%20install%20command%20and%20options">Silent install command and options</a></b>:<br>
Execute the following command to perform a silent installation
<br>
<br>
${installer_name} /${install_mode} /LANG=en /TASKS=${"program_group"} /DIR=${"installation_path"}
<br>
<br>
<ul>
<font size=2>
<li><font color=black><u>install_mode (silent / verysilent)</u><br>
There are two silent install modes for AhsayOBM / ACB, they are called the <b>Silent</b> mode (silent), and <b>Very Silent</b> mode (verysilent).
<br>
<br>
<ul>
<li><font color=black>Silent mode
<br>
<br>
When AhsayOBM / ACB is installed with the silent install command in <b>Silent</b> mode, the installation progress will be displayed on screen, but no user interaction is required.
<br>
<br>
<img style="width:45%" src="http://wiki.ahsay.com/lib/exe/fetch.php?media=public:Silent_install.png"/></font></li>
 
<br>
<li><font color=black>Very Silent mode
<br>
<br>
When AhsayOBM / ACB is installed with the silent install command in <b>Very Silent</b> mode, there will be no visual feedback on screen.</font></li>

<br>
For example
<br>
<br>
To install AhsayOBM in Silent mode<br>
>obm-win-443-10.1.0.20-https-0O.exe /<b>silent</b> /LANG=en /TASKS="EveryOne"
<br>
<br>
To install AhsayACB in Very Silent mode<br>
>acb-win-443-10.1.0.20-https-0O.exe /<b>verysilent</b> /LANG=en /TASKS="EveryOne"</font>
</li>
</ul>
<br>

<li><font color=black><u>program_group ("EveryOne" / "meOnly")</u><br>
There are two options available for program_group, they are the "Anyone who uses this computer" (EveryOne) program group or "Me Only" (meOnly) program group.  
<br>
<br>
These two options correspond to the following options on the user interface when AhsayOBM / ACB is installed normally:
<br>
<br>
<img style="width:35%" src="http://wiki.ahsay.com/lib/exe/fetch.php?media=public:Silent_install_3.png"/>
<br>
<br>
For example
<br>
<br>
To install AhsayOBM for "Anyone who uses this computer"<br>
>obm-win-443-10.1.0.20-https-0O.exe /silent /LANG=en /TASKS=<b>"EveryOne"</b>
<br>
<br>
To install AhsayACB for "Me Only"<br>
>acb-win-443-10.3.1.8-https-0O.exe /silent /LANG=en /TASKS=<b>"meOnly"</b></li>
<br>
<li><font color=black><u>DIR</u><br>
Optional parameter to install AhsayOBM / ACB to a non-default path, supply the DIR option.
<br>
<br>
For example
<br>
<br>
To install AhsayOBM to a non-default path C:\custom_path<br>
>obm-win-443-10.1.0.20-https-0O.exe /silent /LANG=en /TASKS="EveryOne" /DIR=<b>"C:\custom_path"</b>
<br>
<br>
To install AhsayACB to a non-default path C:\custom_path2<br>
>acb-win-443-10.1.0.20-https-0O.exe /silent /LANG=en /TASKS="EveryOne" /DIR=<b>"C:\custom_path2"</b>
<br>
<br>
Note:<br>
If the DIR option is not supplied, the client application will be installed to the default path (e.g. C:\Program Files).</li></ul>
</html>



===== Keywords =====
silent, install, installation, hide, hidden, customization, deploy, deployment, remote
User Tools

Site Tools

Page Tools
