upgrade Audit

Prev Next

Upgrades the agents on host endpoints.

This audit cannot be imported into a data acquisition script. See Audits That Cannot Be Imported on page 1.

Supported Platforms

Windows, macOS, and Linux

Input Parameters

The following input parameters are available for this audit.

Type Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

yes

This parameter is required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

"upgrade"

Specify the requested upgrade action. The only valid value is "upgrade".

Component Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

yes

This parameter is required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

"agentmsi"

Specify the component you are upgrading. The only valid value is "agentmsi".

Version Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

yes

This parameter is required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

Specify the FireEye Endpoint Agent version to which you are upgrading.

Platform Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

yes

This parameter is required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

"win32" "win64" "osx" "linux"

Specify the platform on which you are upgrading.

HashAlgorithm Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

yes

This parameter is required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

"md5" "sha1" "sha256" "sha384" "sha512"

Specify the algorithm used for hashing the agent image (*.cms) file.

HashValue Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

yes

This parameter is required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

Specify the hash value used for hashing the agent image (*.cms) file.

Length Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

ByteSize

Valid values are specified in bytes.

Required?

yes

This parameter is required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

Specify the size, in bytes, of the agent image (*.cms) file.

Location Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

yes

This parameter is required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

Specify the URL where the agent image (*.cms) file can be found.