Hcl Bigfix

This Connector integrates BigFix's Rest API with Swimlane Turbine.

Asset Setup

The asset for this Connector requires the following inputs:

Username

Password

Capabilities

This Connector provides the following capabilities:

Create Action

Create Analysis

Create Dashboard Variable

Create File to Custom Site as Master

Create File to Master Site as Master

Create File to Operator Site as Non Master

Create Fixlet

Create Operator

Create Role

Create Site

Get Analyses

Get Computer

Get Computers

Get Sites

Update Analysis ... and so on

Important Points

To use the actions taking the xml file or xml file content as input, we have to pass the XML content of the file in string format as input under the data_body parameter.

Notes

For more information on HCL BigFix is found at: HCL BigFix API Documentation

Additional Documentation

Hcl Bigfix Connector Documentation

Hcl Bigfix API Documentation

Configurations

HCL BigFix HTTP Basic Authentication

Authenticates using username and password.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
username	The username for authentication	string	Required
password	The password for authentication	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Create Action

Create and execute an action contained in action.xml.

Endpoint

URL: /api/actions

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data

Input Example

{"headers":{"Content-Type":"application/x-www-form-urlencoded"},"data_body":"<?xml version=\"1.0\" ?>\\n<all>\\n\\t<name type=\"str\">John</name>\\n\\t<age type=\"int\">30</age>\\n\\t<city type=\"str\">New York</city>\\n</all>\\n"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create Analysis

Create a new analysis for a site.

Endpoint

URL: /api/analyses/{{site}}

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data
path_parameters.site	string	Required	Parameters for the Create Analysis action

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create Dashboard Variable

Creates a new dashboard variable with the contents of dashvar.xml. Adds the variable to the specified dashboard ID if the ID already exists, otherwise creates a dashboard ID with the specified dashboard variable.

Endpoint

URL: /api/dashboardvariables/{{dashboard_ID}}

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data
path_parameters.dashboard_ID	string	Required	Dashboard ID is the ID of the dashboard to which this variable belongs.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create File to Custom Site as Master

To add a file to a custom site as master operator.

Endpoint

URL: /api/site/custom/test/file/file.my

Method: POST

Input

Argument Name	Type	Required	Description
verify	boolean	Optional	Parameter for Create File to Custom Site as Master
attachments	array	Required	File to be submitted
attachments.file	string	Required	Parameter for Create File to Custom Site as Master
attachments.file_name	string	Required	Name of the resource

Input Example

{"verify":false}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create File to Master Site as Master

To add a file to the master action site as master operator

Endpoint

URL: /api/site/master/file/file.my

Method: POST

Input

Argument Name	Type	Required	Description
verify	boolean	Optional	Parameter for Create File to Master Site as Master
parameters.force	boolean	Optional	force value true allows to override the file it if already exists in the site.
attachments	array	Required	File to be submitted
attachments.file	string	Required	Parameter for Create File to Master Site as Master
attachments.file_name	string	Required	Name of the resource

Input Example

{"parameters":{"force":true},"verify":false}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create File to Operator Site as Non Master

To add a file to the operator site as non master operator.

Endpoint

URL: /api/site/operator/nmo/file/file.my

Method: POST

Input

Argument Name	Type	Required	Description
verify	boolean	Optional	Parameter for Create File to Operator Site as Non Master
parameters.isClientFile	boolean	Optional	if isClientFile value true allows to make the file available for download by Clients.
attachments	array	Required	File to be submitted
attachments.file	string	Required	Parameter for Create File to Operator Site as Non Master
attachments.file_name	string	Required	Name of the resource

Input Example

{"parameters":{"isClientFile":true},"verify":false}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create Fixlet

This command will genereate a POST request to create a fixlet specified by new.xml in the site site type/site name.

Endpoint

URL: /api/fixlets/{{site_type}}/{{site_name}}

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data
path_parameters.site_type	string	Required	Parameters for the Create Fixlet action
path_parameters.site_name	string	Required	Parameters for the Create Fixlet action

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create Operator

Creates a new operator. This operation requires master operator privileges.

Endpoint

URL: /api/operators

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create Role

This command will POST the input file to the server to create a new role.

Endpoint

URL: /api/roles

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Create Site

Creates the specified site on the server with the contents of input xml file.

Endpoint

URL: /api/sites

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Get Analyses

Get a site's available analyses.

Endpoint

URL: /api/analyses/{{site}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.site	string	Optional	Parameters for the Get Analyses action

Input Example

{"path_parameters":{"site":"site_name"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Get Computer

Gets the properties of a specific computer registered in the console.

Endpoint

URL: /api/computer/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	Parameters for the Get Computer action

Input Example

{"path_parameters":{"id":"xyz"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Get List Computers

Retrieves the list of computers registered in the console.

Endpoint

URL: /api/computers

Method: GET

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Get Sites

Gets the current list of sites on the server.

Endpoint

URL: /api/sites

Method: GET

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Update Analysis

Update a previously created analysis.

Endpoint

URL: /api/analysis/{{site}}/{{analysis_id}}

Method: PUT

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data
path_parameters.site	string	Required	Site input
path_parameters.analysis_id	string	Required	Analysis ID input

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Update Fixlet

This action will generate a PUT request to update the fixlet found with the id of fixlet id under site type/site name, replacing it with an updated fixlet specified in update.xml file.

Endpoint

URL: /api/fixlet/{{site_type}}/{{site_name}}/{{fixlet_id}}

Method: PUT

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data
path_parameters.site_type	string	Required	Type of the site containing the fixlet to be updated.
path_parameters.site_name	string	Required	Name of the site containing the fixlet to be updated.
path_parameters.fixlet_id	string	Required	Fixlet ID input parameter.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Update Role

This command will POST the input xml file (can be a partial XML) to the server to update an existing role.

Endpoint

URL: /api/role/{{role_id}}

Method: PUT

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data
path_parameters.role_id	string	Required	Parameters for the Update Role action

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Update Site

Updates an existing site on the server with the contents of input xml file.

Endpoint

URL: /api/site/{{site_type}}/{{site_name}}

Method: PUT

Input

Argument Name	Type	Required	Description
headers	object	Optional	HTTP headers for the request
headers.Content-Type	string	Optional	HTTP headers for the request
data_body	string	Required	Response data
path_parameters.site_type	string	Required	Type of the site (Master Action, External, Custom, Operator).
path_parameters.site_name	string	Required	Name of the site to be updated.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

upload files

Upload one or more files to the server.

Endpoint

URL: /api/upload

Method: POST

Input

Argument Name	Type	Required	Description
file_contents	array	Required	Response content

Input Example

{"file_contents":["<?xml version=\"1.0\" ?>\n<all>\n\t<name type=\"str\">John</name>\n\t<age type=\"int\">30</age>\n\t<city type=\"str\">New York</city>\n</all>\n"]}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 19 Feb 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}

Response Headers

Header	Description	Example
content-length	The length of the response body in bytes	140
content-type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Mon, 19 Feb 2023 20:37:23 GMT