13.1 Installation Information

Installation Information

Explanation

Install Docker and Docker Compose

Before installing ZENworks on a Linux Primary Server, you are required to install Docker and Docker Compose on the server. For more information on Dockers, see https://docs.docker.com/.

For more information on Installing Docker and Docker Compose see, Installing Docker and Docker Compose.

DNS Server is Configured

Ensure that a DNS server has been set on the server on which the ZENworks 2020 Update 3 Primary Server will be installed. Also, the hostname of the local machine should be resolvable over DNS.

Installation path

Several fixed installation paths are used:

/opt/microfocus/zenworks
/etc/opt/microfocus/zenworks
/var/opt/microfocus/zenworks
/var/opt/microfocus/log/zenworks

If you are concerned about disk space on the Linux server, the /var/opt directory is where the database and content repository reside.

Response file path (optional)

If you started the installation executable with the -s parameter, you are required to provide a path for the file. The default path is /root, which you can change to any path available on the current server.

The Primary Server software is not installed when you run the program to create a response file. It only displays the installation pages necessary to identify and create the response file.

Prerequisites

If the required prerequisites are not installed, you are not allowed to continue with the installation. The requirements that are not fulfilled are displayed (GUI) or listed (command line).

  • Ensure that you have installed Docker and Docker Compose before installing the ZENworks 2020 Update 3 Primary Server software. For more information on Installing Docker and Docker Compose see, Installing Docker and Docker Compose.

  • Ensure that the Docker Service is enabled at all times.

    1. To check the status of the Docker service, run the following command:

      $ sudo systemctl status docker.service
    2. To enable the service, run the following command:

      $ sudo systemctl enable docker.service
  • Ensure that the Docker service has started. To start the service run the following command:

    $ sudo systemctl start docker.service
  • Ensure that a DNS server has been set on the server on which the ZENworks 2020 Update 3 Primary Server will be installed. Also, the hostname of the local machine should be resolvable over DNS.

  • (Conditional) If you are using a shared content repository, ensure that you have mounted the shared content repository to the new Micro Focus path, that is, /var/opt/microfocus/zenworks/content-repo.

  • Ensure that you review the system requirements, before proceeding with the installation. For more information, see ZENworks 2020 Update 3 System Requirements

  • If you are using the embedded PostgreSQL database, review the prerequisites before proceeding with the installation. For more information, see Prerequisites for PostgreSQL.

If the .NET prerequisite is not fulfilled, you can click the ZENworks link in the description to install the runtime version that is bundled with ZENworks. After .NET is installed, the installation of ZENworks proceeds. This wizard might take a few seconds to launch.

Management Zone

New Zone: If you are installing to the first server in the zone, you need to know the name and password you want to use for the Management Zone. The password is used to log in to ZENworks Control Center.

