Creating a new xAgent upgrade job

You can create a new agent upgrade job from the Web UI. Before creating your xAgent upgrade jobs, use the CLI to configure the maximum number of pending upgrade tasks and the upgrade task inactive period.

Important

The maximum number of pending upgrade tasks and the upgrade task time-out period, can only be modified using the CLI.

After upgrading to Endpoint Security (HX) xAgent version 26 or later, the user must log on and log off the Windows endpoint to ensure xAgent notifications are started.

After you upgrade your Endpoint Security (HX) server to version 4.5 from version 4.0.2 or earlier, the host endpoint counts for completed upgrade jobs are incorrectly reset to zero. If an agent upgrade job is ongoing when the server is upgraded, the endpoint counts for the xAgent upgrade job reflect only the xAgent upgrades that complete after the server was upgraded (the xAgent upgrades that completed before the server was upgraded are lost). Host endpoint counts are correct for new xAgent upgrade jobs started after the server is upgraded.

Configuring the maximum number of pending upgrade tasks

To specify the maximum number of pending upgrade tasks:

Enable the CLI configuration mode:
hostname > enable
Set the maximum number of pending upgrade tasks:
hostname (config) # hx server upgrade task-limit <integer>
Replace <integer> with the maximum number of pending upgrade tasks. Valid values range from 0 through 100000. The default is 5000 tasks. Specifying 0 removes the limits and allows an unlimited number of pending upgrade tasks.
If you want to reset the setting to the default, enter this command:
hostname (config) # no hx server upgrade task-limit
Save your settings:
hostname (config) # write mem
Exit configuration mode:
hostname (config) # exit

Configuring the upgrade task time-out period

To specify the upgrade task time-out period:

Enable the CLI configuration mode:
hostname > enable
hostname # configure terminal
Set the upgrade task time-out period:
hostname (config) # hx server upgrade task-timeout <seconds>
where <seconds> is the number of seconds after which upgrade tasks time out. Valid values range from 0 through 31536000 seconds (one year). The default is 1209600 seconds (14 days). Specifying 0 removes the timeout period.
If you want to reset the setting to the default, enter this command:
hostname (config) # no hx server upgrade task-timeout
Save your settings:
hostname (config) # write mem
Exit configuration mode:
hostname (config) # exit

Creating an xAgent upgrade job

The Web UI xAgent Upgrade page allows you to create upgrade jobs for endpoint host sets on your Windows, macOS, or Linux platform. You can select host sets for your upgrade job. You can also select the OS platform and the xAgent software version. You can also change the default location the upgrade package and set an end date for your upgrade job from the xAgent Upgrade page.

To create a new upgrade job:

Log in to the Web UI as an administrator or operator.
From the Admin menu, select the Agent Upgrade page.
Click the Create upgrade button on the upper right side to access the Create Upgrade page.
Enter a job name in the Upgrade Name box.
Important
You must provide a name for your upgrade job before you can create it.
Under Select hosts to update, choose the host sets you want to upgrade. There is no default.
- In the Include Hosts box, select the checkbox beside one or more host sets that you want to include in this upgrade.
- In the Exclude Hosts box, select the checkbox beside one or more host sets that you want to exclude from this upgrade.
  Note
  Do not upgrade the xAgent software on contained hosts. Exclude currently contained hosts from any upgrade processes because the upgrade process will temporarily remove the endpoint from containment.
In the Upgrade to box, select the operating system platform running on the endpoints you want to upgrade.
Important
Two upgrade jobs for the same operating system platform cannot run at the same time. For example, if you have two Windows upgrade jobs, you must wait for one upgrade job to complete before starting the upgrade job for the second Windows upgrade job.
In the Select Version drop-down, select the xAgent version for this upgrade job. If there is no xAgent version available for the selected OS platform, the Select Version drop-down will be empty.
Important
Be sure to select a version of the xAgent that is supported on the endpoint host operating systems. See "Operating System Requirements" in the Endpoint Security Agent (HX) Deployment Guide for a list of operating systems supported by each xAgent release.
Under Specify installer location, click Set location, and then enter the URL of an alternate server where the upgrade package resides. The default location for the xAgent upgrade package is :\Program Files\FireEye\xagt.
Note
If you specify an alternate server, contact Customer Support for help creating the package to place on the alternate download server.
Under Set end date, click Set end time or leave it at Never (the default setting).
If you do not specify a time for the upgrade job to stop running, it will keep running, even if all host xAgent s have been upgraded. You must manually stop the upgrade job to end it.
Note
End time is based on Coordinated Universal Time (UTC).
Click Create.

You can view job details and start the upgrade job from the xAgent Upgrade page. See Viewing Upgrade Jobs for more information.

Note

You cannot specify a start time for upgrade jobs. You must manually start your upgrade jobs.

You can use xAgent upgrade settings in the CLI to change the following settings:

The maximum number of pending upgrade tasks.
The time period after which upgrade tasks time out.