Skip to content

Command-Line Parameters

Information below applies to SmartPTT 9.14.100 and newer.

Syntax§

<path_to_package>   --quiet  ^
                    {--i|--u}  ^
                    [--installfolder <path_to_destination_folder>]  ^
                    {all|client|remoteassistance|reporttool|server}  ^
                    --AUTHSETTINGS  ^
                        AUTHTYPE={Domain|Legacy|Local}  ^
                        [domainname=<domain_name>]  ^
                        [IS_CENTRALIZED={true|false}]  ^
                        [SYSADMINS='<sys_admins_group_name>']  ^
                        [DBADMINS='<database_admins_group_name>']  ^
                        [CSLADMINS='<console_admins_group_name>']  ^
                        [CSLOPS='<console_operators_group_name>']

Minimum Set§

With the minimum set, you can perform the full product installation.

<path_to_package>  --quiet ^
                   {--i|--u} ^
                   {all|client|remoteassistance|reporttool|server} ^
                   --installfolder <path_to_destination>

Explanation of the minimum options is available below.

Basics§

Specify the quiet mode install/uninstall.

Parameters:

  • <path_to_package>
    Specifies the location and name of the installation package file. Might be local or network resource.
  • --quiet (required)
    Specifies quiet mode, which means there is no user interaction required.

Notes:

  • --quiet is the only parameter recommended to declare the quiet mode. Its alternatives will be suspended in the future releases.

Operation§

  • --i
    Specifies installation mode.
  • --u
    Specifies uninstallation mode.

Components§

Specifies components to install. At least one of the following parameters is required.

Parameters:

  • all
    Specifies installation of all components in the package.
  • client
    Specifies installation of the Dispatcher App only.
  • remoteassistance
    Specifies installation of the Remote Assistance app only.
  • reporttool
    Specifies installation of the Report Tool only.
  • server
    Specifies installation of the Server and Configuration App only.

Destination§

Specifies custom and/or default install directory. Must be specified even if you wish to keep the default path.

Parameters:

  • --installfolder
    Specifies that the following parameter is the location of the root directory where the required components will be installed.

  • <path_to_destination>
    Specifies the location of the root directory where the required components will be installed. Default is:

    C:\Program Files\SmartPTT

Notes:

  • The Dispatcher App installs to <path_to_destination>/Client
  • The Remote Assistance app installs to <path_to_destination>/Remote Assistance
  • The Report Tool app installs to <path_to_destination>/Report Tool
  • Server and Configurator install to <path_to_destination>/Server
  • To install multiple but not one component, use individual command-line request for every component.

Authentication§

At the installation, you should specify what kind of authentication you want to use in the product.

Fragment
...  --AUTHSETTINGS  ^
       AUTHTYPE={AUTHTYPE|Legacy|Local}
       [domainname=<domain_name>]  ^
       [IS_CENTRALIZED={true|false}]  ^
       [SYSADMINS='<sys_admins_group_name>']  ^
       [DBADMINS='<database_admins_group_name>']  ^
       [CSLADMINS='<console_admins_group_name>']  ^
       [CSLOPS='<console_operators_group_name>']

Parameters:

  • --AUTHSETTINGS
    Specifies the beginning of authentication settings setup.
  • AUTHTYPE
    Specifies the authentication mode. Supported values are as follows:
    • Domain: Specifies the use of domain (Active Directory) authentication.
    • Legacy (not recommended): Specifies the use of the native SmartPTT authentication.
    • Local: Specifies the use of user accounts created locally in the destination.
  • domainname
    Specifies the domain that where users and user groups are located. Must only be used if AUTHTYPE=Domain.
  • <domain_name>
    Specifies the domain name where users and groups are stored.
  • IS_CENTRALIZED
    Specifies if only server performs user authorization and Dispatcher Apps do not perform that. Must only be used if AUTHTYPE=Domain or AUTHTYPE=Local Supported values are as follows:
    • true: Only server performs authentication, and Dispatcher Apps do not perform it.
    • false (not recommended): Both server and Dispatcher App perform authentication.
  • SYSADMINS
    Specifies user group name for users with the role of System Admins.
  • DBADMINS
    Specifies user group name for users with the role of Database Admins.
  • CSLADMINS
    Specifies user group name for users with the role of Console Admins.
  • CSLOPS
    Specifies user group name for users with the role of Console Operators.

Notes§

  • If you specify multiple words as a value of the parameters (for example, user group names consist of two or more words), then you should enclose them in apostrophes ('). Otherwise, no installation/uninstallation occurs.

See Also§