Performing a silent installation

Last Updated : Sep 23, 2022 |
Prolog information
Metadata
Keywords:
Use this procedure to perform a silent installation of the Avaya Aura® Device Services server.
The silent installation consists of configuring most of the settings in a properties file, instead of using the installation and the configuration menu for every item.
The properties file is called installation.properties. It contains the same settings that you configure during the interactive installation. The settings are grouped, and the file contains comments that describe the settings.
Note:
The properties file does not contain settings for the following elements:
  • The Avaya Aura® Device Services cluster
  • The SSH RSA configuration
  • IPv6 configuration
You must configure these settings using the configuration utility after the silent installation is complete.
If you want to enable IPv6, then you must perform a standard, interactive installation. You cannot enable IPv6 using the Avaya Aura® Device Services web administration portal or configuration utility.
If errors occur after the installation, you can use the configuration utility to re-configure some of the settings.
Before you begin
  • If you want to configure a third-party identity provider during installation, obtain the identity provider configuration file in XML format from the provider and upload it to the seed node using a file transfer program, such as SFTP or SCP.
  • If you plan to use third-party identity certificates, obtain and upload on Avaya Aura® Device Services the required certificates. For more information about the required certificates, see Third-party CA-signed certificates.
  1. From the Avaya Aura® Device Services binary file, extract the template file.
    ADDITIONAL INFORMATION: ./aads-<version>.bin --tar xf -- ./installation.properties
  2. Edit the installation.properties file and configure the settings as described in the chapter Initial configuration with the Avaya Aura Device Services configuration utility.
    ADDITIONAL INFORMATION:
    You can leave some of the settings blank and then configure them manually after the installation is complete.
  3. Select whether you want to install Avaya Aura® Device Services in an Avaya Aura® environment as follows:
    • To install Avaya Aura® Device Services in an Avaya Aura® environment, set INCLUDE_AURA to y.
      In an Avaya Aura® environment, Avaya Aura® Device Services requires Avaya Aura® components, such as System Manager to operate.
    • To install Avaya Aura® Device Services in an environment without Avaya Aura®, set INCLUDE_AURA to n.
      In an environment without Avaya Aura®, Avaya Aura® Device Services does not require Avaya Aura® components to operate, but the features related to these components are not available.
  4. If you install Avaya Aura® Device Services in an Avaya Aura® environment, configure the following Avaya Aura®-related parameters:
    ADDITIONAL INFORMATION:
    • SYSTEM_MGR_IP: The System Manager IP address.
    • SYSTEM_MGR_HTTPS_PORT: The HTTPS port for contacting System Manager. The default value is 443.
    • SYSTEM_MGR_PW: The System Manager enrollment password.
    • KEYSTORE_PW: A keystore password for Avaya Aura® Device Services certificates. The minimum length is 6 characters.
      SESSION_MANAGER_IP: The Session Manager Management IP address.
    • ASSET_HOST_IP: The Session Manager Asset IP address.
  5. For cluster deployments, in DC_NAME , configure a Cassandra datacenter name for the node as follows:
    • To add the node to a new datacenter, provide a name of your choice for that datacenter.
    • To add the node to an existing datacenter, provide the name of one of existing datacenteres on Avaya Aura® Device Services.
    • To add the node to the default dc1 datacenter, leave the field blank.
    ADDITIONAL INFORMATION:
    Avaya Aura® Device Services logically groups nodes with the same Cassandra datacenter name and configures specific Cassandra replication policies for the members of the datacenter.
  6. If you deploy Avaya Aura® Device Services in an environment without Avaya Aura® or if you want to use third-party identity certificates in an Avaya Aura® environment, configure the following parameters:
    ADDITIONAL INFORMATION:
    • USE_SMGR: Set this parameter to n.
    • If you use identity certificates in PEM format, configure the following parameters:
      • REST_CERT_FILE: The full path to the third-party identity certificate for the REST interface.
      • REST_KEY_FILE: The full path to the key file for the REST interface certificate.
      • OAM_CERT_FILE: The full path to the third-party identity certificate for the OAMP interface.
      • OAM_KEY_FILE: The full path to the key file for the OAMP interface certificate.
      • NODE_CRT_FILE: The full path to the third-party identity certificate for the Avaya Aura® Device Services node.
      • NODE_KEY_FILE: The full path to the key file for the node interface certificate.
      • CA_CERT_FILE: The third-party CA certificate chain that contains all intermediate CA certificates followed by the root CA certificate.
    • If you use identity certificates in PKCS12 format, configure the following parameters:
      • REST_PKCS12_FILE: The full path to the third-party identity certificate for the REST interface.
      • REST_PKCS12_PWD: The password for the REST interface certificate.
      • OAM_PKCS12_FILE: The full path to the third-party identity certificate for the OAMP interface.
      • OAM_PKCS12_PWD: The password for the OAMP interface certificate.
      • NODE_PKCS12_FILE: The full path to the third-party identity certificate for the Avaya Aura® Device Services node.
      • NODE_PKCS12_PWD: The password for the node interface certificate.
      • CA_PKCS12_FILE: The third-party CA certificate chain that contains all intermediate CA certificates followed by the root CA certificate.
      • CA_PKCS12_PWD: The password for the third-party CA certificate chain.
    Note:
    You can use the same third-party identity certificate for REST, OAM, and NODE interfaces.
  7. To enable OAuth, set INCLUDE_OAUTH to y and configure the following parameters:
    ADDITIONAL INFORMATION:
    • KEYCLOAK_ADMIN: A user name of your choice for the initial Keycloak administrative account.
    • KEYCLOAK_ADMIN_PASSWD: A password of your choice for the Keycloak administrative account.
    • IMPORT_IDENTITY_PROVIDER: If you want to configure a third-party identity provider during installation, set this parameter to y. Otherwise set to n.
      If IMPORT_IDENTITY_PROVIDER is set to y, you must configure the following parameters:
      • FILE4_IDP_XML: The absolute path to the third-party identity provider configuration file in XML format.
      • LASTNAME_ATTR: The Last Name attribute to map the account on Keycloak using the identity provider SAML. For example: sn.
      • FIRSTNAME_ATTR: The First Name attribute to map the account on Keycloak using the identity provider SAML. For example: givenName.
      • ROLE_ATTR: The Membership attribute. For example: memberOf.
      • ROLE_USER_VALUE: The User Role value from the Membership attribute. It must be a full LDAP Distinguished Name (DN). For example: cn=users,dc=avaya,dc=com.
      • ROLE_ADMIN_VALUE: The Admin Role value from the Membership attribute. It must be a full LDAP DN. For example: cn=admins,dc=avaya,dc=com.
    • OAUTH_CLUSTER_ENABLED: OAuth database replication. If you are installing a cluster, set this parameter to y. Otherwise, set it to n.
    • USE_LDAP_FOR_AUTH: If you want to use LDAP for authentication, set this parameter to y.
      When INCLUDE_OAUTH is set to y, USE_LDAP_FOR_AUTH is set to n by default. You can also enable LDAP for authentication after installation using the Avaya Aura® Device Services web administration portal.
  8. To enable the Utility Server, set INCLUDE_UTILITY_SERVER to y.
  9. To install onboard Open LDAP, set INCLUDE_OPENLDAP to y and configure the following parameters:
    ADDITIONAL INFORMATION:
    • DIRECTORY_MANAGER: The name of the Open LDAP administrator.
    • OPENLDAP_DOMAIN: The domain name of your company.
      Avaya Aura® Device Services uses the two right-most dot-separated parts of the domain name. For example, if you enter division.company.com, Avaya Aura® Device Services converts this entry to cn=<Administrator password>,dc=company,dc=com.
    • OPENLDAP_ADMIN_PASSWD: The Open LDAP administrator password.
  10. If you configure a LDAP server and do not want to use if for contact search, set LDAP_CONTACT_SEARCH to n.
    ADDITIONAL INFORMATION:
    This also applies to onboard Open LDAP.
  11. Run the Avaya Aura® Device Services binary with a parameter that represents the full path to the properties file.
    For example:app install /home/avaya/installation.properties
  12. To start the Avaya Aura® Device Services service, run the following command:
    ADDITIONAL INFORMATION: svc aads start
  13. Manually configure the remaining items.
    ADDITIONAL INFORMATION:
    When possible, use the web administration portal to modify configuration settings instead of the configuration utility. For more information about using the web administration portal, see Administering Avaya Aura® Device Services.
Related links
Characters supported for Avaya Aura Device Services passwords