Skip to main content

HCL BigFix

App Vendor: HCL BigFix

App Category: IT Services

Connector Version: 1.0.0

API Version: BigFix REST API v9.x

About App

The HCL BigFix app delivers real-time endpoint management and security in a unified platform. This app enables seamless interaction through automated actions and on-demand data access, helping streamline management tasks, execute queries, and support flexible automation workflows from a single interface.

The HCL BigFix app is configured with Cyware Orchestrate to perform the following actions:

Action Name

Description

Create Action

This action creates a new BigFix action from scratch.

Delete Action

This action stops and deletes a specified BigFix action.

Execute Session Relevance Query

This action evaluates a session relevance expression and returns the resulting data from the BigFix environment.

Generic Action

This is a generic action used to make requests to any HCL BigFix endpoint.

Get Action Status

This action retrieves the execution status of a specified BigFix action against its targets.

Get Computer Details

This action retrieves detailed information for a specific computer.

Get Fixlet Details

This action retrieves the specific details, properties, and definitions of a single fixlet or patch.

Get Site

This action retrieves the metadata and configuration details for a specific BigFix site.

List Computers

This action retrieves a list of computers and their last report times from the BigFix environment.

List Fixlets

This action retrieves a list of all fixlets associated with a specific BigFix site.

List Sites

This action retrieves a list of all visible BigFix sites and their associated site types.

Stop Action

This action stops the execution of an active BigFix action.

Configuration Parameters

The following configuration parameters are required for the HCL BigFix app to communicate with the HCL BigFix enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL

Enter the base URL to connect with the HCL BigFix API.

Example:

https://bigfix.company.com:52311/api

Text

Required

Username

Enter the username to authenticate the HCL BigFix service or console account.

Text

Required

Password

Enter the password to access the HCL BigFix application

Password

Required

Timeout

Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with HCL BigFix.

Integer

Optional

Allowed range:

15-120

Default value:

15

Verify

Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in connection errors.

Boolean

Optional

Allowed values are true and false.

By default, verification is enabled.

Action: Create Action

This action creates a new BigFix action from scratch.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

XML Body 

Enter the BES XML payload to define the action to execute.

Text

Required

Action: Delete Action

This action stops and deletes a specified BigFix action.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Action ID

Enter the unique identifier of the action to remove it from the system.

Integer

Required

Action: Execute Session Relevance Query

This action evaluates a session relevance expression and returns the resulting data from the BigFix environment.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Relevance Expression

Enter the session relevance expression to evaluate and query data from BigFix.

Text

Required

Action: Get Action Status

This action retrieves the execution status of a specified BigFix action against its targets.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Action ID

Enter the unique identifier of the action to fetch its current status.

Integer

Required

Fields

Enter the specific property names to filter the response.

Example:

status, computer

Text

Optional

Action: Get Computer Details

This action retrieves detailed information for a specific computer.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Computer ID

Enter the unique BigFix computer identifier to retrieve details for a specific machine.

Integer

Required

Action: Get Fixlet Details

This action retrieves the specific details, properties, and definitions of a single fixlet or patch.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Fixlet ID

Enter the unique fixlet or patch identifier to fetch its details.

Integer

Required

Site Type

Enter the site type to retrieve the resource.

Text

Optional

Site Name

Enter the site name to fetch fixlets for.

Text

Optional

Action: Get Site

This action retrieves the metadata and configuration details for a specific BigFix site.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Site Type

Enter the site type to retrieve the resource.

Text

Required

Site Name

Enter the site name to identify the specific site.

Text

Optional

Action: List Computers

This action retrieves a list of computers and their last report times from the BigFix environment.

Action Input Parameters

No input parameters are required for this action.

Action: List Fixlets

This action retrieves a list of all fixlets associated with a specific BigFix site.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Site Type

Enter the site type to retrieve the resource.

Text

Required

Site Name

Enter the site name to fetch fixlets for.

Text

Optional

Action: List Sites

This action retrieves a list of all visible BigFix sites and their associated site types.

Action Input Parameters

No input parameters are required for this action.

Action: Stop Action

This action stops the execution of an active BigFix action.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Action ID

Enter the unique identifier of the action to stop its execution.

Integer

Required

Action: Generic Action

This is a generic action used to make requests to any HCL BigFix endpoint.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Method

Enter the HTTP method to make the request.

Text

Required

Allowed values:

GET, PUT, POST, DELETE

Endpoint

Enter the endpoint to make the request to.

Example:

/sites

Text

Required

Query Params

Enter the query parameters to pass to the API.

Key Value

Optional

Payload

Enter the payload to pass to the API.

Any

Optional

Extra Fields

Enter the extra fields to pass to the API.

Key Value

Optional

Allowed keys:

headers, payload_data, custom_output, download, filename, files, retry_wait, retry_count, and response_type