Zone Name: The zone name has a 20-character limit and should be a unique name. The zone name can contain only the following special characters: - (dash) _ (underscore) . (period). The zone name cannot contain special characters such as ~ . ` ! @ # % ^ & * + = ( ) { } [ ] | \ : ; " ' < > , ? / $

For Embedded PostgreSQL, ensure that the zone name is unique in your environment.

IMPORTANT:While installing ZENworks in a non-English language operating system, ensure that the Management Zone name does not use special characters from any other non-English language.For example, while installing ZENworks on a simplified Chinese operating system, ensure that the Zone name does not use "üöä" from the German Character Set.

Zone Password: By default, the login user name is Administrator. After completing the installation, you can use ZENworks Control Center to add other administrator names that can be used to log in to the Management Zone. The zone administrator password must contain at least six characters and is limited to a maximum of 255 characters. The password can contain only one instance of the $ character.

Port Number: During the installation of subsequent Primary Servers, the server by default uses the ports used by first Primary Server. If the ports are in use on the second Primary Server, you are asked to specify another port. Note which port you specify because you will need to use it in the URL for accessing ZENworks Control Center from that Primary Server.

Existing Zone: If you are installing to an existing Management Zone, you need to know the following information:

  • The DNS name or IP address of an existing Primary Server in the zone. We recommend using the DNS name to provide ongoing synchronization with certificates that are signed with DNS names.

  • The ZENworks Administration Management port used by the existing Primary Server in the Management Zone or specify the port used to access ZCC.

  • A ZENworks administrator user name to log in to the zone. The default is Administrator. After completing the installation, you can use ZENworks Control Center to add other administrator names that can be used to log in to the Management Zone.

  • The password for the administrator you specified in the Username field.

Database Configuration Recommendation

You can enter the number of devices used in thousands. For example enter 1 for 1000 devices, 2 for 2000, and so on.The range of devices is between 1 to 100. Based on the number of devices, the database recommendation is displayed.

Database options

ZENworks requires a database. The database options are displayed only when installing the first Primary Server to the zone.

You have the following database options:

  • Embedded PostgreSQL: Automatically installs the embedded database on the local server.

    If you select the embedded database option, no further database installation pages are shown.

  • Remote PostgreSQL: This database must already exist on a server in your network. It can be on the current server.

    To select this option, you should already have followed the steps in Prerequisites for PostgreSQL.

    You also use this option for installing to an existing remote PostgreSQL database.

  • Microsoft SQL Server: You can create a new SQL database or specify an existing database that resides on a server in your network. It can be on the current server.

    Creating a new SQL database at this time provides the same results as the steps in Prerequisites for Microsoft SQL Server.

  • Oracle: Specifies a user schema that you can use to set up an external Oracle database schema for use with ZENworks.

    You can either create a new user schema or specify an existing one that resides on a server in your network.

    To select this option, you should already have followed the steps in Prerequisites for Oracle.

IMPORTANT:The following points must be considered for external databases:

  • The time on the server hosting the database must be synchronized with each of the Primary Servers in the Management Zone. The external database can also reside on the Primary Server machine.

  • If you have specified the database hostname, it must be DNS resolvable.

Database information

For the external database options (Remote PostgreSQL, Microsoft SQL Server, and Oracle), you need to know the information listed below. Defaults are provided for some of this information, which can be changed as necessary.

  • All Databases: The database server must have a PostgreSQL, Microsoft SQL, or Oracle database installed.

    • Server’s name. We recommend that you identify the server by its DNS name rather than its IP address, to be in sync with certificates that are signed with DNS names.

      IMPORTANT:If you later change your database server’s IP address or DNS name, ensure that your corporate DNS server is updated with this change to keep DNS for the database server in sync.

    • Port used by the database server.

      Port 54327 is the default for PostgreSQL and port 54327 is the default for Microsoft SQL Server.

      Change the default port number if you have a conflict.

  • (Optional) SQL Server Only: Named instance that is the name of the SQL server instance that is hosting the existing ZENworks database. You must specify the named instance if you want it to be something other than the default of mssqlserver.

  • Oracle Only: The name of the tablespace where you want the database to be created. The default is USERS.

  • New Database:   

    • The database administrator (Username field) must have read/write permissions in order to successfully perform the required operations on the database.

    • The administrator’s database password.

  • SQL Server or New Database:   

    • If you are using Windows authentication, specify the Windows domain where the user you specified in the Username field exists. If you are not using a Windows domain, specify the server’s short name.

    • Whether to use Windows or SQL Server authentication. For Windows authentication, provide the credentials for a user on the current device or in the domain. For SQL authentication, provide credentials that match those of a valid SQL user.

    It is important to know whether you installed the SQL Server by using SQL authentication, Windows authentication, or mixed. Be sure to select the option that coincides with your SQL Server options; otherwise, the authentication will fail.

Database access

For the external database options (Remote PostgreSQL, Microsoft SQL Server, and Oracle), you need to know the information listed below. Defaults are provided for some of this information, which can be changed as necessary.

  • All Databases: This server must have a PostgreSQL, Microsoft SQL, or Oracle database installed.

    • Database name. Replace zenworks_MY_ZONE with either the desired database name or an existing database name.

    • Database user name. This user must have read/write permissions to modify the database.

      If Windows authentication is also selected, the specified user must already exist when you create a new SQL database. The user is granted login access to SQL Server and read/write access to the ZENworks database that is created.

      For an existing database, specify a user with sufficient permissions to the database.

    • Database password. For a new database, this password is automatically generated if SQL authentication is selected. For an existing database, specify the password of an existing user with read/write permissions to the database.

  • PostgreSQL Databases Only: The name of your PostgreSQL database server.

  • Oracle Databases Only: The name of the tablespace where you want the database to be created. By default, it is USERS.

  • Microsoft SQL Databases Only:   

    • If you are using Windows authentication, specify the Windows domain where the user you specified in the Username field exists. If you are not using a Windows domain, specify the server’s short name.

    • Whether to use Windows or SQL Server authentication. For Windows authentication, provide the credentials for a user on the current device or in the domain. For SQL authentication, provide credentials that match those of a valid SQL user.

    It is important to know whether you installed the SQL Server by using SQL authentication, Windows authentication, or mixed. Be sure to select the option that coincides with your SQL Server options; otherwise, the authentication will fail.

SSL configuration (shown only for the first server installed in the Management Zone)

In order to enable SSL communications, an SSL certificate must be added to the ZENworks server. Select whether to use an internal or external certificate authority (CA).

For subsequent installations of Primary Servers to the Management Zone, the CA established by the first server’s installation is used for the zone.

IMPORTANT:After you install ZENworks , you can only change the internal certificate to an external certificate on Primary Servers. For more information, see Reconfiguring the Certificate Authority before and after it Expiresin the ZENworks Disaster Recovery Reference.

The Restore Default buttons restore the paths to those that were displayed when you first accessed this page.

Signed SSL certificate and private key

To enter a trusted CA-signed certificate and private key, click Choose to browse for and select the certificate and key files, or specify paths to the signed certificate to be used for this server (Signed SSL Certificate) and the private key associated with the signed certificate (Private Key).

For subsequent installations of Primary Servers to the zone, the CA established for the zone by the first server’s installation is used. If the zone is using an internal CA, you must provide the IP address or DNS name of the Primary Server with CA role. Otherwise, the wizard will not proceed further.

For information on creating external certificates to select when installing to a Linux server, see Section 12.0, Installing and Configuring an External ZENworks Database.

For information on creating external certificates for installing to a server using a silent installation, see Creating Your Response File.

Root certificate (optional)

To enter a trusted CA root certificate, click Choose to browse for and select it, or specify the path to the CA’s public X.509 certificate (CA Root Certificate).

SSL Configuration

The certificate validity should be between 1 and 10 years. If you plan to use the server as an MDM server, then to ensure communication with iOS and Mac devices, the certificate validity should not exceed 2 years.

Pre-installation summary

GUI Installation: To make changes to any information entered up to this point, click Previous. After you click Install, the installation of the files begins. During installation, you can click Cancel to stop, which leaves the files on your server that were installed up to that point.

Command Line Installation: If you want to make changes to any information entered up to this point, you can type back and press Enter as many times as necessary. As you progress forward through the commands again, press Enter to accept the decisions that you previously made.

Installation complete (roll back option)

If installation errors occurred, this page is displayed at this time; otherwise, it is displayed after the Post-Installation Actions page.

Installation Recovery: For both the GUI and command line installations, if there are serious installation errors, you can roll back the installation to return your server to its previous state. This option is provided on a different installation page. Otherwise, you have two options:

  • If a previous installation was cut short and you install again, you might be given the option to reset the installation, depending on how far you got in the canceled installation. If you select to reset, this overwrites any configuration that might have occurred during the canceled installation.

  • To undo a successfully completed installation, follow the instructions in the ZENworks Uninstall Guide.

If there were serious installation errors, select Roll Back, which returns your server to its previous state. Upon exiting the installation program, the server is not rebooted. However, to complete the installation, you must reboot the server.

To determine whether to continue the installation or roll it back, review the log file that lists the errors to determine if any installation failures were significant enough for your action. If you select to continue, resolve the issues that are noted in the log after you have rebooted the server and completed the installation process.

To access the log file in the GUI installation, click View Log. In the command line installation, the path to the log file is displayed.

Post installation actions

Options are presented for selecting actions to perform after the installation has successfully completed:

  • For the GUI installation, a page displays the options listed below. Some items are selected by default. Click any check box to select or deselect the option, then click Next to continue.

  • For a command line installation, the options are listed with option numbers. Select or deselect an option by typing its number to toggle its selection status. After configuring the selections, press Enter without typing a number to continue.

Select from the following possible actions:

  • Run ZENworks Control Center: Opens ZENworks Control Center immediately if you select to reboot manually or you installed to a Linux server. For a Linux installation without a GUI, a GUI-enabled device must be used to run ZENworks Control Center.

    For the Oracle database, the administrator names are case sensitive. The default ZENworks administrator account that was automatically created during installation uses an initial capital letter. In order to log in to ZENworks Control Center, you must enter Administrator.

  • View Readme file: For GUI installations, it opens the ZENworks Readme in your default browser. For a Linux command line installation, the URL to the Readme is listed.

  • View Installation log: Displays the installation log in your default XML viewer (GUI installation) after rebooting, or immediately if you select to reboot manually. For a Linux command line installation, the information is simply listed.

ZENworks System Status Utility

Allows you to launch a ZENworks services heartbeat check prior to closing the installation program. Results are posted in the installation log.

Rebooting (or not)

Upon a successful installation, you can select between rebooting immediately or later:

  • Yes, Restart the System: If you select this option, log in to the server when prompted. The first time you log in to the server, it takes a few minutes because the database is being populated with inventory data.

  • No, I Will Restart the System Myself: If you select this option, the database is immediately populated with inventory data.

    NOTE:This option is displayed only for Windows devices.

The process of populating the database can cause high CPU utilization during a reboot or immediately after the installation program closes if you select not to reboot. This database updating process can slow down the starting of the services and access to ZENworks Control Center.

The Patch Management downloads might also cause high CPU utilization, usually shortly after rebooting.

Installation completion

The actions you selected previously are performed after all of the files have been installed for ZENworks (if selected).

IMPORTANT:If you installed to a Linux server using the command line, and if you plan to run any zman commands in the current session, you need to get the newly installed /opt/microfocus/zenworks/bin directory into your session’s path. Log out of your session and log back in to reset the PATH variable.

NOTE:After installing the first Primary Server in the zone, the ZooKeeper service is by default enabled on this server. Ensure that the ZooKeeper service is up and running at all times to enable proper functioning of various ZENworks components. To verify the status of the ZooKeeper service, see the Diagnostics page in ZCC. For more information on the ZooKeeper component, see the ZENworks Primary Server and Satellite Reference.

If the Primary Servers in your zone are unable to communicate with the ZooKeeper service due to firewall restrictions, you can run the following configure action to open the ZooKeeper ports:You also need to ensure that the firewall allows client connections from other Primary Servers to the ZooKeeper services on port 6789. If the Primary Servers in your zone are unable to access the ZooKeeper service, then to open the ports, you can run the following Configure action on the server in which ZooKeeper is enabled.

            microfocus-zenworks-configure -c ClusterFirewallConfigureAction -Doperation=add -Dservice=zookeeper
          

However, if the Primary Server that is within the DMZ is unable to access the ZooKeeper service within the corporate network, then you need to manually open the port 6789 in the corporate firewall.

For more information on the ZooKeeper ports, see ZENworks 2020 TCP and UDP Ports.