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 notes for more information on hcl bigfix is found at https //developer bigfix com/rest api/examples/ 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 {"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","path parameters" {"site" ""}} 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 {"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","path parameters" {"dashboard id" ""}} 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 {"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","path parameters" {"site type" "custom","site name" "name of the site"}} 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 {"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 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 {"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 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 {"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" {}} 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 {"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","path parameters" {"site" "1","analysis id" "0413"}} 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 {"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","path parameters" {"site type" "","site name" "","fixlet id" ""}} 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 {"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","path parameters" {"role id" ""}} 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 {"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","path parameters" {"site type" "","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" {}} 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