RES ONE Workspace 2015 Administration Guide RES ONE Workspace

Unattended Installation

It is possible to perform an unattended installation of RES ONE Workspace using a command line. This is useful if you need to install RES ONE Workspace on several computers, and/or if you do not want to interrupt your users.

To install RES ONE Workspace unattended on a computer, you can apply public properties to the "RES-ONE-Workspace-2015-SR2.msi" package. Below the available public properties are grouped per use case.

Connect RES ONE Workspace to an existing database

Public property

Value

Description

CONNECTFILE

<FILEPATH>

Specifies the path and filename of a RES ONE Workspace Datastore connection string stored in a text file. In a connection string the database password is encrypted to prevent exposure.
Create the connection string file from Primary Datastore properties at Setup > Datastore, in the Management Console.

Example: CONNECTFILE=C:\TEMP\Connectfile.txt

Alternatively, use:

DBTYPE

MSSQL, DB2, ORACLE, MYSQL or MSSQLAZURE

Specifies the database type.

Example: DBTYPE=MSSQL

DBSERVER

<SERVERNAME>

Specifies the database server that RES ONE Workspace should connect to.

Example: DBSERVER=SQLServer01

DBNAME

<DATABASENAME>

Specifies the name of the database that RES ONE Workspace should connect to.

Example: DBNAME=RESWorkspace

DBUSER

<DBUSERNAME>

Specifies the database user name that RES ONE Workspace should use to connect to the database.

Example: DBUSER=RESWorkspaceUser

DBPASSWORD

<DBPASSWORD>

Specifies the plaintext password that RES ONE Workspace should use to connect to the database.

Example: DBPASSWORD=WorkspaceUserPassword

DBPROTOCOLENCRYPTION

YES or NO (default)

Specifies whether protocol encryption should be used when connecting to Microsoft SQL Server.

SERVICEACCOUNTNAME

<DOMAIN>\<USER>

Specifies the account name that should be used as the Agent service account when using Windows authentication. The service account name must be a member of the Local Administrator group.
When not using Windows authentication, providing SERVICEACCOUNTNAME is optional.
If not provided, the Agent service will run under the LocalSystem account.

Example: SERVICEACCOUNTNAME=MyDomain\AgentServiceAccount

SERVICEACCOUNTPASSWORD

<PASSWORD>

Specifies the plaintext password that should be used if a service account is specified for SERVICEACCOUNTNAME.

Example: SERVICEACCOUNTPASSWORD=AgentServiceAccountPassword

Example:

Msiexec /i C:\RES-ONE-Workspace-2015-SR2.msi DBSERVER=SQLServer01 DBNAME=RESWorkspace DBUSER=RESWorkspaceUser DBPASSWORD=WorkspaceUserPassword DBTYPE=MSSQL DBPROTOCOLENCRYPTION=No /qn

Msiexec /i C:\RES-ONE-Workspace-2015-SR2.msi CONNECTFILE=C:\TEMP\WMDBconn.txt /qn

Example including the Agent service account:

When the server name is SQLServer01, the Database name is RESWorkspace, Agent service account name/password is AgentServiceAccount/AgentServiceAccountPassword, the command line would be:

Msiexec /i C:\RES-ONE-Workspace-2015-SR2.msi DBTYPE=MSSQL DBSERVER=SQLServer01 DBNAME=RESWorkspace DBPROTOCOLENCRYPTION=No SERVICEACCOUNTNAME=MyDomain\AgentServiceAccount SERVICEACCOUNTPASSWORD=AgentServiceAccountPassword /qn

Connect RES ONE Workspace to a Relay Server

Public property

Value

Description

RSENVGUID

<GUID>

Specifies the GUID that uniquely identifies the RES ONE Workspace environment that the Agent should connect to.
This GUID can be found in the Management Console, at Administration > Relay Servers, on the Settings tab.

Example: RSENVGUID={076FC22E-B7A1-477E-A021-94601893B568}

RSPASSWORD

<PASSWORD> or
<HASHED RSPASSWORD>

Specifies the (by default: plaintext) password of the RES ONE Workspace environment that the Agent should connect to. This password must already be set in the Administration > Relay Servers node in the Management Console.

RSPWHASHED

YES or NO (default)

