Skip to main content

December 19, 2024 Archived

Omnissa Access Connector Silent Mode Installation Properties

The Omnissa Access connector installer accepts the following properties in silent mode. You can specify the properties in an XML file or enter them directly on the command line.

Properties

PropertyValueDescription
ADDLOCALUserAuthService DirectorySyncService KerberosAuthService VirtualAppServiceThe enterprise services to install. To specify multiple services, use a comma-separated list. For example:"UserAuthService,DirectorySyncService"
INSTALLDIRdirectoryPathThe installation directory to use

Default value: C:\\Silent
TARGETDIRdirectoryPathThe installation directory to use. Enter the same value as INSTALLDIR.

Default value: C:\\Silent
WS1_ENABLE_FIPS1 (install in FIPS mode) 0 (install in non-FIPS mode)See [Omnissa Access Connector and FIPS Mode \(Omnissa Access FedRAMP Only\)](WorkspaceONEAccessConnectorandFIPSModeWorkspaceONEAccessFedRAMPOnly.md) for information, requirements, and prerequisites for FIPS mode.

Important: You cannot change the mode after installation, from FIPS mode to non-FIPS mode or from non-FIPS mode to FIPS mode. Therefore, review the requirements and prerequisites carefully and decide whether you want to enable FIPS or not before you begin the installation.
WS1_CONFIG_FILE_PATHconfigFilepathThe path to the configuration file that you downloaded from the Omnissa Access console. The default name of the file is es-config.json.

Default value: C:\Installer\es-config.json (the directory that contains the installer) Also specify the file’s password on the command line with WS1_CONFIG_FILE_PASSWORD.
WS1_CONFIG_FILE_PASSWORDconfigFilePasswordThe password for WS1_CONFIG_FILE_PATH. Do not add WS1_CONFIG_FILE_PASSWORD to the XML file, specify it on the command line as WS1_CONFIG_FILE_PASSWORD=password.
WS1_IS_PROXY_ENABLED1 (use proxy) 0 (no proxy)To use a proxy server, set the value to 1. Also specify WS1_PROXY_HOSTNAME and WS1_PROXY_PORT.

Default value: 0
WS1_PROXY_HOSTNAMEproxyserverFQDNorIPProxy server hostname (FQDN) or IP address
WS1_PROXY_PORTproxyserverPortProxy server port
WS1_IS_PROXY_AUTHENTICATED2 (Basic, that is, authenticated) 1 (Anonymous, that is, no authentication)Set the value to 2 if the proxy server requires authentication. Also specify WS1_PROXY_USERNAME.

Default value: 1

Note: See [Omnissa Access Connector Systems Requirements](WorkspaceONEAccessConnectorSystemsRequirements.md) for information about supported proxies.
WS1_PROXY_USERNAMEproxyusernameProxy server user name. Also specify the proxy server password on the command line with WS1_PROXY_PASSWORD.
WS1_PROXY_PASSWORDproxypasswordProxy server password. Do not add WS1_PROXY_PASSWORD to the XML file. Specify it on the command line as WS1_PROXY_PASSWORD=password.
WS1_NON_PROXY_HOSTShost1|host2FQDN or IP address of non-proxy hosts that should be reached directly without going through the proxy server. To specify multiple non-proxy hosts, use the delimiter |.
WS1_IS_SYSLOG_ENABLED1 (use syslog) 0 (no syslog)To use a syslog server, set the value to 1. Also specify WS1_SYSLOG_HOSTNAME.

Default value: 0
WS1_SYSLOG_HOSTNAMEsysloghostname:portnumber Syslog server FQDN or IP address, and port number. To specify multiple servers, separate the entries with a comma. For example: server1.example.com:1111 or server1.example.com:1111,server2.example.com:2222
WS1_TRUSTSTORE_CERTS_PATHtruststoreCertificatesFolderThe path to the folder that contains certificates to upload to the truststore on the connector server.

Caution: Make sure that the certificate paths do not contain double-byte characters, which are used in some languages. If the path contains double-byte characters, upgrade might succeed but the certificates will not be uploaded correctly.

The certificate can also be uploaded later, after installation.

Scenarios for uploading certificates to the truststore include:
  • (On-premises installations only) If your on-premises Omnissa Access service instance has a self-signed certificate, you must upload its root, and, if required, intermediate certificate to establish trust between the enterprise services and the Omnissa Access service instance.
  • (Kerberos Auth service only) If you deploy multiple instances of the Kerberos Auth service behind a load balancer, you must install the load balancer's root CA certificate on the connector instances to establish trust between the connectors and the load balancer.
  • (Virtual App service only) If you create virtual apps collections to integrate with Horizon, Horizon Cloud Service on Microsoft Azure with Single-Pod Broker, or Horizon Cloud Service on IBM Cloud, and the Horizon servers have self-signed certificates, you must upload the certificate chain to the connector instances on which the Virtual App service is installed to establish trust between the connectors and the Horizon Connection servers.
WS1_USER_AUTH_PORTportnumberPort for User Auth service

Default value: 8090
WS1_DIRECTORY_SYNC_PORTportnumberPort for Directory Sync service

