HCL BigFix

this connector integrates bigfix's rest api with swimlane turbine asset setup the asset for this connector requires the following inputs url 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 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 content type string optional type of the resource data body string required response data output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data site string required parameter for create analysis output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data dashboard id string required dashboard id is the id of the dashboard to which this variable belongs output parameter type description status code number http status code of the response reason string response reason phrase 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 file string required parameter for create file to custom site as master file name string required name of the resource output parameter type description status code number http status code of the response reason string response reason phrase 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 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 file string required parameter for create file to master site as master file name string required name of the resource output parameter type description status code number http status code of the response reason string response reason phrase 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 isclientfile boolean optional if isclientfile value true allows to make the file available for download by clients attachments array required file to be submitted file string required parameter for create file to operator site as non master file name string required name of the resource output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data site type string required type of the resource site name string required name of the resource output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data output parameter type description status code number http status code of the response reason string response reason phrase 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 site string optional parameter for get analyses output parameter type description status code number http status code of the response reason string response reason phrase 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 id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase 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 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 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 content type string optional type of the resource data body string required response data site string required site input analysis id string required analysis id input output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data site type string required type of the site containing the fixlet to be updated site name string required name of the site containing the fixlet to be updated fixlet id string required fixlet id input parameter output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data role id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase 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 content type string optional type of the resource data body string required response data site type string required type of the site (master action, external, custom, operator) site name string required name of the site to be updated output parameter type description status code number http status code of the response reason string response reason phrase 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 output parameter type description status code number http status code of the response reason string response reason phrase 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 notes for more information on hcl bigfix is found at hcl bigfix api documentation https //developer bigfix com/rest api/examples/