Specifies whether the value that is specified at RSPASSWORD is hashed.
Technical managers can obtain the hashed version of the Environment password by using one of the following command lines on the machine running the Management Console:

  • pwrtech.exe /gethashedpassword
    With Ctrl+C, the hashed password can be copied from the dialog box to the clipboard.
  • pwrtech.exe /gethashedpassword /f=<full file path>
    The hashed password is saved in the specified file at the given location.

Alternatively, the hashed (encrypted) password can be found in the XML configuration file that was generated on a Relay Server that connects to another Relay Server.
Create the configuration file from the Relay Server Configuration Tool, by clicking Save to XML.

Example: RSPASSWORD=<HASHED RSPASSWORD> RSPWHASHED=YES

RSDISCOVER

YES or NO (default)

Specifies whether the Agent should discover Relay Server(s) using multicast.

RSLIST

<SERVERNAME1>:<PORTNUMBER>;
<SERVERNAME2>

Specifies the list of Relay Servers to connect to, separated by a semicolon (;). When a Relay Server in this list uses a non-default listening port, its servername should be followed by a colon (:) and the listening port.

Example: RSLIST=Server1;Server2:2012;Server3.MyDomain.com

RSRESOLVE

<RELAY SERVER FQDN>

Specifies the FQDN of a Relay Server to be resolved by DNS.

Example: RSRESOLVE=Relay.MyDomain.com

Examples:

Msiexec /i C:\RES-ONE-Workspace-2015-SR2.msi RSENVGUID={7C1FF8AB-5FC8-40C9-AB4C-E285A788A2C0} RSPASSWORD=password RSDISCOVER=yes/no RSLIST=server1;server2 RSRESOLVE=relayserver.ressoftware.com /qn

Msiexec /i C:\RES-ONE-Workspace-2015-SR2.msi RSENVGUID={7C1FF8AB-5FC8-40C9-AB4C-E285A788A2C0} RSPASSWORD=38661621371C7E0C7C10ACA1CAEA1675F8678925 RSPWHASHED=yes RSDISCOVER=yes/no RSLIST=server1;server2 RSRESOLVE=relayserver.ressoftware.com /qn

Inherit connection settings

Public property

Value

Description

INHERITSETTINGS

YES or NO (default)

Specifies whether the Agent should revert to inherited settings after establishing its initial connection to the environment.
With NO (or INHERITSETTINGS not provided), the above-mentioned settings will be set specifically for the Agent, overruling inheritance.
With YES, the Agent will initially connect to the environment with the above-mentioned settings, but will then be set to inherit its connection settings (from a Workspace Model or from the global settings).

Installation public properties

Public property

Value

Description

ADDTOWORKSPACE

<CONTAINER1>|<CONTAINER2>

Specifies the names of the Workspace Containers that this computer should be a member of after finishing installation. Separate multiple Workspace Container names using bagpipes "|" (optional).

Example: ADDTOWORKSPACE=Desktops|Marketing|64Bit

ADDUSERTOTECHMGR

<DOMAIN>\<USER>

Optionally adds the user to the Technical Manager Security Role.

Example: ADDUSERTOTECHMGR=DEMO\Administrator

ADDGROUPTOTECHMGR

<GROUPNAME>

Optionally adds the group to the Technical Manager Security Role.

Example: ADDGROUPTOTECHMGR=DomainAdmins

AUTORUNCOMPOSER

YES or NO (default)

Specifies that the Workspace Composer should be configured to automatically be set as the default shell.

CLAIMLAPTOPLICENSE

YES or NO (default)

Specifies that a concurrent (=laptop seat) license must be claimed and cached from a mixed license pool.

By default, an Agent will not claim a license until a user starts a session on that Agent. Claiming a license requires the Agent to have connection to the Datastore or a Relay Server. If the first session on a laptop is offline, a license cannot be claimed and the license policy will apply unless a license was claimed and cached locally during the installation.

Use CLAIMLAPTOPLICENSE with the value YES to claim a laptop seat license during the unattended install. (A license will be claimed for the laptop even if no user is logged on. Different users of the laptop use the same claimed laptop seat license).

Other values or if left empty will result in the default behavior, which means that the laptop will attempt to claim a named license when a user starts a session.