Default value: 8080
WS1_KERBEROS_AUTH_PORTportnumberPort for Kerberos Auth service

Default value: 443
WS1_APP_SYNC_PORTportnumberPort for Virtual App service

Default value: 8008
WS1_ADD_SSL_CERT0 (self-signed certificate) 1 (SSL certificate)Specify 1 to upload a signed SSL certificate, if required. A signed SSL certificate is required for the Kerberos Auth service. If you specify 1, use the WS1_CERT_TYPE property to indicate the type of the certificate and the WS1_SSL_CERT property to add the certificate. If you specify 0, a self-signed certificate is auto-generated.

Default value: 0
WS1_CERT_TYPEpem (PEM format) pfx (PFX format)The type of the SSL certificate that you are uploading for the Kerberos Auth service.
WS1_SSL_CERT“” certFilepathThe path to the SSL certificate. The certificate file can be in PEM or PFX format. If the value is a PEM file, also specify WS1_PRIVATE_KEY. If the file is a PFX file, specify its password on the command line with WS1_SSL_CERT_PASSWORD.
WS1_SSL_CERT_PASSWORDcertificatePasswordRequired if the value of WS1_SSL_CERT is a PFX file. Do not add WS1_SSL_CERT_PASSWORD to the XML file, specify it on the command line as WS1_SSL_CERT_PASSWORD=password.
WS1_PRIVATE_KEY“” pemKeyFileThe path to the PEM key file. Required if the value of WS1_SSL_CERT is a PEM file.
IS_NET_API_LOGON_USERNAMEDOMAIN\usernameThe domain user account to use to run the Kerberos Auth and Virtual App services. Use the format DOMAIN\username. Also specify the password on the command-line with IS_NET_API_LOGON_PASSWORD=password.
IS_NET_API_LOGON_PASSWORDdomainUserPasswordThe domain user account password. Do not add IS_NET_API_LOGON_PASSWORD to the XML file, specify it on the command line asIS_NET_API_LOGON_PASSWORD =password.

Important: The Kerberos Auth service only supports the following special characters in the domain user account password: ! ( & % @ / = ? * , . If the password contains any other special characters, Kerberos Auth service installation fails.

Important: In Omnissa Access connector 22.09.1.0, the Virtual App service does not support the # character in the domain user account password.
WS1_ENABLE_STORE_FRONT_RPSS0 1 (Applicable only to the Virtual App service and to virtual apps collections that support Citrix multi-site aggregation and keyword filtering) Specify 1 if your Citrix environment restricts the PowerShell commands that can be executed on StoreFront remotely. When you set this property to 1, you must also:
  • Create a PowerShell session configuration file on StoreFront to allow the Virtual App service to run the limited commands required for multi-site aggregation and keyword filtering.
  • Specify the WS1_RPSS_CONFIG_NAME property and provide the configuration name.
Default value: 0

See Configuring Citrix Multi-site Aggregation and Keyword Filtering in Omnissa Access in Setting up Resources in Omnissa Access.
WS1_RPSS_CONFIG_NAMEConfigurationName (Applicable only to the Virtual App service and to virtual apps collections that support Citrix multi-site aggregation and keyword filtering) This property is required if you set WS1_ENABLE_STORE_FRONT_RPSS to 1. Enter the configuration name you specified while creating the PowerShell session configuration file, without the extension. Only alpha-numeric characters are allowed in the name.
WS1_ENABLE_KEYWORD_FILTERING0 1 (Applicable only to the Virtual App service and to virtual apps collections that support Citrix multi-site aggregation and keyword filtering) Set to 1 if keyword filtering is enabled on StoreFront.

Default value: 0

Note: For Omnissa Access to support keyword filtering, either your Citrix environment must not have any restrictions on the PowerShell commands that can be executed on StoreFront remotely, or you must set the WS1_ENABLE_STORE_FRONT_RPSS property to 1 and set up a PowerShell session configuration file to allow the Virtual App service to run limited commands.

See Configuring Citrix Multi-site Aggregation and Keyword Filtering in Omnissa Access in Setting up Resources in Omnissa Access for more information.
WS1_BYPASS_STORE_FRONT0 1 (Applicable only to the Virtual App service and to virtual apps collections that support Citrix multi-site aggregation and keyword filtering) The Virtual App service loads certain modules in StoreFront to support keyword filtering. If you do not want the Virtual App service to load the modules, set this property to 1.

Default value: 0

See Configuring Citrix Multi-site Aggregation and Keyword Filtering in Omnissa Access in Setting up Resources in Omnissa Access for more information.

Format

Use the following format to specify installation properties on the command line:

propertyname=value

For example:

WS1_IS_PROXY_ENABLED=1

or

ADDLOCAL=UserAuthService,DirectorySyncService

Use the following format to specify installation properties in an XML file:

<property name="propertyname" value="propertyvalue" />

For example:

<property name="WS1_IS_PROXY_ENABLED" value="1" />

or

<property name="ADDLOCAL" value="UserAuthService,DirectorySyncService" />

Was this page helpful?

Provide feedback for this topic

Was this topic helpful?

Please do not include any personal or confidential information.

Generating link…