CLAIMUSERLICENSE

<DOMAIN>\<USER>

Specifies that a named user license should be claimed for a specified user and cached locally.

By default, an Agent will not claim a license until a user starts a session on that Agent. Claiming a license requires the Agent to have connection to the Datastore or a Relay Server. If the first session on an Agent is offline, a license cannot be claimed and the license policy will apply unless a license was claimed and cached locally during the installation.

Use CLAIMUSERLICENSE to claim and cache a named license for the specified user during the unattended install. When that user starts a session, a license is available and the session will proceed.

Example: CLAIMUSERLICENSE=DEMO\ACavendish

AI_DESKTOP_SH

1 (default) or 0

Specifies if desktop shortcuts should be created during installation of RES ONE Workspace.

AI_STARTMENU_SH

1 (default) or 0

Specifies if Start menu shortcuts should be created during installation of RES ONE Workspace.

Example:

Msiexec /i C:\RES-ONE-Workspace-2015-SR2.msi ADDTOWORKSPACE=TestWorkspace ADDUSERTOTECHMGR=DEMO\John ADDGROUPTOTECHMGR=DEMO\TestGroup AUTORUNCOMPOSER=yes CLAIMLAPTOPLICENSE=yes /qn

Create new Database

If there is no existing database to which RES ONE Workspace can connect, you can add the following public properties to create a new database during the unattended installation. After creating a new database, you can optionally import a license file and Building Block. Please note that it is not possible to create a new database when installing an Agent-only installation.

Public property

Value

Description

DBCREATE

YES or NO (default)

Specifies whether a new database should be created using the specified values.

DBCREATEUSER

<USERNAME>

Specifies the database user name that should be used to create the new database.

Example: DBCREATEUSER=SA

DBCREATEPASSWORD

<PASSWORD>

Specifies the database password that should be used to create the new database.

Example: DBCREATEPASSWORD=SAPassword

DBFIPS

YES or NO (default)

Specifies that FIPS compliant security algorithms should be used to encrypt data in the database.

DBIMPORTLICENSE

<FILEPATH>

Specifies a license file to be imported after creating a new database (optional).

Example: DBIMPORTLICENSE=C:\TEMP\License.xml

DBIMPORTBB

<FILEPATH>

Specifies a Building Block file to be imported after creating a new database (optional).

Example: DBIMPORTBB=C:\TEMP\BuildingBlock.xml

Example:

When the server name is SQLSERVER01, the Database name is RESWorkspace, username/password is WorkspaceUser/WorkspaceUserPassword and the license file is located at C:\license.xml, the command line would be:

Msiexec /i C:\RES-ONE-Workspace-2015-SR2.msi DBSERVER=SQLSERVER01 DBNAME=RESWorkspace DBUSER=WorkspaceUser DBPASSWORD=WorkspaceUserPassword DBTYPE=MSSQL DBPROTOCOLENCRYPTION=No DBCREATE=Yes DBCREATEUSER=SA DBCREATEPASSWORD=SAPassword DBIMPORTLICENSE=c:\license.xml DBIMPORTBB=C:\buildingblock.xml /qn

Example using FIPS compliant security algorithms:

When the server name is SQLSERVER01, the Database name is RESWorkspace, username/password is WorkspaceUser/WorkspaceUserPassword, the license file is located at C:\license.xml, and the Database should be FIPS compliant, the command line would be:

Msiexec /i C:\RES-ONE-Workspace-2015-SR2.msi DBSERVER=SQLSERVER01 DBNAME=RESWorkspace DBFIPS=Yes DBUSER=WorkspaceUser DBPASSWORD=WorkspaceUserPassword DBTYPE=MSSQL DBPROTOCOLENCRYPTION=No DBCREATE=Yes DBCREATEUSER=SA DBCREATEPASSWORD=SAPassword DBIMPORTLICENSE=C:\license.xml /qn

Dynamic Datastore configuration

When performing unattended installations of RES ONE Workspace it can also be very useful to set up dynamic Datastore configuration in your environment. When configured, an Agent will obtain its Datastore connection settings from a DHCP server: it is not necessary to specify these settings in a command line when installing RES ONE Workspace unattended. See Dynamic Datastore configuration for Agents for more information.