{ "type": "workflow_collections", "data": [ { "@type": "WorkflowCollection", "name": "FortiGate(FOS)-Helpers", "description": "", "visible": true, "image": null, "recordTags": [], "workflows": [ { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - general purpose api call", "aliasName": null, "tag": null, "description": "Using variable perform a single API call to FOS using the GUI username/password...", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "http_method", "api_resource", "data_payload", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/377c70fa-1d56-4db1-9189-c53bbc119987", "steps": [ { "@type": "WorkflowStep", "name": "get_fos_data", "description": null, "arguments": { "params": { "url": "{{vars.api_url}}", "body": "{{vars.api_payload}}", "method": "{{vars.http_method}}", "params": "", "verify": false, "headers": "{{vars.api_header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "120", "left": "340", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "223e09ff-3738-4139-95d8-6aa7b7e07310" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "api_url": "https://{{vars.fos_ip}}/api/v2/{{vars.api_resource}}", "api_header": "{\n \"Content-Type\": \"application/json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}", "api_payload": "{{vars.input_payload}}" }, "status": null, "top": "80", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "3e505316-960c-4ba7-a1b7-b53099db5ede" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{%- set idx = {} -%}\n{%- set _do = idx.update({\n \"output\":vars.steps.get_fos_data.data,\n \"params\":{\n \"fos_ip\":vars.fos_ip,\n \"api_resource\":vars.api_resource,\n \"http_method\":vars.http_method,\n \"api_payload\":vars.api_payload\n } \n}) -%}\n{{idx}}", "params": "{{vars.input.params}}" }, "status": null, "top": "120", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "0e36343d-0971-410c-afef-e9e7bc830643" }, { "@type": "WorkflowStep", "name": "setup_vars", "description": null, "arguments": { "token": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}", "http_method": "{%- set vin = vars.input.params['http_method'] -%}\n{%- if vin not in vars.empty -%}\n{{vin|upper}}\n{%- else -%}\nGET\n{%- endif -%}", "api_resource": "{{vars.input.params['api_resource']}}", "input_payload": "{%- set vin = vars.input.params['data_payload'] -%}\n{%- if vin not in vars.empty -%}\n{{vin}}\n{%- else -%}\n{}\n{%- endif -%}" }, "status": null, "top": "40", "left": "340", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "7c34c162-43ce-408b-bb77-c5e39fa53179" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "__triggerLimit": true, "step_variables": { "empty": "['',None,Null]", "input": { "params": [] } }, "triggerOnSource": true, "triggerOnReplicate": false }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "377c70fa-1d56-4db1-9189-c53bbc119987" } ], "routes": [ { "@type": "WorkflowRoute", "name": "get_fos_data -> return", "targetStep": "/api/3/workflow_steps/0e36343d-0971-410c-afef-e9e7bc830643", "sourceStep": "/api/3/workflow_steps/223e09ff-3738-4139-95d8-6aa7b7e07310", "label": null, "isExecuted": false, "group": null, "uuid": "d128aa21-47cc-54b6-b40b-0a048c8dbf15" }, { "@type": "WorkflowRoute", "name": "header_payload -> get_fos_data", "targetStep": "/api/3/workflow_steps/223e09ff-3738-4139-95d8-6aa7b7e07310", "sourceStep": "/api/3/workflow_steps/3e505316-960c-4ba7-a1b7-b53099db5ede", "label": null, "isExecuted": false, "group": null, "uuid": "7f20f25e-bebd-5484-86c8-b033787ac66a" }, { "@type": "WorkflowRoute", "name": "setup_vars -> header_payload", "targetStep": "/api/3/workflow_steps/3e505316-960c-4ba7-a1b7-b53099db5ede", "sourceStep": "/api/3/workflow_steps/7c34c162-43ce-408b-bb77-c5e39fa53179", "label": null, "isExecuted": false, "group": null, "uuid": "9294a296-d7ab-53fb-89ee-036e5265f781" }, { "@type": "WorkflowRoute", "name": "Start -> setup_vars", "targetStep": "/api/3/workflow_steps/7c34c162-43ce-408b-bb77-c5e39fa53179", "sourceStep": "/api/3/workflow_steps/377c70fa-1d56-4db1-9189-c53bbc119987", "label": null, "isExecuted": false, "group": null, "uuid": "eddb2e5b-8d38-5131-b6e7-551cc03424d2" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "151670c9-9fc7-4529-90c0-0a6aae434610", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - get firmware", "aliasName": null, "tag": null, "description": "Retrieve the FOS Firmware", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/aa72bdc7-1bb3-4a33-bfdc-9dbd0ceaaaff", "steps": [ { "@type": "WorkflowStep", "name": "get_fos_data", "description": null, "arguments": { "params": { "url": "https://{{vars.fos_ip}}/api/v2/monitor/system/firmware", "body": "{{vars.payload}}", "method": "GET", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "180", "left": "640", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "57517aa8-cc0c-4e96-9a03-272353857425" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}", "payload": "{}" }, "status": null, "top": "40", "left": "640", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "10f6200f-2ce6-451f-a7f3-474bafaefc16" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.get_fos_data.data.results.current}}" }, "status": null, "top": "120", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "1ae516c2-5c11-4155-b9e0-e51f60bed25f" }, { "@type": "WorkflowStep", "name": "setup_vars", "description": null, "arguments": { "token": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}", "api_url": "https://{{vars.fos_ip}}/api/v2/monitor/system/firmware" }, "status": null, "top": "40", "left": "340", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "79191ba3-c839-4612-affe-3bbb31fc418c" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "aa72bdc7-1bb3-4a33-bfdc-9dbd0ceaaaff" } ], "routes": [ { "@type": "WorkflowRoute", "name": "get_fos_data -> return", "targetStep": "/api/3/workflow_steps/1ae516c2-5c11-4155-b9e0-e51f60bed25f", "sourceStep": "/api/3/workflow_steps/57517aa8-cc0c-4e96-9a03-272353857425", "label": null, "isExecuted": false, "group": null, "uuid": "4fdd710c-1d25-5279-bdf1-ed64cf177f58" }, { "@type": "WorkflowRoute", "name": "header_payload -> get_fos_data", "targetStep": "/api/3/workflow_steps/57517aa8-cc0c-4e96-9a03-272353857425", "sourceStep": "/api/3/workflow_steps/10f6200f-2ce6-451f-a7f3-474bafaefc16", "label": null, "isExecuted": false, "group": null, "uuid": "52821494-4347-5796-aa62-ed762779c8e3" }, { "@type": "WorkflowRoute", "name": "setup_vars -> header_payload", "targetStep": "/api/3/workflow_steps/10f6200f-2ce6-451f-a7f3-474bafaefc16", "sourceStep": "/api/3/workflow_steps/79191ba3-c839-4612-affe-3bbb31fc418c", "label": null, "isExecuted": false, "group": null, "uuid": "558281b1-a845-572b-8828-3d144b41529b" }, { "@type": "WorkflowRoute", "name": "Start -> setup_vars", "targetStep": "/api/3/workflow_steps/79191ba3-c839-4612-affe-3bbb31fc418c", "sourceStep": "/api/3/workflow_steps/aa72bdc7-1bb3-4a33-bfdc-9dbd0ceaaaff", "label": null, "isExecuted": false, "group": null, "uuid": "f5ca1dc0-efc1-59c9-a588-13c77761ace1" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "1e2f65fc-8727-4587-ac09-c7dc485dc1b7", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - bootstrap fortimanager", "aliasName": null, "tag": null, "description": "Perform a FortiDeploy style API change to the Central Management", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "fmg", "fmg_sn", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/6174753a-b754-4eba-aeda-8f4fb8f70c63", "steps": [ { "@type": "WorkflowStep", "name": "bootstrap by firmware", "description": null, "arguments": { "conditions": [ { "option": "/cmdb", "default": true, "step_iri": "/api/3/workflow_steps/7a1d1136-c691-49de-aa27-d42928cc366f", "step_name": "bootstrap_cmdb" }, { "option": "/monitor", "step_iri": "/api/3/workflow_steps/4a979177-3410-4eae-b92c-f4ee45ccc865", "condition": "{{ vars.legacy_version }}", "step_name": "bootstrap_legacy_monitor" } ], "step_variables": [] }, "status": null, "top": "240", "left": "660", "stepType": "/api/3/workflow_step_types/12254cf5-5db7-4b1a-8cb1-3af081924b28", "group": null, "uuid": "3732cb69-df0f-4dbb-8211-35c1061ee614" }, { "@type": "WorkflowStep", "name": "bootstrap_cmdb", "description": null, "arguments": { "arguments": { "fmg": "{{vars.fmg}}", "apikey": "{{vars.apikey}}", "fos_ip": "{{vars.fos_ip}}", "fmg_serial": "{{vars.fmg_sn}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/5f0f1671-a2a6-4fae-aaf6-0aedfc35b20b" }, "status": null, "top": "420", "left": "660", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "7a1d1136-c691-49de-aa27-d42928cc366f" }, { "@type": "WorkflowStep", "name": "bootstrap_legacy_monitor", "description": null, "arguments": { "arguments": { "fmg": "{{vars.fmg}}", "apikey": "{{vars.apikey}}", "fos_ip": "{{vars.fos_ip}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/465ebe93-8cb2-4f80-8448-fdc98434ea6e" }, "status": null, "top": "240", "left": "260", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "4a979177-3410-4eae-b92c-f4ee45ccc865" }, { "@type": "WorkflowStep", "name": "check version", "description": null, "arguments": { "legacy_version": "{%- set v = vars.version -%}\n{%- if v[0] == 7 and v[1] == 2 and v[2] < 8 -%}\ntrue\n{%- elif v[0] == 7 and v[1] == 4 and v[2] < 4 -%}\ntrue\n{%- else -%}\nfalse\n{%- endif -%}" }, "status": null, "top": "60", "left": "980", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "5d4d680c-f449-4d75-b725-f51c8bebd7b1" }, { "@type": "WorkflowStep", "name": "get fos version", "description": null, "arguments": { "arguments": { "apikey": "{{vars.apikey}}", "fos_ip": "{{vars.fos_ip}}" }, "apply_async": false, "step_variables": { "version": "{%- set ver = [\n vars.steps.get_fos_version.output.major,\n vars.steps.get_fos_version.output.minor,\n vars.steps.get_fos_version.output.patch\n] -%}\n{{ver}}" }, "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/1e2f65fc-8727-4587-ac09-c7dc485dc1b7" }, "status": null, "top": "60", "left": "660", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "f923ce50-92d9-4d5d-b713-f80c48747ef9" }, { "@type": "WorkflowStep", "name": "setup env", "description": null, "arguments": { "fmg": "{{vars.input.params.fmg}}", "apikey": "{{vars.input.params.apikey}}", "fmg_sn": "{{vars.input.params['fmg_sn']}}", "fos_ip": "{{vars.input.params['fos_ip']}}" }, "status": null, "top": "60", "left": "340", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "2c0fa857-e026-43fc-8718-7e3de4dfa9b4" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "6174753a-b754-4eba-aeda-8f4fb8f70c63" } ], "routes": [ { "@type": "WorkflowRoute", "name": "bootstrap by firmware -> bootstrap_cmdb", "targetStep": "/api/3/workflow_steps/7a1d1136-c691-49de-aa27-d42928cc366f", "sourceStep": "/api/3/workflow_steps/3732cb69-df0f-4dbb-8211-35c1061ee614", "label": "/cmdb", "isExecuted": false, "group": null, "uuid": "e213a671-3eeb-52c4-bd71-2c4f007ab9df" }, { "@type": "WorkflowRoute", "name": "bootstrap by firmware -> bootstrap_legacy_monitor", "targetStep": "/api/3/workflow_steps/4a979177-3410-4eae-b92c-f4ee45ccc865", "sourceStep": "/api/3/workflow_steps/3732cb69-df0f-4dbb-8211-35c1061ee614", "label": "/monitor", "isExecuted": false, "group": null, "uuid": "1a8e771a-058a-5be8-82cc-70cf4c5efad7" }, { "@type": "WorkflowRoute", "name": "check version -> bootstrap by firmware", "targetStep": "/api/3/workflow_steps/3732cb69-df0f-4dbb-8211-35c1061ee614", "sourceStep": "/api/3/workflow_steps/5d4d680c-f449-4d75-b725-f51c8bebd7b1", "label": null, "isExecuted": false, "group": null, "uuid": "63b12377-8455-535f-8442-99e3605dd258" }, { "@type": "WorkflowRoute", "name": "get fos version -> check version", "targetStep": "/api/3/workflow_steps/5d4d680c-f449-4d75-b725-f51c8bebd7b1", "sourceStep": "/api/3/workflow_steps/f923ce50-92d9-4d5d-b713-f80c48747ef9", "label": null, "isExecuted": false, "group": null, "uuid": "9beece30-a8e2-57fb-ba8b-9e8e896a7001" }, { "@type": "WorkflowRoute", "name": "setup env -> get fos version", "targetStep": "/api/3/workflow_steps/f923ce50-92d9-4d5d-b713-f80c48747ef9", "sourceStep": "/api/3/workflow_steps/2c0fa857-e026-43fc-8718-7e3de4dfa9b4", "label": null, "isExecuted": false, "group": null, "uuid": "3a14e933-2ae6-522b-8735-813683df5f63" }, { "@type": "WorkflowRoute", "name": "Start -> setup env", "targetStep": "/api/3/workflow_steps/2c0fa857-e026-43fc-8718-7e3de4dfa9b4", "sourceStep": "/api/3/workflow_steps/6174753a-b754-4eba-aeda-8f4fb8f70c63", "label": null, "isExecuted": false, "group": null, "uuid": "57a9dc38-f5b2-525a-863b-31e0bec8b87f" } ], "groups": [ { "@type": "WorkflowGroup", "name": "Legacy Version Check", "description": "Versions less than the following are consider legacy bootstrap:\n less than 7.4.4\n less than 7.2.8", "type": "note", "isCollapsed": false, "hasTriggerStep": false, "hideInLogs": false, "metadata": [], "reusable": false, "top": "140", "left": "960", "height": "186", "width": "360", "uuid": "fe1031b2-adc0-4e8f-a9b8-f65b969562f3", "recordTags": [] } ], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "391a2eed-35ff-42cf-be33-bbe61bd79870", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "Button for FG Revision Save", "aliasName": null, "tag": null, "description": "Save a revision on the FG via the API.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [], "synchronous": false, "triggerStep": "/api/3/workflow_steps/571742bb-73ec-4ffd-9b9a-c595a510d46b", "steps": [ { "@type": "WorkflowStep", "name": "parse_input", "description": null, "arguments": { "ip_list": "{{vars.input.params.fortigateIP.split(\",\")}}" }, "status": null, "top": "40", "left": "400", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "2d46537f-b05c-474a-90eb-47942e7c00a3" }, { "@type": "WorkflowStep", "name": "save_revision", "description": null, "arguments": { "arguments": { "fos_ip": "{{vars.item}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}", "revision_name": "{{vars.input.params.revisionName}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/8d3d9226-b79a-475b-b9da-292decd7c52c", "for_each": { "item": "{{vars.ip_list}}", "__bulk": false, "parallel": true, "condition": "" } }, "status": null, "top": "180", "left": "400", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "b1d7463c-5a6c-4e73-82a0-7c4d53dda38d" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "route": "b3b1ac24-f2d4-468c-81b0-8acfab5a2aca", "title": "FOS Helper - Revision Save", "resources": [ "devices", "managers" ], "__triggerLimit": true, "inputVariables": [ { "name": "fortigateIP", "type": "string", "label": "Fortigate IP", "title": "Text Area", "usable": false, "tooltip": "FortiGate IP or IPs using a comma seperated list.", "dataType": "text", "formType": "textarea", "required": true, "_expanded": true, "mmdUpdate": false, "collection": false, "searchable": false, "templateUrl": "app/components/form/fields/json.html", "defaultValue": null, "_previousName": "fortigateIP", "playbookField": true, "lengthConstraint": false, "allowedGridColumn": false, "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "revisionName", "type": "string", "label": "Revision Name", "tooltip": "The name of the config in the revision list on the FG.", "dataType": "text", "formType": "text", "required": true, "_expanded": true, "defaultValue": "Initial", "_previousName": "rEvisionName", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "username", "type": "string", "label": "Username", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": "admin", "_previousName": "", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "password", "type": "string", "label": "Password", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": null, "_previousName": "pAssword", "jinjaExpressionView": true, "useRecordFieldDefault": false } ], "step_variables": { "input": { "params": { "password": "{{vars.request.data[\"password\"]}}", "username": "{{vars.request.data[\"username\"]}}", "fortigateIP": "{{vars.request.data[\"fortigateIP\"]}}", "revisionName": "{{vars.request.data[\"revisionName\"]}}" }, "records": "{{vars.input.records}}" } }, "_promptexpanded": true, "triggerOnSource": true, "displayConditions": { "devices": { "sort": [], "limit": 30, "logic": "OR", "filters": [ { "type": "primitive", "field": "managementMode", "value": "Deleted", "operator": "eq", "_operator": "eq" }, { "type": "primitive", "field": "managementMode", "value": "true", "operator": "isnull", "_operator": "isnull" } ] } }, "executeButtonText": "Execute", "noRecordExecution": true, "showToasterMessage": { "visible": false, "messageVisible": true }, "triggerOnReplicate": false, "singleRecordExecution": false }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/f414d039-bb0d-4e59-9c39-a8f1e880b18a", "group": null, "uuid": "571742bb-73ec-4ffd-9b9a-c595a510d46b" } ], "routes": [ { "@type": "WorkflowRoute", "name": "parse_input -> save_revision", "targetStep": "/api/3/workflow_steps/b1d7463c-5a6c-4e73-82a0-7c4d53dda38d", "sourceStep": "/api/3/workflow_steps/2d46537f-b05c-474a-90eb-47942e7c00a3", "label": null, "isExecuted": false, "group": null, "uuid": "e5a28389-a10a-5b0e-bf6c-4736d31165bc" }, { "@type": "WorkflowRoute", "name": "Start -> parse_input", "targetStep": "/api/3/workflow_steps/2d46537f-b05c-474a-90eb-47942e7c00a3", "sourceStep": "/api/3/workflow_steps/571742bb-73ec-4ffd-9b9a-c595a510d46b", "label": null, "isExecuted": false, "group": null, "uuid": "5dacd2f0-f544-55fc-970e-345318faa922" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "3cfa7ab2-387f-4ca0-aee4-efcf19e4afb1", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - get latest revision ID by comment", "aliasName": null, "tag": null, "description": "Retrieve the FOS Revision ID by name.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "comment_search", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/72143d05-774d-407b-ada6-8251cdb3e184", "steps": [ { "@type": "WorkflowStep", "name": "extract revisions", "description": null, "arguments": { "revisions": "{{vars.steps.get_revisions.output.results.revisions}}", "categories": "{{vars.steps.get_revisions.output.results.categories}}" }, "status": null, "top": "140", "left": "700", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "835e740e-66ed-41ef-8395-ffbfa22fac9d" }, { "@type": "WorkflowStep", "name": "get revisions", "description": null, "arguments": { "arguments": { "apikey": "{{vars.apikey}}", "fos_ip": "{{vars.fos_ip}}" }, "apply_async": false, "ignore_errors": true, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/4e8ce93b-f764-4c70-ab07-12ed9507b300" }, "status": null, "top": "40", "left": "700", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "fa72b1cb-9465-471a-8a62-f7caeefbe4c6" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.revision_search}}", "params": "{{vars.input.params}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "ced1dfbc-740d-42eb-9f1f-b9456110a80d" }, { "@type": "WorkflowStep", "name": "search_revisions", "description": null, "arguments": { "revision_search": "{%- set ret = {} -%}\n{%- set search = vars.comment_search -%}\n{%- set results = vars.revisions \n| json_query( \"[?contains(comment,'{}')]\".format(search) ) -%}\n{%- if results and results|length > 0 -%}\n {%- set do = ret.update(results[0]) -%}\n {%- set do = ret.update({\"version\":vars.categories[results[0].version_id] }) -%}\n{%- else -%}\n{%- set do = ret.update([]) -%}\n{%- endif -%}\n{{ret}}" }, "status": null, "top": "240", "left": "700", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "cc2b3838-cbee-4856-98c4-c771b29422b7" }, { "@type": "WorkflowStep", "name": "setup env", "description": null, "arguments": { "apikey": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}", "comment_search": "{{vars.input.params['comment_search']}}" }, "status": null, "top": "40", "left": "360", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "066deb20-ab6d-4423-90c5-047656f22c8a" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "72143d05-774d-407b-ada6-8251cdb3e184" } ], "routes": [ { "@type": "WorkflowRoute", "name": "extract revisions -> search_revisions", "targetStep": "/api/3/workflow_steps/cc2b3838-cbee-4856-98c4-c771b29422b7", "sourceStep": "/api/3/workflow_steps/835e740e-66ed-41ef-8395-ffbfa22fac9d", "label": null, "isExecuted": false, "group": null, "uuid": "6658497f-f792-544a-ac4b-5adf1b8bac81" }, { "@type": "WorkflowRoute", "name": "get revisions -> extract revisions", "targetStep": "/api/3/workflow_steps/835e740e-66ed-41ef-8395-ffbfa22fac9d", "sourceStep": "/api/3/workflow_steps/fa72b1cb-9465-471a-8a62-f7caeefbe4c6", "label": null, "isExecuted": false, "group": null, "uuid": "8ff8db56-045b-51de-aa2a-a1c2c01f7a02" }, { "@type": "WorkflowRoute", "name": "search_revisions -> return", "targetStep": "/api/3/workflow_steps/ced1dfbc-740d-42eb-9f1f-b9456110a80d", "sourceStep": "/api/3/workflow_steps/cc2b3838-cbee-4856-98c4-c771b29422b7", "label": null, "isExecuted": false, "group": null, "uuid": "343b1ce0-a121-5ac7-be96-13460e591406" }, { "@type": "WorkflowRoute", "name": "setup env -> get revisions", "targetStep": "/api/3/workflow_steps/fa72b1cb-9465-471a-8a62-f7caeefbe4c6", "sourceStep": "/api/3/workflow_steps/066deb20-ab6d-4423-90c5-047656f22c8a", "label": null, "isExecuted": false, "group": null, "uuid": "c87d5438-4052-5837-b45f-7306862f960d" }, { "@type": "WorkflowRoute", "name": "Start -> setup env", "targetStep": "/api/3/workflow_steps/066deb20-ab6d-4423-90c5-047656f22c8a", "sourceStep": "/api/3/workflow_steps/72143d05-774d-407b-ada6-8251cdb3e184", "label": null, "isExecuted": false, "group": null, "uuid": "34752c67-dd66-52a8-a5bb-bc3678b6455e" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "45d1368f-24bd-4f73-82db-bb18784e1c3f", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - bootstrap fortimanager legacy monitor", "aliasName": null, "tag": null, "description": "Perform a FortiDeploy style API change to the Central Management", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "fmg", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/85e4ae1a-f7a0-462c-9d81-6b536dbdbfb2", "steps": [ { "@type": "WorkflowStep", "name": "fos_api", "description": null, "arguments": { "params": { "url": "{{vars.api_url}}", "body": "{{vars.payload}}", "method": "POST", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "140", "left": "340", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "bc453c81-b82a-49d5-b77c-1e310a427ef6" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}", "payload": "{ \n \"fortimanager_ip\": \"{{vars.fmg}}\" \n}" }, "status": null, "top": "100", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "2eea8274-6504-4cb9-bab8-a91b8995f699" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fos_api.data}}", "params": "{{vars.input.params}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "150e4e68-c12b-4d52-8cc8-9ce1d6eda6ec" }, { "@type": "WorkflowStep", "name": "setup_vars", "description": null, "arguments": { "fmg": "{{vars.input.params.fmg}}", "token": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}", "api_url": "https://{{vars.fos_ip}}/api/v2/monitor/system/fortimanager/config" }, "status": null, "top": "60", "left": "340", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "85fea5de-267f-4687-adb6-a66907c1cc72" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "85e4ae1a-f7a0-462c-9d81-6b536dbdbfb2" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fos_api -> return", "targetStep": "/api/3/workflow_steps/150e4e68-c12b-4d52-8cc8-9ce1d6eda6ec", "sourceStep": "/api/3/workflow_steps/bc453c81-b82a-49d5-b77c-1e310a427ef6", "label": null, "isExecuted": false, "group": null, "uuid": "af6ad729-b1d0-53d5-ad25-cbca6315c676" }, { "@type": "WorkflowRoute", "name": "header_payload -> fos_api", "targetStep": "/api/3/workflow_steps/bc453c81-b82a-49d5-b77c-1e310a427ef6", "sourceStep": "/api/3/workflow_steps/2eea8274-6504-4cb9-bab8-a91b8995f699", "label": null, "isExecuted": false, "group": null, "uuid": "a4aa56cf-e663-5a99-b50e-6ad5ada57866" }, { "@type": "WorkflowRoute", "name": "setup_vars -> header_payload", "targetStep": "/api/3/workflow_steps/2eea8274-6504-4cb9-bab8-a91b8995f699", "sourceStep": "/api/3/workflow_steps/85fea5de-267f-4687-adb6-a66907c1cc72", "label": null, "isExecuted": false, "group": null, "uuid": "1ef06180-eefa-5916-abfc-b2a06844b48e" }, { "@type": "WorkflowRoute", "name": "Start -> setup_vars", "targetStep": "/api/3/workflow_steps/85fea5de-267f-4687-adb6-a66907c1cc72", "sourceStep": "/api/3/workflow_steps/85e4ae1a-f7a0-462c-9d81-6b536dbdbfb2", "label": null, "isExecuted": false, "group": null, "uuid": "fb3c40a2-c67a-598a-bebf-0c026094ecea" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "465ebe93-8cb2-4f80-8448-fdc98434ea6e", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fmg", "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - get interfaces", "aliasName": null, "tag": null, "description": "Retrieve the FOS Interface Table.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/42794adb-d571-4b63-a857-b6280588e2cc", "steps": [ { "@type": "WorkflowStep", "name": "get_fos_data", "description": null, "arguments": { "params": { "url": "https://{{vars.fos_ip}}/api/v2/cmdb/system/interface", "body": "{{vars.payload}}", "method": "GET", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.2.3", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "120", "left": "360", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "c10b6132-5f45-41fe-88e1-dbeb51c60a1d" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}", "payload": "{}" }, "status": null, "top": "80", "left": "740", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "4ff8bc42-2c8c-476f-8627-1b65f32a4f19" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.get_fos_data.data.results}}", "params": "{{vars.input.params}}" }, "status": null, "top": "120", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "5f28ceff-eb89-4a6b-9a6b-5d1cacbee3c3" }, { "@type": "WorkflowStep", "name": "setup_vars", "description": null, "arguments": { "token": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}" }, "status": null, "top": "40", "left": "360", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "cd69a244-f6a6-4ea9-8b08-e28ceeff5350" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "42794adb-d571-4b63-a857-b6280588e2cc" } ], "routes": [ { "@type": "WorkflowRoute", "name": "get_fos_data -> return", "targetStep": "/api/3/workflow_steps/5f28ceff-eb89-4a6b-9a6b-5d1cacbee3c3", "sourceStep": "/api/3/workflow_steps/c10b6132-5f45-41fe-88e1-dbeb51c60a1d", "label": null, "isExecuted": false, "group": null, "uuid": "19c7f8e2-a37e-54b3-a745-f41d426d6c2e" }, { "@type": "WorkflowRoute", "name": "header_payload -> get_fos_data", "targetStep": "/api/3/workflow_steps/c10b6132-5f45-41fe-88e1-dbeb51c60a1d", "sourceStep": "/api/3/workflow_steps/4ff8bc42-2c8c-476f-8627-1b65f32a4f19", "label": null, "isExecuted": false, "group": null, "uuid": "7789fa32-50ed-5653-8dd1-7f497e504998" }, { "@type": "WorkflowRoute", "name": "setup_vars -> header_payload", "targetStep": "/api/3/workflow_steps/4ff8bc42-2c8c-476f-8627-1b65f32a4f19", "sourceStep": "/api/3/workflow_steps/cd69a244-f6a6-4ea9-8b08-e28ceeff5350", "label": null, "isExecuted": false, "group": null, "uuid": "3249ff44-0647-5be2-b715-b81289f0dc54" }, { "@type": "WorkflowRoute", "name": "Start -> setup_vars", "targetStep": "/api/3/workflow_steps/cd69a244-f6a6-4ea9-8b08-e28ceeff5350", "sourceStep": "/api/3/workflow_steps/42794adb-d571-4b63-a857-b6280588e2cc", "label": null, "isExecuted": false, "group": null, "uuid": "37ecc1a4-0d78-5632-b1ba-bfa3b5e2bc5e" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "4c0538e3-b4ba-4cfd-8b74-4c727aa9aab8", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - revision list", "aliasName": null, "tag": null, "description": "Retrieve the FOS Revisions", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/cda29811-6c55-4956-85ae-e0afd2f9f324", "steps": [ { "@type": "WorkflowStep", "name": "get_fos_data", "description": null, "arguments": { "params": { "url": "https://{{vars.fos_ip}}/api/v2/monitor/system/config-revision", "body": "{{vars.payload}}", "method": "GET", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.2.6", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "120", "left": "340", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "3b3153de-a71e-45d7-b570-2c9e29a683b4" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}", "payload": "{}" }, "status": null, "top": "80", "left": "660", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "d5d370d0-f23c-4c27-9171-ec4a1504f1a0" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.get_fos_data.data}}", "params": "{{vars.input.params}}" }, "status": null, "top": "120", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "8caeef8c-7ac6-4fe4-9636-911cc1048a72" }, { "@type": "WorkflowStep", "name": "setup_vars", "description": null, "arguments": { "token": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}" }, "status": null, "top": "40", "left": "340", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "d8ea20c2-1e4f-4b73-b131-d16042b1c55a" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "cda29811-6c55-4956-85ae-e0afd2f9f324" } ], "routes": [ { "@type": "WorkflowRoute", "name": "get_fos_data -> return", "targetStep": "/api/3/workflow_steps/8caeef8c-7ac6-4fe4-9636-911cc1048a72", "sourceStep": "/api/3/workflow_steps/3b3153de-a71e-45d7-b570-2c9e29a683b4", "label": null, "isExecuted": false, "group": null, "uuid": "23065d07-3fa4-5264-9288-f897cb1d0f27" }, { "@type": "WorkflowRoute", "name": "header_payload -> get_fos_data", "targetStep": "/api/3/workflow_steps/3b3153de-a71e-45d7-b570-2c9e29a683b4", "sourceStep": "/api/3/workflow_steps/d5d370d0-f23c-4c27-9171-ec4a1504f1a0", "label": null, "isExecuted": false, "group": null, "uuid": "25cd32e4-cace-50fd-9433-4e67a8c7a150" }, { "@type": "WorkflowRoute", "name": "setup_vars -> header_payload", "targetStep": "/api/3/workflow_steps/d5d370d0-f23c-4c27-9171-ec4a1504f1a0", "sourceStep": "/api/3/workflow_steps/d8ea20c2-1e4f-4b73-b131-d16042b1c55a", "label": null, "isExecuted": false, "group": null, "uuid": "f42da9c1-fc38-5aff-aa00-448571237405" }, { "@type": "WorkflowRoute", "name": "Start -> setup_vars", "targetStep": "/api/3/workflow_steps/d8ea20c2-1e4f-4b73-b131-d16042b1c55a", "sourceStep": "/api/3/workflow_steps/cda29811-6c55-4956-85ae-e0afd2f9f324", "label": null, "isExecuted": false, "group": null, "uuid": "118717bd-99da-5506-86e8-cfde40dcc7db" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "4e8ce93b-f764-4c70-ab07-12ed9507b300", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - login via /authentication", "aliasName": null, "tag": null, "description": "Authenticate via username/password and retrieve the token.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "username", "password" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/d0f08f0e-4ed3-4e67-a391-0eb6642f0de9", "steps": [ { "@type": "WorkflowStep", "name": "fos_login", "description": null, "arguments": { "params": { "url": "https://{{vars.fos_ip}}/api/v2/authentication", "body": "{{vars.payload}}", "method": "POST", "params": "", "verify": false, "headers": "", "password": "", "username": "", "auth_config": "" }, "version": "3.2.3", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "300", "left": "440", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "25d091f8-5ed6-42d7-ba04-3dfb126edf55" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"accept\": \"application/json\"\n}", "payload": "{ \"username\": \"{{vars.username}}\", \"secretkey\": \"{{vars.password}}\", \"ack_post_disclaimer\": true, \"request_key\": true}" }, "status": null, "top": "180", "left": "440", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "b15c2998-20f6-44f6-b604-de03983152fb" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fos_login.data}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "c500126e-544f-4887-9b8e-c9831307f845" }, { "@type": "WorkflowStep", "name": "setup_initial_vars", "description": "Create default username/password", "arguments": { "fos_ip": "{{vars.input.params['fos_ip']}}", "password": "{{vars.input.params['password']}}", "username": "{%- if vars.input.params['username'] != '' -%}\n{{vars.input.params['username']}}\n{%- else -%}\nadmin\n{%- endif -%}" }, "status": null, "top": "60", "left": "440", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "c00c5814-596c-4a59-90c2-71a058bb5d59" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "d0f08f0e-4ed3-4e67-a391-0eb6642f0de9" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fos_login -> return", "targetStep": "/api/3/workflow_steps/c500126e-544f-4887-9b8e-c9831307f845", "sourceStep": "/api/3/workflow_steps/25d091f8-5ed6-42d7-ba04-3dfb126edf55", "label": null, "isExecuted": false, "group": null, "uuid": "a7f0a49b-1c4d-5ef6-b5a0-a9125daae076" }, { "@type": "WorkflowRoute", "name": "header_payload -> fos_login", "targetStep": "/api/3/workflow_steps/25d091f8-5ed6-42d7-ba04-3dfb126edf55", "sourceStep": "/api/3/workflow_steps/b15c2998-20f6-44f6-b604-de03983152fb", "label": null, "isExecuted": false, "group": null, "uuid": "a1dcabac-d1a7-5d1c-be7e-8f077e15e0a6" }, { "@type": "WorkflowRoute", "name": "setup_initial_vars -> header_payload", "targetStep": "/api/3/workflow_steps/b15c2998-20f6-44f6-b604-de03983152fb", "sourceStep": "/api/3/workflow_steps/c00c5814-596c-4a59-90c2-71a058bb5d59", "label": null, "isExecuted": false, "group": null, "uuid": "61b2e649-8a07-58e2-b594-5f6bb831d759" }, { "@type": "WorkflowRoute", "name": "Start -> setup_initial_vars", "targetStep": "/api/3/workflow_steps/c00c5814-596c-4a59-90c2-71a058bb5d59", "sourceStep": "/api/3/workflow_steps/d0f08f0e-4ed3-4e67-a391-0eb6642f0de9", "label": null, "isExecuted": false, "group": null, "uuid": "aefbffaf-7d1e-5777-bd85-509f6c79fa0a" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "4f74a531-f97b-4721-a7d7-9509819b2bed", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - bootstrap fortimanager cmdb", "aliasName": null, "tag": null, "description": "Perform a FortiDeploy style API change to the Central Management", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "fmg", "fmg_serial", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/52b78c17-596a-40c6-a2b0-ab1765ff4a75", "steps": [ { "@type": "WorkflowStep", "name": "bootstrap_fmg", "description": null, "arguments": { "params": { "url": "{{vars.api_url_bootstrap}}", "body": "{{vars.payload_bootstrap}}", "method": "{{vars.api_method_bootstrap}}", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "500", "left": "520", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "59e03a7c-cf7d-4024-9bca-c1d145a2b946" }, { "@type": "WorkflowStep", "name": "Bootstrap FMG Method", "description": null, "arguments": { "conditions": [ { "option": "FMG Serial Automatic", "default": true, "step_iri": "/api/3/workflow_steps/38008f1c-e23d-40e1-867b-d8f3355a9a46", "step_name": "fmg_noserial" }, { "option": "Using a FMG Serial", "step_iri": "/api/3/workflow_steps/3e885c92-b440-436e-a6b2-97bc63caecea", "condition": "{{ vars.fmg_serial not in ['',None,Null] }}", "step_name": "fmg_serial" } ], "step_variables": [] }, "status": null, "top": "240", "left": "500", "stepType": "/api/3/workflow_step_types/12254cf5-5db7-4b1a-8cb1-3af081924b28", "group": null, "uuid": "432c6e6c-91a1-4b21-be44-b4d83dc1a382" }, { "@type": "WorkflowStep", "name": "Clean AutoScript", "description": null, "arguments": { "conditions": [ { "option": "Used a FMG Serial", "step_iri": "/api/3/workflow_steps/f05de738-cf8a-4c28-b41b-42e688773e26", "condition": "{{ vars.fmg_serial != '' }}", "step_name": "return" }, { "option": "Delete Autoscript", "default": true, "step_iri": "/api/3/workflow_steps/d312ad05-caad-4a36-adee-4db940f68d88", "step_name": "Sleep before Deleting" } ], "step_variables": [] }, "status": null, "top": "620", "left": "520", "stepType": "/api/3/workflow_step_types/12254cf5-5db7-4b1a-8cb1-3af081924b28", "group": null, "uuid": "02c7413b-5ec9-481d-81eb-5f55d9b9de47" }, { "@type": "WorkflowStep", "name": "fmg_noserial", "description": null, "arguments": { "api_url_bootstrap": "https://{{vars.fos_ip}}/api/v2/cmdb/system/auto-script", "payload_bootstrap": "{\n \"name\": \"set_fmg_without_serial\",\n \"start\": \"auto\",\n \"repeat\": 1,\n \"script\": \"\\nexec batch start\\nconfig system central-management\\n set type fortimanager\\n set fmg {{vars.fmg}}\\nend\\nexec batch end\\n\"\n}", "api_method_bootstrap": "post" }, "status": null, "top": "380", "left": "900", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "38008f1c-e23d-40e1-867b-d8f3355a9a46" }, { "@type": "WorkflowStep", "name": "fmg_serial", "description": null, "arguments": { "api_url_bootstrap": "https://{{vars.fos_ip}}/api/v2/cmdb/system/central-management", "payload_bootstrap": "{ \n \"type\":\"fortimanager\",\n \"fmg\": \"{{vars.fmg}}\",\n \"serial-number\":\"{{vars.fmg_serial}}\"\n}", "api_method_bootstrap": "put" }, "status": null, "top": "360", "left": "80", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "3e885c92-b440-436e-a6b2-97bc63caecea" }, { "@type": "WorkflowStep", "name": "header_and_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}" }, "status": null, "top": "140", "left": "1000", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "915b153e-ef5a-4760-9195-e3d704216210" }, { "@type": "WorkflowStep", "name": "remove autoscript", "description": null, "arguments": { "params": { "url": "{{vars.api_url_bootstrap}}/set_fmg_without_serial", "body": "", "method": "DELETE", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "740", "left": "960", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "682f7c40-7a5b-4e29-8351-0127ed11bd38" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.bootstrap_fmg.data}}" }, "status": null, "top": "720", "left": "60", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "f05de738-cf8a-4c28-b41b-42e688773e26" }, { "@type": "WorkflowStep", "name": "setup_vars", "description": null, "arguments": { "fmg": "{{vars.input.params.fmg}}", "token": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}", "fmg_serial": "{{vars.input.params['fmg_serial']}}" }, "status": null, "top": "60", "left": "320", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "c7fc54b0-6680-4920-b492-2ccd9b331a5f" }, { "@type": "WorkflowStep", "name": "Sleep before Deleting", "description": null, "arguments": { "rule": { "actions": [ { "type": "resume_playbook", "enabled": true, "channel_uuid": "e2ce87c2-c55a-11ec-9d64-0242ac120002" } ], "is_active": true, "event_source": "crudhub" }, "type": "TimeBased", "delay": { "days": 0, "hours": 0, "weeks": 0, "minutes": 0, "seconds": 15 } }, "status": null, "top": "620", "left": "960", "stepType": "/api/3/workflow_step_types/6832e556-b9c7-497a-babe-feda3bd27dbf", "group": null, "uuid": "d312ad05-caad-4a36-adee-4db940f68d88" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "52b78c17-596a-40c6-a2b0-ab1765ff4a75" } ], "routes": [ { "@type": "WorkflowRoute", "name": "bootstrap_fmg -> Clean AutoScript", "targetStep": "/api/3/workflow_steps/02c7413b-5ec9-481d-81eb-5f55d9b9de47", "sourceStep": "/api/3/workflow_steps/59e03a7c-cf7d-4024-9bca-c1d145a2b946", "label": null, "isExecuted": false, "group": null, "uuid": "eab03f4d-5964-5ce0-b514-cd408a55ff90" }, { "@type": "WorkflowRoute", "name": "Bootstrap FMG Method -> fmg_noserial", "targetStep": "/api/3/workflow_steps/38008f1c-e23d-40e1-867b-d8f3355a9a46", "sourceStep": "/api/3/workflow_steps/432c6e6c-91a1-4b21-be44-b4d83dc1a382", "label": "FMG Serial Automatic", "isExecuted": false, "group": null, "uuid": "7a64ed93-5629-5d35-b6f3-6d0ffad50d32" }, { "@type": "WorkflowRoute", "name": "Bootstrap FMG Method -> fmg_serial", "targetStep": "/api/3/workflow_steps/3e885c92-b440-436e-a6b2-97bc63caecea", "sourceStep": "/api/3/workflow_steps/432c6e6c-91a1-4b21-be44-b4d83dc1a382", "label": "Using a FMG Serial", "isExecuted": false, "group": null, "uuid": "98ba4bc3-9c46-514f-8f15-3efee6dd285b" }, { "@type": "WorkflowRoute", "name": "Clean AutoScript -> return", "targetStep": "/api/3/workflow_steps/f05de738-cf8a-4c28-b41b-42e688773e26", "sourceStep": "/api/3/workflow_steps/02c7413b-5ec9-481d-81eb-5f55d9b9de47", "label": "Used a FMG Serial", "isExecuted": false, "group": null, "uuid": "41df970b-2a90-50bb-9200-e01df6c9d97f" }, { "@type": "WorkflowRoute", "name": "Clean AutoScript -> Sleep before Deleting", "targetStep": "/api/3/workflow_steps/d312ad05-caad-4a36-adee-4db940f68d88", "sourceStep": "/api/3/workflow_steps/02c7413b-5ec9-481d-81eb-5f55d9b9de47", "label": "Delete Autoscript", "isExecuted": false, "group": null, "uuid": "c119e39a-a93e-53e7-9199-c2a4e2bb3169" }, { "@type": "WorkflowRoute", "name": "fmg_noserial -> bootstrap_fmg", "targetStep": "/api/3/workflow_steps/59e03a7c-cf7d-4024-9bca-c1d145a2b946", "sourceStep": "/api/3/workflow_steps/38008f1c-e23d-40e1-867b-d8f3355a9a46", "label": null, "isExecuted": false, "group": null, "uuid": "5060e4d5-fb45-592c-a3c0-6a2ee0618256" }, { "@type": "WorkflowRoute", "name": "fmg_serial -> bootstrap_fmg", "targetStep": "/api/3/workflow_steps/59e03a7c-cf7d-4024-9bca-c1d145a2b946", "sourceStep": "/api/3/workflow_steps/3e885c92-b440-436e-a6b2-97bc63caecea", "label": null, "isExecuted": false, "group": null, "uuid": "7e537730-4f39-5518-946e-53fbd4f5fd47" }, { "@type": "WorkflowRoute", "name": "header_and_payload -> Bootstrap FMG Method", "targetStep": "/api/3/workflow_steps/432c6e6c-91a1-4b21-be44-b4d83dc1a382", "sourceStep": "/api/3/workflow_steps/915b153e-ef5a-4760-9195-e3d704216210", "label": null, "isExecuted": false, "group": null, "uuid": "05acb902-bc24-513a-98c8-74812a4b5cbb" }, { "@type": "WorkflowRoute", "name": "remove autoscript -> return", "targetStep": "/api/3/workflow_steps/f05de738-cf8a-4c28-b41b-42e688773e26", "sourceStep": "/api/3/workflow_steps/682f7c40-7a5b-4e29-8351-0127ed11bd38", "label": null, "isExecuted": false, "group": null, "uuid": "a59ea840-e82b-5a44-9bba-eeb6817e63f1" }, { "@type": "WorkflowRoute", "name": "setup_vars -> header_and_payload", "targetStep": "/api/3/workflow_steps/915b153e-ef5a-4760-9195-e3d704216210", "sourceStep": "/api/3/workflow_steps/c7fc54b0-6680-4920-b492-2ccd9b331a5f", "label": null, "isExecuted": false, "group": null, "uuid": "515767b0-0c5b-5051-982b-62c8c4ce0b42" }, { "@type": "WorkflowRoute", "name": "Sleep before Deleting -> remove autoscript", "targetStep": "/api/3/workflow_steps/682f7c40-7a5b-4e29-8351-0127ed11bd38", "sourceStep": "/api/3/workflow_steps/d312ad05-caad-4a36-adee-4db940f68d88", "label": null, "isExecuted": false, "group": null, "uuid": "50321d3a-d845-5703-a3f7-303a56e259b5" }, { "@type": "WorkflowRoute", "name": "Start -> setup_vars", "targetStep": "/api/3/workflow_steps/c7fc54b0-6680-4920-b492-2ccd9b331a5f", "sourceStep": "/api/3/workflow_steps/52b78c17-596a-40c6-a2b0-ab1765ff4a75", "label": null, "isExecuted": false, "group": null, "uuid": "22307d99-aaab-5e08-b1af-e4ff7ad0c04c" } ], "groups": [ { "@type": "WorkflowGroup", "name": "FMG Serial Auto Updated", "description": "When NOT using the FMG Serial we update:\n/api/v2/cmdb/system/auto-script\n\nBug ID: 1062799", "type": "note", "isCollapsed": false, "hasTriggerStep": false, "hideInLogs": false, "metadata": [], "reusable": false, "top": "460", "left": "880", "height": "130", "width": "395", "uuid": "0aac4d37-b9b9-4abd-9980-d0816333c9df", "recordTags": [] }, { "@type": "WorkflowGroup", "name": "FMG Serial Set", "description": "When using the FMG Serial we update:\n/api/v2/cmdb/system/central-management", "type": "note", "isCollapsed": false, "hasTriggerStep": false, "hideInLogs": false, "metadata": [], "reusable": false, "top": "440", "left": "40", "height": "102", "width": "334", "uuid": "7b5c54ef-35c8-49d8-89ef-1fa7d79cb6c0", "recordTags": [] } ], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "5f0f1671-a2a6-4fae-aaf6-0aedfc35b20b", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fmg", "fmg_serial", "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "Button for FG Revision List", "aliasName": null, "tag": null, "description": "Get Revision Lists from Devices", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [], "synchronous": false, "triggerStep": "/api/3/workflow_steps/cafa9637-a96b-4e51-823c-5ef0245b6ead", "steps": [ { "@type": "WorkflowStep", "name": "extract revisions", "description": null, "arguments": { "revision_data": "{{vars.steps.revision_list}}" }, "status": null, "top": "280", "left": "360", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "40be58ee-68b1-48e0-88d7-378f8f849a75" }, { "@type": "WorkflowStep", "name": "parse_input", "description": null, "arguments": { "ip_list": "{{vars.input.params.fortigateIP.split(\",\")}}" }, "status": null, "top": "40", "left": "360", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "d78a0371-a14f-4881-9722-17a74e968216" }, { "@type": "WorkflowStep", "name": "Report", "description": null, "arguments": { "type": "InputBased", "input": { "schema": { "title": "FG Revision Lists", "description": "{%- for r in vars.revision_data %}\n\n----------------------------------------------------------\n\n| {{r.params.fos_ip}} | {{r.output.serial}} | {{r.output.version}} |\n| ------------------------ | ---------------------- | ------------------------ |\n\n| Revision ID | Firmware | Comment | \n| ------------- | ----------- | ----------- |\n{%- set catg = r.output.results.categories %}\n{%- for rev in r.output.results.revisions %}\n{%- set ver = [ \n catg[rev.version_id].major_version,\n catg[rev.version_id].minor_version,\n catg[rev.version_id].patch_number,\n catg[rev.version_id].build_number\n] %}\n| {{rev.id}} | v{{ver[0]}}.{{ver[1]}}.{{ver[2]}} (Build {{ver[3]}}) | {{rev.comment}} |\n{%- endfor %}\n\n{% endfor %}", "inputVariables": [] } }, "record": "", "timeout": { "days": 0, "hours": 0, "minutes": 10, "step_iri": "/api/3/workflow_steps/78f4f7ad-1532-4437-bbed-ffdef1ad099c" }, "agent_id": null, "resources": "devices", "is_approval": false, "owner_detail": { "isAssigned": false, "emailRecipients": "" }, "isRecordLinked": false, "step_variables": [], "response_mapping": { "options": [ { "option": "Ok", "primary": true, "step_iri": "/api/3/workflow_steps/80911188-42c4-4642-b50e-7677bb60cb21" } ], "duplicateOption": false, "customSuccessMessage": "Awaiting Playbook resumed successfully." }, "email_notification": { "enabled": false, "smtpParameters": [] }, "customEmailExternal": false, "inline_channel_list": [], "external_channel_list": [], "unauthenticated_input": false, "external_email_subject": null, "internal_email_subject": "A FortiSOAR playbook is requesting your input", "custom_email_body_external": null, "external_email_attachments": null }, "status": null, "top": "380", "left": "360", "stepType": "/api/3/workflow_step_types/fc04082a-d7dc-4299-96fb-6837b1baa0fe", "group": null, "uuid": "d8f0a188-c4c9-4bac-9c67-8997560bb5c5" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": {}, "status": null, "top": "520", "left": "360", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "80911188-42c4-4642-b50e-7677bb60cb21" }, { "@type": "WorkflowStep", "name": "revision_list", "description": null, "arguments": { "arguments": { "fos_ip": "{{vars.item}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/4e8ce93b-f764-4c70-ab07-12ed9507b300", "for_each": { "item": "{{vars.ip_list}}", "__bulk": false, "parallel": true, "condition": "" } }, "status": null, "top": "160", "left": "360", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "a14efdee-7e3e-41a1-969b-541f7064edbe" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "route": "69a628fe-5c86-46c2-aa3e-ef8f068d7cfe", "title": "FOS Helper - Get Revision List", "resources": [ "devices", "managers" ], "__triggerLimit": true, "inputVariables": [ { "name": "fortigateIP", "type": "string", "label": "Fortigate IP", "title": "Text Area", "usable": false, "tooltip": "FortiGate IP or IPs using a comma seperated list.", "dataType": "text", "formType": "textarea", "required": true, "_expanded": true, "mmdUpdate": false, "collection": false, "searchable": false, "templateUrl": "app/components/form/fields/json.html", "defaultValue": null, "_previousName": "fortigateIP", "playbookField": true, "lengthConstraint": false, "allowedGridColumn": false, "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "username", "type": "string", "label": "Username", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": "admin", "_previousName": "", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "password", "type": "string", "label": "Password", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": null, "_previousName": "pAssword", "jinjaExpressionView": true, "useRecordFieldDefault": false } ], "step_variables": { "input": { "params": { "password": "{{vars.request.data[\"password\"]}}", "username": "{{vars.request.data[\"username\"]}}", "fortigateIP": "{{vars.request.data[\"fortigateIP\"]}}" }, "records": "{{vars.input.records}}" } }, "_promptexpanded": true, "triggerOnSource": true, "displayConditions": { "devices": { "sort": [], "limit": 30, "logic": "OR", "filters": [ { "type": "primitive", "field": "managementMode", "value": "Deleted", "operator": "eq", "_operator": "eq" }, { "type": "primitive", "field": "managementMode", "value": "true", "operator": "isnull", "_operator": "isnull" } ] } }, "executeButtonText": "Execute", "noRecordExecution": true, "showToasterMessage": { "visible": false, "messageVisible": true }, "triggerOnReplicate": false, "singleRecordExecution": false }, "status": null, "top": "40", "left": "20", "stepType": "/api/3/workflow_step_types/f414d039-bb0d-4e59-9c39-a8f1e880b18a", "group": null, "uuid": "cafa9637-a96b-4e51-823c-5ef0245b6ead" }, { "@type": "WorkflowStep", "name": "Timeout", "description": null, "arguments": { "params": [], "version": "3.3.0", "connector": "cyops_utilities", "operation": "no_op", "operationTitle": "Utils: No Operation", "step_variables": [] }, "status": null, "top": "380", "left": "700", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "78f4f7ad-1532-4437-bbed-ffdef1ad099c" } ], "routes": [ { "@type": "WorkflowRoute", "name": "extract revisions -> Report", "targetStep": "/api/3/workflow_steps/d8f0a188-c4c9-4bac-9c67-8997560bb5c5", "sourceStep": "/api/3/workflow_steps/40be58ee-68b1-48e0-88d7-378f8f849a75", "label": null, "isExecuted": false, "group": null, "uuid": "294b247d-0ad1-5fae-b524-fba8af0539e8" }, { "@type": "WorkflowRoute", "name": "parse_input -> revision_list", "targetStep": "/api/3/workflow_steps/a14efdee-7e3e-41a1-969b-541f7064edbe", "sourceStep": "/api/3/workflow_steps/d78a0371-a14f-4881-9722-17a74e968216", "label": null, "isExecuted": false, "group": null, "uuid": "d7715972-ab8f-5b0e-9206-099780ff80de" }, { "@type": "WorkflowRoute", "name": "Report -> return", "targetStep": "/api/3/workflow_steps/80911188-42c4-4642-b50e-7677bb60cb21", "sourceStep": "/api/3/workflow_steps/d8f0a188-c4c9-4bac-9c67-8997560bb5c5", "label": "Ok", "isExecuted": false, "group": null, "uuid": "aaeea2bb-eccc-5a76-af2d-b46ff8efada3" }, { "@type": "WorkflowRoute", "name": "Report -> Timeout", "targetStep": "/api/3/workflow_steps/78f4f7ad-1532-4437-bbed-ffdef1ad099c", "sourceStep": "/api/3/workflow_steps/d8f0a188-c4c9-4bac-9c67-8997560bb5c5", "label": null, "isExecuted": false, "group": null, "uuid": "1545ffd1-68f9-515b-9689-9e91855708f8" }, { "@type": "WorkflowRoute", "name": "revision_list -> extract revisions", "targetStep": "/api/3/workflow_steps/40be58ee-68b1-48e0-88d7-378f8f849a75", "sourceStep": "/api/3/workflow_steps/a14efdee-7e3e-41a1-969b-541f7064edbe", "label": null, "isExecuted": false, "group": null, "uuid": "4509069f-b26c-5aa1-972e-0e422d9c308c" }, { "@type": "WorkflowRoute", "name": "Start -> parse_input", "targetStep": "/api/3/workflow_steps/d78a0371-a14f-4881-9722-17a74e968216", "sourceStep": "/api/3/workflow_steps/cafa9637-a96b-4e51-823c-5ef0245b6ead", "label": null, "isExecuted": false, "group": null, "uuid": "580e8644-1fb6-5da4-a7db-27c8f0c76cab" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "62280a28-9cb5-4736-ab98-fe5d2898cb1b", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [] }, { "@type": "Workflow", "triggerLimit": null, "name": "Button to Boostrap FMG", "aliasName": null, "tag": null, "description": "FMG Bootstrap button to send a device to a FMG via username/password and API if HTTPS is reachable.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [], "synchronous": false, "triggerStep": "/api/3/workflow_steps/3623c5f5-e6ce-403d-a82b-fe24f1f8985b", "steps": [ { "@type": "WorkflowStep", "name": "bootstrap_fmg", "description": null, "arguments": { "arguments": { "fmg": "{{vars.input.params.fortimanager}}", "fos_ip": "{{vars.item}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/391a2eed-35ff-42cf-be33-bbe61bd79870", "for_each": { "item": "{{vars.ip_list}}", "__bulk": false, "parallel": true, "condition": "" } }, "status": null, "top": "180", "left": "400", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "aacdcea9-5a3f-4eb0-bf58-df0f1ffdbc93" }, { "@type": "WorkflowStep", "name": "parse_input", "description": null, "arguments": { "ip_list": "{{vars.input.params.fortigateIP.split(\",\")}}" }, "status": null, "top": "40", "left": "400", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "29b4d666-49c3-4b43-b263-afc81323b922" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "route": "4bba361a-ac08-4949-a127-f9760c2e2bd4", "title": "FOS Helper - Bootstrap FMG", "resources": [ "devices", "managers" ], "__triggerLimit": true, "inputVariables": [ { "name": "fortigateIP", "type": "string", "label": "Fortigate IP", "title": "Text Area", "usable": false, "tooltip": "FortiGate IP or IPs using a comma seperated list.", "dataType": "text", "formType": "textarea", "required": true, "_expanded": true, "mmdUpdate": false, "collection": false, "searchable": false, "templateUrl": "app/components/form/fields/json.html", "defaultValue": null, "_previousName": "fortigateIP", "playbookField": true, "lengthConstraint": false, "allowedGridColumn": false, "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "fortimanager", "type": "string", "label": "Fortimanager", "tooltip": "", "dataType": "text", "formType": "text", "required": true, "_expanded": true, "defaultValue": "192.0.2.1", "_previousName": "forti", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "username", "type": "string", "label": "Username", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": "admin", "_previousName": "", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "password", "type": "string", "label": "Password", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": null, "_previousName": "pAssword", "jinjaExpressionView": true, "useRecordFieldDefault": false } ], "step_variables": { "input": { "params": { "password": "{{vars.request.data[\"password\"]}}", "username": "{{vars.request.data[\"username\"]}}", "fortigateIP": "{{vars.request.data[\"fortigateIP\"]}}", "fortimanager": "{{vars.request.data[\"fortimanager\"]}}" }, "records": "{{vars.input.records}}" } }, "_promptexpanded": true, "triggerOnSource": true, "displayConditions": { "devices": { "sort": [], "limit": 30, "logic": "OR", "filters": [ { "type": "primitive", "field": "managementMode", "value": "Deleted", "operator": "eq", "_operator": "eq" }, { "type": "primitive", "field": "managementMode", "value": "true", "operator": "isnull", "_operator": "isnull" } ] } }, "executeButtonText": "Execute", "noRecordExecution": true, "showToasterMessage": { "visible": false, "messageVisible": true }, "triggerOnReplicate": false, "singleRecordExecution": false }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/f414d039-bb0d-4e59-9c39-a8f1e880b18a", "group": null, "uuid": "3623c5f5-e6ce-403d-a82b-fe24f1f8985b" } ], "routes": [ { "@type": "WorkflowRoute", "name": "parse_input -> bootstrap_fmg", "targetStep": "/api/3/workflow_steps/aacdcea9-5a3f-4eb0-bf58-df0f1ffdbc93", "sourceStep": "/api/3/workflow_steps/29b4d666-49c3-4b43-b263-afc81323b922", "label": null, "isExecuted": false, "group": null, "uuid": "ea814b04-b0ff-5826-9f52-e2bfcab569cc" }, { "@type": "WorkflowRoute", "name": "Start -> parse_input", "targetStep": "/api/3/workflow_steps/29b4d666-49c3-4b43-b263-afc81323b922", "sourceStep": "/api/3/workflow_steps/3623c5f5-e6ce-403d-a82b-fe24f1f8985b", "label": null, "isExecuted": false, "group": null, "uuid": "b7821275-adc9-5e12-b289-7171c1ccdf13" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "70b7d2c7-a355-40f8-80b3-2b748be330bd", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - logout via /authentication", "aliasName": null, "tag": null, "description": "Logout FOS", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "token" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/0531221d-beb1-4905-8cf9-5b662d813981", "steps": [ { "@type": "WorkflowStep", "name": "fos_logout", "description": null, "arguments": { "params": { "url": "https://{{vars.fos_ip}}/api/v2/authentication", "body": "{{vars.payload}}", "method": "DELETE", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.2.3", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "300", "left": "440", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "489a9252-7e35-401e-bd64-52f162e19213" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}", "payload": "[]" }, "status": null, "top": "180", "left": "440", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "e3b3e5c4-8697-4881-b28b-72cca659180e" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fos_logout.data}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "d5e9ac89-8582-48a6-b681-19044fa75d23" }, { "@type": "WorkflowStep", "name": "setup_initial_vars", "description": "Create default username/password", "arguments": { "token": "{{vars.input.params['token']}}", "fos_ip": "{{vars.input.params['fos_ip']}}" }, "status": null, "top": "60", "left": "440", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "d0b6df01-0cdd-4139-858a-b3a2941b1421" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "0531221d-beb1-4905-8cf9-5b662d813981" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fos_logout -> return", "targetStep": "/api/3/workflow_steps/d5e9ac89-8582-48a6-b681-19044fa75d23", "sourceStep": "/api/3/workflow_steps/489a9252-7e35-401e-bd64-52f162e19213", "label": null, "isExecuted": false, "group": null, "uuid": "cc3b5bbf-97d8-5762-beca-8427cc57ab00" }, { "@type": "WorkflowRoute", "name": "header_payload -> fos_logout", "targetStep": "/api/3/workflow_steps/489a9252-7e35-401e-bd64-52f162e19213", "sourceStep": "/api/3/workflow_steps/e3b3e5c4-8697-4881-b28b-72cca659180e", "label": null, "isExecuted": false, "group": null, "uuid": "ebf97ab8-0b5a-5eea-bd22-640459faf00b" }, { "@type": "WorkflowRoute", "name": "setup_initial_vars -> header_payload", "targetStep": "/api/3/workflow_steps/e3b3e5c4-8697-4881-b28b-72cca659180e", "sourceStep": "/api/3/workflow_steps/d0b6df01-0cdd-4139-858a-b3a2941b1421", "label": null, "isExecuted": false, "group": null, "uuid": "bff1f277-19a6-58ee-9a7a-814a5d4f3c2d" }, { "@type": "WorkflowRoute", "name": "Start -> setup_initial_vars", "targetStep": "/api/3/workflow_steps/d0b6df01-0cdd-4139-858a-b3a2941b1421", "sourceStep": "/api/3/workflow_steps/0531221d-beb1-4905-8cf9-5b662d813981", "label": null, "isExecuted": false, "group": null, "uuid": "d0f59fd4-0dd3-52ef-ae41-9e8fff4c3227" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "72f18973-f88d-4af5-b0ba-b72cfebeaab6", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "token" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - create api-user and apikey", "aliasName": null, "tag": null, "description": "Authenticate via username/password and create a token user if needed and return an api key.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "username", "password" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/a2312296-7095-42f1-8d47-2f29a4751b7c", "steps": [ { "@type": "WorkflowStep", "name": "login and create api user", "description": null, "arguments": { "config": "", "params": { "python_function": "import json\r\nfrom typing import Any, Dict, Optional, Tuple\r\n\r\nimport requests\r\nfrom urllib3.exceptions import InsecureRequestWarning\r\n\r\nrequests.packages.urllib3.disable_warnings(category=InsecureRequestWarning)\r\n\r\nHOST = {{ vars.fos_ip | tojson }}\r\nUSER = {{ vars.username | tojson }}\r\nPASS = {{ vars.password | tojson }}\r\nAPIUSER = {{ vars.api_user | tojson }}\r\nAPIPROF = {{ vars.api_profile | tojson }}\r\nFSRHOST = {{ (vars.fortisoar_ip ~ \"/32\") | tojson }}\r\n\r\n\r\ndef create_session(host: str, username: str, password: str, verify_ssl: bool = False) -> Dict[str, Any]:\r\n \"\"\"\r\n Create a session configuration dictionary\r\n\r\n Args:\r\n host: FortiOS device IP or hostname\r\n username: Authentication username\r\n password: Authentication password\r\n verify_ssl: Whether to verify SSL certificates\r\n\r\n Returns:\r\n Session configuration dictionary\r\n \"\"\"\r\n return {\r\n \"host\": host,\r\n \"base_url\": f\"https://{host}/api/v2\",\r\n \"username\": username,\r\n \"password\": password,\r\n \"verify_ssl\": verify_ssl,\r\n \"session\": requests.Session(),\r\n \"csrf_token\": None,\r\n \"use_bearer_auth\": False,\r\n \"status\": {}, # Status dictionary to collect messages\r\n }\r\n\r\n\r\ndef login(config: Dict[str, Any]) -> bool:\r\n \"\"\"\r\n Authenticate and obtain CSRF token or access token\r\n Automatically detects authentication method:\r\n - If access_token in response: uses Bearer authentication\r\n - If cookie found: uses X-CSRFTOKEN authentication\r\n\r\n Args:\r\n config: Session configuration dictionary\r\n\r\n Returns:\r\n True if login successful, False otherwise\r\n \"\"\"\r\n payload = {\r\n \"username\": config[\"username\"],\r\n \"password\": config[\"password\"],\r\n \"secretkey\": config[\"password\"],\r\n \"ack_post_disclaimer\": True,\r\n \"request_key\": True,\r\n }\r\n\r\n url = f\"{config['base_url']}/authentication\"\r\n\r\n try:\r\n response = config[\"session\"].post(\r\n url,\r\n json=payload,\r\n verify=config[\"verify_ssl\"]\r\n )\r\n response.raise_for_status()\r\n\r\n result = response.json() if response.content else {}\r\n\r\n # Check for session_key in response (alternative token field)\r\n if result.get(\"session_key\"):\r\n config[\"status\"][\"login\"] = \"Found session_key in response, using Bearer authentication\"\r\n config[\"csrf_token\"] = result[\"session_key\"]\r\n config[\"use_bearer_auth\"] = True\r\n return True\r\n\r\n # Extract CSRF token from cookies (older versions - use X-CSRFTOKEN)\r\n for cookie in config[\"session\"].cookies:\r\n if \"ccsrf_token\" in cookie.name.lower():\r\n config[\"csrf_token\"] = cookie.value\r\n config[\"use_bearer_auth\"] = False\r\n config[\"status\"][\"login\"] = f\"Login successful with cookie. Token: {config['csrf_token'][:10]}...\"\r\n return True\r\n\r\n config[\"status\"][\"login\"] = \"Warning: No CSRF token or access_token found\"\r\n return False\r\n\r\n except requests.exceptions.RequestException as e:\r\n config[\"status\"][\"login\"] = f\"Login failed: {e}\"\r\n return False\r\n\r\n\r\ndef logout(config: Dict[str, Any]) -> bool:\r\n \"\"\"\r\n End the session\r\n\r\n Args:\r\n config: Session configuration dictionary\r\n\r\n Returns:\r\n True if logout successful, False otherwise\r\n \"\"\"\r\n if not config[\"csrf_token\"]:\r\n return False\r\n\r\n url = f\"{config['base_url']}/authentication\"\r\n headers = {\"Content-Type\": \"application/json\"}\r\n\r\n # Use appropriate authentication header\r\n if config[\"use_bearer_auth\"]:\r\n headers[\"Authorization\"] = f\"Bearer {config['csrf_token']}\"\r\n else:\r\n headers[\"X-CSRFTOKEN\"] = config[\"csrf_token\"]\r\n\r\n try:\r\n response = config[\"session\"].delete(\r\n url,\r\n headers=headers,\r\n verify=config[\"verify_ssl\"]\r\n )\r\n response.raise_for_status()\r\n\r\n config[\"session\"].close()\r\n config[\"csrf_token\"] = None\r\n config[\"use_bearer_auth\"] = False\r\n config[\"status\"][\"logout\"] = \"Logout successful\"\r\n\r\n return True\r\n\r\n except requests.exceptions.RequestException as e:\r\n config[\"status\"][\"logout\"] = f\"Logout failed: {e}\"\r\n return False\r\n\r\n\r\ndef make_request(\r\n config: Dict[str, Any],\r\n method: str,\r\n endpoint: str,\r\n **kwargs\r\n) -> Optional[Dict[str, Any]]:\r\n \"\"\"\r\n Generic request handler\r\n\r\n Args:\r\n config: Session configuration dictionary\r\n method: HTTP method (GET, POST, PUT, DELETE)\r\n endpoint: API endpoint (e.g., '/cmdb/firewall/address')\r\n **kwargs: Additional arguments to pass to requests\r\n\r\n Returns:\r\n Response JSON or None if failed\r\n \"\"\"\r\n url = f\"{config['base_url']}{endpoint}\"\r\n\r\n # Set default headers\r\n headers = kwargs.pop(\"headers\", {})\r\n headers.setdefault(\"Content-Type\", \"application/json\")\r\n\r\n # Use appropriate authentication header\r\n if config[\"csrf_token\"]:\r\n if config[\"use_bearer_auth\"]:\r\n headers[\"Authorization\"] = f\"Bearer {config['csrf_token']}\"\r\n else:\r\n headers[\"X-CSRFTOKEN\"] = config[\"csrf_token\"]\r\n headers[\"X-Admin-Passwd\"] = config[\"password\"]\r\n\r\n kwargs[\"headers\"] = headers\r\n kwargs.setdefault(\"verify\", config[\"verify_ssl\"])\r\n\r\n try:\r\n response = config[\"session\"].request(method, url, **kwargs)\r\n response.raise_for_status()\r\n return response.json() if response.content else {}\r\n except requests.exceptions.RequestException as e:\r\n # Store error in status dictionary with a unique key\r\n error_key = f\"request_error_{method}_{endpoint.replace('/', '_')}\"\r\n config[\"status\"][error_key] = f\"Request failed: {e}\"\r\n return None\r\n\r\n\r\n# CMDB Operations (Configuration Database)\r\n\r\n\r\ndef get(config: Dict[str, Any], path: str, params: Optional[Dict] = None) -> Optional[Dict[str, Any]]:\r\n \"\"\"\r\n Generic GET operation for CMDB\r\n\r\n Args:\r\n config: Session configuration dictionary\r\n path: Resource path (e.g., 'system/interface', 'firewall/address')\r\n params: Query parameters\r\n\r\n Returns:\r\n Response data or None\r\n \"\"\"\r\n return make_request(config, \"GET\", f\"/cmdb/{path}\", params=params)\r\n\r\n\r\ndef create(config: Dict[str, Any], path: str, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:\r\n \"\"\"\r\n Generic CREATE operation for CMDB\r\n\r\n Args:\r\n config: Session configuration dictionary\r\n path: Resource path (e.g., 'firewall/address')\r\n data: Object data\r\n\r\n Returns:\r\n Response data or None\r\n \"\"\"\r\n return make_request(config, \"POST\", f\"/cmdb/{path}\", json=data)\r\n\r\n\r\ndef update(\r\n config: Dict[str, Any],\r\n path: str,\r\n name: str,\r\n data: Dict[str, Any]\r\n) -> Optional[Dict[str, Any]]:\r\n \"\"\"\r\n Generic UPDATE operation for CMDB\r\n\r\n Args:\r\n config: Session configuration dictionary\r\n path: Resource path\r\n name: Object name/identifier\r\n data: Updated data\r\n\r\n Returns:\r\n Response data or None\r\n \"\"\"\r\n return make_request(config, \"PUT\", f\"/cmdb/{path}/{name}\", json=data)\r\n\r\n\r\ndef delete(config: Dict[str, Any], path: str, name: str) -> Optional[Dict[str, Any]]:\r\n \"\"\"\r\n Generic DELETE operation for CMDB\r\n\r\n Args:\r\n config: Session configuration dictionary\r\n path: Resource path\r\n name: Object name/identifier\r\n\r\n Returns:\r\n Response data or None\r\n \"\"\"\r\n return make_request(config, \"DELETE\", f\"/cmdb/{path}/{name}\")\r\n\r\n\r\ndef apiuser_generate_key(config: Dict[str, Any], api_user: str):\r\n \"\"\"\r\n Generate API-User Key\r\n\r\n Args:\r\n config: Session configuration dictionary\r\n api_user: \r\n\r\n Returns:\r\n Response data or None\r\n \"\"\"\r\n return make_request(config, \"POST\", f\"/monitor/system/api-user/generate-key\", json={\"api-user\": api_user})\r\n\r\n\r\n# Convenience functions for common operations\r\n\r\ndef get_api_users(config: Dict[str, Any]) -> Optional[Dict[str, Any]]:\r\n \"\"\"Get all system interfaces\"\"\"\r\n return get(config, \"system/api-user\")\r\n\r\n\r\ndef create_api_user(\r\n config: Dict[str, Any],\r\n name: str,\r\n accprofile: str,\r\n trusthost: str\r\n) -> Optional[Dict[str, Any]]:\r\n \"\"\"Create a API User\"\"\"\r\n data = {\r\n \"name\": name,\r\n \"accprofile\": accprofile,\r\n \"trusthost\": [\r\n {\r\n \"type\": \"ipv4-trusthost\",\r\n \"ipv4-trusthost\": trusthost\r\n }\r\n ],\r\n \"comments\": \"Created by FortiSOAR for Labenv\",\r\n }\r\n return create(config, \"system/api-user\", data)\r\n\r\n\r\ndef main():\r\n \"\"\"Create APIUSER, if needed, and generate api key\"\"\"\r\n host = HOST\r\n username = USER\r\n password = PASS\r\n apiuser = APIUSER\r\n apiprof = APIPROF\r\n fsrhost = FSRHOST\r\n\r\n # Create session configuration\r\n config = create_session(host, username, password)\r\n\r\n if not login(config):\r\n print(json.dumps(config[\"status\"], indent=2))\r\n else:\r\n apiusers = get_api_users(config)\r\n if apiusers:\r\n config[\"status\"][\"get_api_users\"] = apiusers\r\n if apiuser not in list({a[\"name\"] for a in apiusers[\"results\"] if \"name\" in a}):\r\n create_apiuser = create_api_user(config, apiuser, apiprof, fsrhost)\r\n if create_apiuser:\r\n config[\"status\"][\"create_api_user\"] = create_apiuser\r\n\r\n apikey = apiuser_generate_key(config, apiuser)\r\n if apikey:\r\n config[\"status\"][\"generate_apikey\"] = apikey\r\n\r\n logout(config)\r\n # Print all status information at the end\r\n print(json.dumps(config[\"status\"], indent=2))\r\n\r\n\r\nmain()\r\n" }, "version": "2.1.4", "connector": "code-snippet", "operation": "python_inline_code_editor", "operationTitle": "Execute Python Code", "step_variables": [] }, "status": null, "top": "140", "left": "380", "stepType": "/api/3/workflow_step_types/1fdd14cc-d6b4-4335-a3af-ab49c8ed2fd8", "group": null, "uuid": "4343a247-f515-4c61-8354-b6b483bc5651" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.login_and_create_api_user.data['code_output']['generate_apikey'].results}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "d6c757ac-3efe-4a63-9b8e-bdc2d0ad483e" }, { "@type": "WorkflowStep", "name": "setup_initial_vars", "description": "Create default username/password", "arguments": { "fos_ip": "{{vars.input.params['fos_ip']}}", "api_user": "labenv", "password": "{{vars.input.params['password']}}", "username": "{%- if vars.input.params['username'] != '' -%}\n{{vars.input.params['username']}}\n{%- else -%}\nadmin\n{%- endif -%}", "api_profile": "super_admin", "fortisoar_ip": "{{globalVars.Server_fqhn}}" }, "status": null, "top": "60", "left": "380", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "6634a78c-bd09-4148-88bf-ff8875ce1861" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "a2312296-7095-42f1-8d47-2f29a4751b7c" } ], "routes": [ { "@type": "WorkflowRoute", "name": "login and create api user -> return", "targetStep": "/api/3/workflow_steps/d6c757ac-3efe-4a63-9b8e-bdc2d0ad483e", "sourceStep": "/api/3/workflow_steps/4343a247-f515-4c61-8354-b6b483bc5651", "label": null, "isExecuted": false, "group": null, "uuid": "8c69236d-73bb-5247-87c7-22fc2a1e609c" }, { "@type": "WorkflowRoute", "name": "setup_initial_vars -> login and create api user", "targetStep": "/api/3/workflow_steps/4343a247-f515-4c61-8354-b6b483bc5651", "sourceStep": "/api/3/workflow_steps/6634a78c-bd09-4148-88bf-ff8875ce1861", "label": null, "isExecuted": false, "group": null, "uuid": "339eaf2d-59c2-5d78-a51c-3f27b041171d" }, { "@type": "WorkflowRoute", "name": "Start -> setup_initial_vars", "targetStep": "/api/3/workflow_steps/6634a78c-bd09-4148-88bf-ff8875ce1861", "sourceStep": "/api/3/workflow_steps/a2312296-7095-42f1-8d47-2f29a4751b7c", "label": null, "isExecuted": false, "group": null, "uuid": "e49b8a0d-3012-57d9-a34b-b52e9a0fe0f6" } ], "groups": [ { "@type": "WorkflowGroup", "name": "Playbook Steps", "description": "Create an API-USER with the Trusthost of this FQHN if needed. \nGenerate a new API Key for the API-USER.\nReturn API Key", "type": "note", "isCollapsed": false, "hasTriggerStep": false, "hideInLogs": false, "metadata": [], "reusable": false, "top": "220", "left": "80", "height": "133", "width": "498", "uuid": "97e92424-5f7e-430e-9f46-4db651886cd7", "recordTags": [] } ], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "7790eb29-f020-445f-9c99-eaf998918021", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "Button for FG Revision Restore by ID", "aliasName": null, "tag": null, "description": "Restore a revision saved on the FG.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [], "synchronous": false, "triggerStep": "/api/3/workflow_steps/99923dce-ffd6-4fec-9b22-7e5353274ae6", "steps": [ { "@type": "WorkflowStep", "name": "parse_input", "description": null, "arguments": { "ip_list": "{{vars.input.params.fortigateIP.split(\",\")}}" }, "status": null, "top": "40", "left": "400", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "fc2d4de0-3122-4460-bc12-33833047a00d" }, { "@type": "WorkflowStep", "name": "restore_revision", "description": null, "arguments": { "arguments": { "fos_ip": "{{vars.item}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}", "revision_id": "{{vars.input.params.revisionID}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/e356b468-3ca7-4ed6-a924-a8dd87669fab", "for_each": { "item": "{{vars.ip_list}}", "__bulk": false, "parallel": true, "condition": "" } }, "status": null, "top": "180", "left": "400", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "eda64a2b-c617-47c0-a5b2-ad1f4a5a3b3c" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "route": "4add753c-693a-4231-b5b9-ff0ff772cdc8", "title": "FOS Helper - Revision Restore by ID", "resources": [ "devices", "managers" ], "__triggerLimit": true, "inputVariables": [ { "name": "fortigateIP", "type": "string", "label": "Fortigate IP", "title": "Text Area", "usable": false, "tooltip": "FortiGate IP or IPs using a comma seperated list.", "dataType": "text", "formType": "textarea", "required": true, "_expanded": true, "mmdUpdate": false, "collection": false, "searchable": false, "templateUrl": "app/components/form/fields/json.html", "defaultValue": null, "_previousName": "fortigateIP", "playbookField": true, "lengthConstraint": false, "allowedGridColumn": false, "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "revisionID", "type": "string", "label": "Revision ID", "tooltip": "The ID of the config to restore.", "dataType": "text", "formType": "text", "required": true, "_expanded": true, "defaultValue": "1", "_previousName": "revisionName", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "username", "type": "string", "label": "Username", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": "admin", "_previousName": "", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "password", "type": "string", "label": "Password", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": null, "_previousName": "pAssword", "jinjaExpressionView": true, "useRecordFieldDefault": false } ], "step_variables": { "input": { "params": { "password": "{{vars.request.data[\"password\"]}}", "username": "{{vars.request.data[\"username\"]}}", "revisionID": "{{vars.request.data[\"revisionID\"]}}", "fortigateIP": "{{vars.request.data[\"fortigateIP\"]}}" }, "records": "{{vars.input.records}}" } }, "_promptexpanded": true, "triggerOnSource": true, "displayConditions": { "devices": { "sort": [], "limit": 30, "logic": "OR", "filters": [ { "type": "primitive", "field": "managementMode", "value": "Deleted", "operator": "eq", "_operator": "eq" }, { "type": "primitive", "field": "managementMode", "value": "true", "operator": "isnull", "_operator": "isnull" } ] } }, "executeButtonText": "Execute", "noRecordExecution": true, "showToasterMessage": { "visible": false, "messageVisible": true }, "triggerOnReplicate": false, "singleRecordExecution": false }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/f414d039-bb0d-4e59-9c39-a8f1e880b18a", "group": null, "uuid": "99923dce-ffd6-4fec-9b22-7e5353274ae6" } ], "routes": [ { "@type": "WorkflowRoute", "name": "parse_input -> restore_revision", "targetStep": "/api/3/workflow_steps/eda64a2b-c617-47c0-a5b2-ad1f4a5a3b3c", "sourceStep": "/api/3/workflow_steps/fc2d4de0-3122-4460-bc12-33833047a00d", "label": null, "isExecuted": false, "group": null, "uuid": "0877ecdd-8881-5b4b-b59d-58c3c2e1c480" }, { "@type": "WorkflowRoute", "name": "Start -> parse_input", "targetStep": "/api/3/workflow_steps/fc2d4de0-3122-4460-bc12-33833047a00d", "sourceStep": "/api/3/workflow_steps/99923dce-ffd6-4fec-9b22-7e5353274ae6", "label": null, "isExecuted": false, "group": null, "uuid": "5f35379b-d65a-5e36-990a-978e48a463d5" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "7b3ef1dd-3e39-4e30-9d34-7f93f7df9d82", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [] }, { "@type": "Workflow", "triggerLimit": null, "name": "Button for FG Revision Restore by Comment", "aliasName": null, "tag": null, "description": "Restore a revision saved on the FG.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [], "synchronous": false, "triggerStep": "/api/3/workflow_steps/fc71d093-0f1b-422b-b214-119827b345f5", "steps": [ { "@type": "WorkflowStep", "name": "confirm", "description": null, "arguments": { "type": "InputBased", "input": { "schema": { "title": "Confirm FG Config Revert?", "description": "| FG | Revision ID | Timestamp | Comment |\n| --- | ------------- | ------------- | ------------ |\n{%- for r in vars.revision_data %}\n{%- set o = r.output %}\n| {{r.params.fos_ip}} | {{o.id}} | {{arrow.get(o.time).to(\"UTC\").format(\"YYYY-MM-DD HH:mm:ss ZZ\")}} | {{o.comment}} |\n{%- endfor %}", "inputVariables": [] } }, "record": "", "timeout": { "days": 0, "hours": 0, "minutes": 10, "step_iri": "/api/3/workflow_steps/fbb9a01d-f4c1-4f21-9f2b-50033f1f67de" }, "agent_id": null, "resources": "devices", "is_approval": false, "owner_detail": { "isAssigned": false, "emailRecipients": "" }, "isRecordLinked": false, "step_variables": [], "response_mapping": { "options": [ { "option": "Revert", "primary": true, "step_iri": "/api/3/workflow_steps/1f8b0066-a69e-458d-8468-8eb68fe86e61" }, { "option": "Skip", "step_iri": "/api/3/workflow_steps/fbb9a01d-f4c1-4f21-9f2b-50033f1f67de" } ], "duplicateOption": false, "customSuccessMessage": "Continuing" }, "email_notification": { "enabled": false, "smtpParameters": [] }, "customEmailExternal": false, "inline_channel_list": [], "external_channel_list": [], "unauthenticated_input": false, "external_email_subject": null, "internal_email_subject": "A FortiSOAR playbook is requesting your input", "custom_email_body_external": null, "external_email_attachments": null }, "status": null, "top": "400", "left": "420", "stepType": "/api/3/workflow_step_types/fc04082a-d7dc-4299-96fb-6837b1baa0fe", "group": null, "uuid": "d50ca39b-b29e-44b1-be01-127da8bde170" }, { "@type": "WorkflowStep", "name": "extract revisions", "description": null, "arguments": { "revision_data": "{{vars.steps.find_revision}}" }, "status": null, "top": "280", "left": "400", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "6a36b406-6d6c-42eb-9373-bc9ac5e963e6" }, { "@type": "WorkflowStep", "name": "find_revision", "description": null, "arguments": { "arguments": { "fos_ip": "{{vars.item}}", "password": "{{vars.password}}", "username": "{{vars.username}}", "comment_search": "{{vars.revision_comment}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/45d1368f-24bd-4f73-82db-bb18784e1c3f", "for_each": { "item": "{{vars.ip_list}}", "parallel": false, "condition": "" } }, "status": null, "top": "160", "left": "400", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "f0baaaf3-10c0-4cdd-a9b6-f7c24f05efde" }, { "@type": "WorkflowStep", "name": "restore_revision", "description": null, "arguments": { "arguments": { "fos_ip": "{{vars.item['ip']}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}", "revision_id": "{{vars.item['id']}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/e356b468-3ca7-4ed6-a924-a8dd87669fab", "for_each": { "item": "{{vars.revert_list}}", "__bulk": false, "parallel": true, "condition": "" } }, "status": null, "top": "520", "left": "80", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "64de09f8-cdba-4f84-a73c-ba3ac51f4a4b" }, { "@type": "WorkflowStep", "name": "revert configs", "description": null, "arguments": { "revert_list": "{%- set table = [] -%}\n{%- for r in vars.revision_data %}\n{%- set idx = {} -%}\n{%- set o = r.output -%}\n{%- set _do = idx.update({\"ip\":r.params.fos_ip}) -%}\n{%- set _do = idx.update({\"id\":o.id}) -%}\n{%- set _do = table.append(idx) -%}\n{%- endfor -%}\n{{table}}" }, "status": null, "top": "400", "left": "80", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "1f8b0066-a69e-458d-8468-8eb68fe86e61" }, { "@type": "WorkflowStep", "name": "set env", "description": null, "arguments": { "ip_list": "{{vars.input.params.fortigateIP.split(\",\")}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}", "revision_comment": "{{vars.input.params.revisionComment}}" }, "status": null, "top": "40", "left": "400", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "654550d2-4f93-4eae-998e-589198f33396" }, { "@type": "WorkflowStep", "name": "skip", "description": null, "arguments": { "params": [], "version": "3.3.0", "connector": "cyops_utilities", "operation": "no_op", "operationTitle": "Utils: No Operation", "step_variables": [] }, "status": null, "top": "400", "left": "740", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "fbb9a01d-f4c1-4f21-9f2b-50033f1f67de" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "route": "252c0f45-9d23-45c4-bb9f-2a74a9130500", "title": "FOS Helper - Revision Restore by Comment", "resources": [ "devices", "managers" ], "__triggerLimit": true, "inputVariables": [ { "name": "fortigateIP", "type": "string", "label": "Fortigate IP", "title": "Text Area", "usable": false, "tooltip": "FortiGate IP or IPs using a comma seperated list.", "dataType": "text", "formType": "textarea", "required": true, "_expanded": true, "mmdUpdate": false, "collection": false, "searchable": false, "templateUrl": "app/components/form/fields/json.html", "defaultValue": null, "_previousName": "fortigateIP", "playbookField": true, "lengthConstraint": false, "allowedGridColumn": false, "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "revisionComment", "type": "string", "label": "Revision Comment", "tooltip": "Search comments for a case sensative string and restore the latest.", "dataType": "text", "formType": "text", "required": true, "_expanded": true, "defaultValue": "Latest", "_previousName": "revisionID", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "username", "type": "string", "label": "Username", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": "admin", "_previousName": "", "jinjaExpressionView": true, "useRecordFieldDefault": false }, { "name": "password", "type": "string", "label": "Password", "tooltip": "", "dataType": "text", "formType": "text", "required": false, "_expanded": true, "defaultValue": null, "_previousName": "pAssword", "jinjaExpressionView": true, "useRecordFieldDefault": false } ], "step_variables": { "input": { "params": { "password": "{{vars.request.data[\"password\"]}}", "username": "{{vars.request.data[\"username\"]}}", "fortigateIP": "{{vars.request.data[\"fortigateIP\"]}}", "revisionComment": "{{vars.request.data[\"revisionComment\"]}}" }, "records": "{{vars.input.records}}" } }, "_promptexpanded": true, "triggerOnSource": true, "displayConditions": { "devices": { "sort": [], "limit": 30, "logic": "OR", "filters": [ { "type": "primitive", "field": "managementMode", "value": "Deleted", "operator": "eq", "_operator": "eq" }, { "type": "primitive", "field": "managementMode", "value": "true", "operator": "isnull", "_operator": "isnull" } ] } }, "executeButtonText": "Execute", "noRecordExecution": true, "showToasterMessage": { "visible": false, "messageVisible": true }, "triggerOnReplicate": false, "singleRecordExecution": false }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/f414d039-bb0d-4e59-9c39-a8f1e880b18a", "group": null, "uuid": "fc71d093-0f1b-422b-b214-119827b345f5" } ], "routes": [ { "@type": "WorkflowRoute", "name": "confirm -> revert configs", "targetStep": "/api/3/workflow_steps/1f8b0066-a69e-458d-8468-8eb68fe86e61", "sourceStep": "/api/3/workflow_steps/d50ca39b-b29e-44b1-be01-127da8bde170", "label": "Revert", "isExecuted": false, "group": null, "uuid": "10fe2700-86a1-5df0-87d4-f4dc014c0d53" }, { "@type": "WorkflowRoute", "name": "confirm -> skip", "targetStep": "/api/3/workflow_steps/fbb9a01d-f4c1-4f21-9f2b-50033f1f67de", "sourceStep": "/api/3/workflow_steps/d50ca39b-b29e-44b1-be01-127da8bde170", "label": "Skip", "isExecuted": false, "group": null, "uuid": "7c4ce6f4-1055-585c-9f55-8bc66f595b64" }, { "@type": "WorkflowRoute", "name": "extract revisions -> confirm", "targetStep": "/api/3/workflow_steps/d50ca39b-b29e-44b1-be01-127da8bde170", "sourceStep": "/api/3/workflow_steps/6a36b406-6d6c-42eb-9373-bc9ac5e963e6", "label": null, "isExecuted": false, "group": null, "uuid": "699d7fc1-dcb5-5295-88de-f291572c0e26" }, { "@type": "WorkflowRoute", "name": "find_revision -> extract revisions", "targetStep": "/api/3/workflow_steps/6a36b406-6d6c-42eb-9373-bc9ac5e963e6", "sourceStep": "/api/3/workflow_steps/f0baaaf3-10c0-4cdd-a9b6-f7c24f05efde", "label": null, "isExecuted": false, "group": null, "uuid": "0f4e54e3-61c9-55d2-bc38-b294eec8e07b" }, { "@type": "WorkflowRoute", "name": "revert configs -> restore_revision", "targetStep": "/api/3/workflow_steps/64de09f8-cdba-4f84-a73c-ba3ac51f4a4b", "sourceStep": "/api/3/workflow_steps/1f8b0066-a69e-458d-8468-8eb68fe86e61", "label": null, "isExecuted": false, "group": null, "uuid": "8bb85946-7ec3-53dd-b4a5-938ddbef3307" }, { "@type": "WorkflowRoute", "name": "set env -> find_revision", "targetStep": "/api/3/workflow_steps/f0baaaf3-10c0-4cdd-a9b6-f7c24f05efde", "sourceStep": "/api/3/workflow_steps/654550d2-4f93-4eae-998e-589198f33396", "label": null, "isExecuted": false, "group": null, "uuid": "1a55fda7-5d81-5928-85c1-fb089c1f234c" }, { "@type": "WorkflowRoute", "name": "Start -> set env", "targetStep": "/api/3/workflow_steps/654550d2-4f93-4eae-998e-589198f33396", "sourceStep": "/api/3/workflow_steps/fc71d093-0f1b-422b-b214-119827b345f5", "label": null, "isExecuted": false, "group": null, "uuid": "81f5f72b-9b84-5bd4-b50b-eb0f9c2335cd" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "82926782-6731-4336-bba0-0f6d845ba4e4", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - revision save", "aliasName": null, "tag": null, "description": "Perform a FortiDeploy style API change to the Central Management", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "revision_name", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/f039ce6d-cf83-40c7-a1ee-af4ee58dcb7e", "steps": [ { "@type": "WorkflowStep", "name": "fos_api", "description": null, "arguments": { "params": { "url": "https://{{vars.fos_ip}}/api/v2/monitor/system/config-revision/save", "body": "{{vars.payload}}", "method": "POST", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.2.6", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "140", "left": "340", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "ab56a51e-a004-44fa-ae73-db753ca73c0b" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}", "payload": "{ \n \"comments\": \"{{vars.revision_name}}\" \n}" }, "status": null, "top": "100", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "90428d66-3eca-407f-bd8e-e9d187429975" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fos_api.data}}", "params": "{{vars.input.params}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "59cc44ea-4ed3-4091-b42f-a2a1fb6925ce" }, { "@type": "WorkflowStep", "name": "setup_vars", "description": null, "arguments": { "token": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}", "revision_name": "{{vars.input.params['revision_name']}}" }, "status": null, "top": "60", "left": "340", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "09245942-b6aa-4607-809b-60c4de560558" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "f039ce6d-cf83-40c7-a1ee-af4ee58dcb7e" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fos_api -> return", "targetStep": "/api/3/workflow_steps/59cc44ea-4ed3-4091-b42f-a2a1fb6925ce", "sourceStep": "/api/3/workflow_steps/ab56a51e-a004-44fa-ae73-db753ca73c0b", "label": null, "isExecuted": false, "group": null, "uuid": "b91d0ebb-c00c-5561-b17e-fbdb21cf2f46" }, { "@type": "WorkflowRoute", "name": "header_payload -> fos_api", "targetStep": "/api/3/workflow_steps/ab56a51e-a004-44fa-ae73-db753ca73c0b", "sourceStep": "/api/3/workflow_steps/90428d66-3eca-407f-bd8e-e9d187429975", "label": null, "isExecuted": false, "group": null, "uuid": "d214f5c9-1dac-5ef4-b5a9-ad8d77dd64ed" }, { "@type": "WorkflowRoute", "name": "setup_vars -> header_payload", "targetStep": "/api/3/workflow_steps/90428d66-3eca-407f-bd8e-e9d187429975", "sourceStep": "/api/3/workflow_steps/09245942-b6aa-4607-809b-60c4de560558", "label": null, "isExecuted": false, "group": null, "uuid": "d87e5111-a2af-594b-82a1-f70ab6dae53c" }, { "@type": "WorkflowRoute", "name": "Start -> setup_vars", "targetStep": "/api/3/workflow_steps/09245942-b6aa-4607-809b-60c4de560558", "sourceStep": "/api/3/workflow_steps/f039ce6d-cf83-40c7-a1ee-af4ee58dcb7e", "label": null, "isExecuted": false, "group": null, "uuid": "47552bdb-dc8b-52c7-bf4f-7f486cbcd4ae" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "8d3d9226-b79a-475b-b9da-292decd7c52c", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fosapi - revision restore", "aliasName": null, "tag": null, "description": "Restore the config of a FG.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fos_ip", "revision_id", "apikey" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/d517a7af-17b1-4205-a99d-135f705520cd", "steps": [ { "@type": "WorkflowStep", "name": "fos_api", "description": null, "arguments": { "params": { "url": "https://{{vars.fos_ip}}/api/v2/monitor/system/config/restore", "body": "{{vars.payload}}", "method": "POST", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.2.6", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "140", "left": "340", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "0dabcf3f-e29c-47ce-94d4-de099ea8aee3" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"Accept\": \"application/json\",\n \"Authorization\": \"Bearer {{vars.token}}\"\n}", "payload": "{\n \"source\": \"revision\",\n \"scope\": \"global\",\n \"config_id\": {{vars.revision_id}}\n}" }, "status": null, "top": "100", "left": "700", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "c2ade352-764d-4e4a-bdf4-6f96449b9811" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fos_api.data}}", "params": "{{vars.input.params}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "d6f04754-d95a-4129-a1ff-5d1dd4d68f50" }, { "@type": "WorkflowStep", "name": "setup_vars", "description": null, "arguments": { "token": "{{vars.input.params.apikey}}", "fos_ip": "{{vars.input.params['fos_ip']}}", "revision_id": "{{vars.input.params['revision_id']}}" }, "status": null, "top": "60", "left": "340", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "be7ffcba-2516-4b0b-9140-7075a083cc7a" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "d517a7af-17b1-4205-a99d-135f705520cd" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fos_api -> return", "targetStep": "/api/3/workflow_steps/d6f04754-d95a-4129-a1ff-5d1dd4d68f50", "sourceStep": "/api/3/workflow_steps/0dabcf3f-e29c-47ce-94d4-de099ea8aee3", "label": null, "isExecuted": false, "group": null, "uuid": "5d77506d-e599-5f59-b802-cf9332e759ea" }, { "@type": "WorkflowRoute", "name": "header_payload -> fos_api", "targetStep": "/api/3/workflow_steps/0dabcf3f-e29c-47ce-94d4-de099ea8aee3", "sourceStep": "/api/3/workflow_steps/c2ade352-764d-4e4a-bdf4-6f96449b9811", "label": null, "isExecuted": false, "group": null, "uuid": "183030b4-e8e5-5554-88c1-279012ffc0bf" }, { "@type": "WorkflowRoute", "name": "setup_vars -> header_payload", "targetStep": "/api/3/workflow_steps/c2ade352-764d-4e4a-bdf4-6f96449b9811", "sourceStep": "/api/3/workflow_steps/be7ffcba-2516-4b0b-9140-7075a083cc7a", "label": null, "isExecuted": false, "group": null, "uuid": "2e7df3dd-ef97-5d19-a59a-c6cbe9c94665" }, { "@type": "WorkflowRoute", "name": "Start -> setup_vars", "targetStep": "/api/3/workflow_steps/be7ffcba-2516-4b0b-9140-7075a083cc7a", "sourceStep": "/api/3/workflow_steps/d517a7af-17b1-4205-a99d-135f705520cd", "label": null, "isExecuted": false, "group": null, "uuid": "3a5833da-f919-5344-b09d-21a0c51912af" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "isEditable": true, "uuid": "e356b468-3ca7-4ed6-a924-a8dd87669fab", "isPrivate": false, "importedBy": [ { "apiName": "labEnvs", "name": "LabEnvs", "version": "1.0.9" } ], "recordTags": [ "fos_ip", "Microservice", "password", "username" ] } ] }, { "@type": "WorkflowCollection", "name": "FortiManager(FMG)-Helpers", "description": "", "visible": true, "image": null, "recordTags": [], "workflows": [ { "@type": "Workflow", "triggerLimit": null, "name": "> get devices", "aliasName": null, "tag": null, "description": "Get the dvmdb/device table", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fmg_ip", "username", "password" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/0399b291-9c13-4e9e-a10a-6e8bdd48abbe", "steps": [ { "@type": "WorkflowStep", "name": "fmg_api", "description": null, "arguments": { "params": { "url": "{{vars.url_jsonrpc}}", "body": "{{vars.payload}}", "method": "POST", "params": "", "verify": false, "headers": "", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "240", "left": "680", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "a6863813-2284-470b-ac7c-9c4aad9a99d4" }, { "@type": "WorkflowStep", "name": "fmg login", "description": null, "arguments": { "arguments": { "fmg_ip": "{{vars.input.params['fmg_ip']}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/f7573ec0-2c3d-4cc2-86cf-0505387e459d" }, "status": null, "top": "40", "left": "360", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "b5072c36-a343-4613-bc11-c4b3d781284d" }, { "@type": "WorkflowStep", "name": "fmg logout", "description": null, "arguments": { "arguments": { "fmg_ip": "{{vars.fmg_ip}}", "session": "{{vars.session}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/1dfd69c8-0ad4-48c2-a6e9-fceaec91f82f" }, "status": null, "top": "140", "left": "360", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "20983c2d-96d8-4353-bb66-7b345c0e3bf0" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"accept\": \"application/json\"\n}", "payload": "{\n \"id\": 1,\n \"method\": \"{{vars.method}}\",\n \"params\": [\n {\n \"url\": \"{{vars.url_api}}\"\n }\n ],\n \"session\": \"{{vars.session}}\",\n \"verbose\": 1\n}" }, "status": null, "top": "140", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "18d6a746-ee73-498e-9d86-0a5beef2c3d2" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fmg_api.data}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "06086997-5ba4-4222-9b40-ba7cbe36952f" }, { "@type": "WorkflowStep", "name": "setup env", "description": null, "arguments": { "fmg_ip": "{{vars.input.params['fmg_ip']}}", "method": "get", "session": "{{vars.steps.fmg_login.output.session}}", "url_api": "dvmdb/device", "url_jsonrpc": "https://{{vars.fmg_ip}}/jsonrpc" }, "status": null, "top": "40", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "d89104e2-5928-48ca-8be3-18ded6b9601f" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "__triggerLimit": true, "step_variables": { "input": { "params": [] } }, "triggerOnSource": true, "triggerOnReplicate": false }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "0399b291-9c13-4e9e-a10a-6e8bdd48abbe" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fmg_api -> fmg logout", "targetStep": "/api/3/workflow_steps/20983c2d-96d8-4353-bb66-7b345c0e3bf0", "sourceStep": "/api/3/workflow_steps/a6863813-2284-470b-ac7c-9c4aad9a99d4", "label": null, "isExecuted": false, "group": null, "uuid": "5891067f-4ca7-5da1-8925-e0ec12bd4beb" }, { "@type": "WorkflowRoute", "name": "fmg login -> setup env", "targetStep": "/api/3/workflow_steps/d89104e2-5928-48ca-8be3-18ded6b9601f", "sourceStep": "/api/3/workflow_steps/b5072c36-a343-4613-bc11-c4b3d781284d", "label": null, "isExecuted": false, "group": null, "uuid": "dc3126ff-c268-5a21-9f61-abdfda01175c" }, { "@type": "WorkflowRoute", "name": "fmg logout -> return", "targetStep": "/api/3/workflow_steps/06086997-5ba4-4222-9b40-ba7cbe36952f", "sourceStep": "/api/3/workflow_steps/20983c2d-96d8-4353-bb66-7b345c0e3bf0", "label": null, "isExecuted": false, "group": null, "uuid": "b5615f5a-23ac-545d-8ed6-89d80cbbaa07" }, { "@type": "WorkflowRoute", "name": "header_payload -> fmg_api", "targetStep": "/api/3/workflow_steps/a6863813-2284-470b-ac7c-9c4aad9a99d4", "sourceStep": "/api/3/workflow_steps/18d6a746-ee73-498e-9d86-0a5beef2c3d2", "label": null, "isExecuted": false, "group": null, "uuid": "134e511e-f319-55e1-a96e-dc814c9223cf" }, { "@type": "WorkflowRoute", "name": "setup env -> header_payload", "targetStep": "/api/3/workflow_steps/18d6a746-ee73-498e-9d86-0a5beef2c3d2", "sourceStep": "/api/3/workflow_steps/d89104e2-5928-48ca-8be3-18ded6b9601f", "label": null, "isExecuted": false, "group": null, "uuid": "544cd7c9-abe6-56a7-84ea-bf6edcf7a2ed" }, { "@type": "WorkflowRoute", "name": "Start -> fmg login", "targetStep": "/api/3/workflow_steps/b5072c36-a343-4613-bc11-c4b3d781284d", "sourceStep": "/api/3/workflow_steps/0399b291-9c13-4e9e-a10a-6e8bdd48abbe", "label": null, "isExecuted": false, "group": null, "uuid": "a4b69913-a944-5da2-a165-b122ed504bd5" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "uuid": "8d06c12b-cdc4-4ec1-869d-25b7408bded3", "isPrivate": false, "recordTags": [] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fmgapi - login json-rpc", "aliasName": null, "tag": null, "description": "Authenticate via username/password and retrieve the session.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fmg_ip", "username", "password" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/1b64369c-9fca-4da3-8808-691697fd7f21", "steps": [ { "@type": "WorkflowStep", "name": "fmg_login", "description": null, "arguments": { "params": { "url": "{{vars.url_jsonrpc}}", "body": "{{vars.payload}}", "method": "POST", "params": "", "verify": false, "headers": "", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "300", "left": "440", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "4bc7efcc-5e03-438a-b773-86175d6e63db" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"accept\": \"application/json\"\n}", "payload": "{\n \"id\": 1,\n \"method\": \"exec\",\n \"params\": [\n {\n \"data\": [\n {\n \"user\": \"{{vars.username}}\",\n \"passwd\": \"{{vars.password}}\"\n\n }\n ],\n \"url\": \"{{vars.url_api}}\"\n }\n ],\n \"session\": null,\n \"verbose\": 1\n}" }, "status": null, "top": "180", "left": "440", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "015af29e-5303-4ed4-9402-e3327bc47746" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fmg_login.data}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "24d305bc-0f38-4e32-8b17-2205d48dd2db" }, { "@type": "WorkflowStep", "name": "setup_initial_vars", "description": "Create default username/password", "arguments": { "fmg_ip": "{{vars.input.params['fmg_ip']}}", "url_api": "sys/login/user", "password": "{{vars.input.params['password']}}", "username": "{%- if vars.input.params['username'] != '' -%}\n{{vars.input.params['username']}}\n{%- else -%}\nadmin\n{%- endif -%}", "url_jsonrpc": "https://{{vars.fmg_ip}}/jsonrpc" }, "status": null, "top": "60", "left": "440", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "64f43c4e-3e27-4247-a6fd-6ca5e50982be" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "1b64369c-9fca-4da3-8808-691697fd7f21" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fmg_login -> return", "targetStep": "/api/3/workflow_steps/24d305bc-0f38-4e32-8b17-2205d48dd2db", "sourceStep": "/api/3/workflow_steps/4bc7efcc-5e03-438a-b773-86175d6e63db", "label": null, "isExecuted": false, "group": null, "uuid": "800c6673-f8ad-5532-be9d-ccb7b7879158" }, { "@type": "WorkflowRoute", "name": "header_payload -> fmg_login", "targetStep": "/api/3/workflow_steps/4bc7efcc-5e03-438a-b773-86175d6e63db", "sourceStep": "/api/3/workflow_steps/015af29e-5303-4ed4-9402-e3327bc47746", "label": null, "isExecuted": false, "group": null, "uuid": "5ce8d7e9-43f5-515e-bd2e-7267345b1393" }, { "@type": "WorkflowRoute", "name": "setup_initial_vars -> header_payload", "targetStep": "/api/3/workflow_steps/015af29e-5303-4ed4-9402-e3327bc47746", "sourceStep": "/api/3/workflow_steps/64f43c4e-3e27-4247-a6fd-6ca5e50982be", "label": null, "isExecuted": false, "group": null, "uuid": "f3ea70fd-45da-5328-a428-a2f12f064d68" }, { "@type": "WorkflowRoute", "name": "Start -> setup_initial_vars", "targetStep": "/api/3/workflow_steps/64f43c4e-3e27-4247-a6fd-6ca5e50982be", "sourceStep": "/api/3/workflow_steps/1b64369c-9fca-4da3-8808-691697fd7f21", "label": null, "isExecuted": false, "group": null, "uuid": "e1eaa3a4-b1cf-52b1-b6d3-ec439b7e98c4" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "uuid": "f7573ec0-2c3d-4cc2-86cf-0505387e459d", "isPrivate": false, "recordTags": [ "fos_ip", "Microservice", "password", "username" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> fmgapi - logout json-rpc", "aliasName": null, "tag": null, "description": "Logout", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fmg_ip", "session" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/73b2ac45-d202-4e00-910d-897f75603d15", "steps": [ { "@type": "WorkflowStep", "name": "fmg_logout", "description": null, "arguments": { "params": { "url": "{{vars.url_jsonrpc}}", "body": "{{vars.payload}}", "method": "POST", "params": "", "verify": false, "headers": "{{vars.header}}", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "300", "left": "440", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "ed567ed1-0e50-48cd-b13d-a8aec534e7de" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"json\",\n \"Accept\": \"application/json\"\n}", "payload": "{\n \"id\": 1,\n \"jsonrpc\": \"1.0\",\n \"method\": \"exec\",\n \"params\": [\n {\n \"url\": \"{{vars.url_api}}\"\n }\n ],\n \"session\": \"{{vars.session}}\",\n \"verbose\": 1\n}" }, "status": null, "top": "180", "left": "440", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "300e99f9-8c11-44b6-8a2c-ca168bf1d24b" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fmg_logout.data}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "770f0c9e-db9d-4d3d-931c-1b5c0367deeb" }, { "@type": "WorkflowStep", "name": "setup_initial_vars", "description": "Create default username/password", "arguments": { "fmg_ip": "{{vars.input.params['fmg_ip']}}", "session": "{{vars.input.params.session}}", "url_api": "sys/logout", "url_jsonrpc": "https://{{vars.fmg_ip}}/jsonrpc" }, "status": null, "top": "60", "left": "440", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "e7b5b598-77d5-422b-8473-028992c07c92" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "step_variables": { "input": { "params": [] } } }, "status": null, "top": "60", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "73b2ac45-d202-4e00-910d-897f75603d15" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fmg_logout -> return", "targetStep": "/api/3/workflow_steps/770f0c9e-db9d-4d3d-931c-1b5c0367deeb", "sourceStep": "/api/3/workflow_steps/ed567ed1-0e50-48cd-b13d-a8aec534e7de", "label": null, "isExecuted": false, "group": null, "uuid": "58254b65-5149-50e4-84bd-89685b052b8e" }, { "@type": "WorkflowRoute", "name": "header_payload -> fmg_logout", "targetStep": "/api/3/workflow_steps/ed567ed1-0e50-48cd-b13d-a8aec534e7de", "sourceStep": "/api/3/workflow_steps/300e99f9-8c11-44b6-8a2c-ca168bf1d24b", "label": null, "isExecuted": false, "group": null, "uuid": "3aba77f0-2dc1-5478-b1b8-970c07662abf" }, { "@type": "WorkflowRoute", "name": "setup_initial_vars -> header_payload", "targetStep": "/api/3/workflow_steps/300e99f9-8c11-44b6-8a2c-ca168bf1d24b", "sourceStep": "/api/3/workflow_steps/e7b5b598-77d5-422b-8473-028992c07c92", "label": null, "isExecuted": false, "group": null, "uuid": "5f80eb02-4ec5-5d84-ab27-0266e0ac4355" }, { "@type": "WorkflowRoute", "name": "Start -> setup_initial_vars", "targetStep": "/api/3/workflow_steps/e7b5b598-77d5-422b-8473-028992c07c92", "sourceStep": "/api/3/workflow_steps/73b2ac45-d202-4e00-910d-897f75603d15", "label": null, "isExecuted": false, "group": null, "uuid": "cbd49f20-067c-5b47-86cd-aaee9746d6a0" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "uuid": "1dfd69c8-0ad4-48c2-a6e9-fceaec91f82f", "isPrivate": false, "recordTags": [ "fos_ip", "Microservice", "token" ] }, { "@type": "Workflow", "triggerLimit": null, "name": "> general api call", "aliasName": null, "tag": null, "description": "Generic API call", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fmg_ip", "username", "password", "method", "resource_url", "data", "option" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/7c81ff54-0bd8-4c01-af89-8beb91ca0bff", "steps": [ { "@type": "WorkflowStep", "name": "fmg_api", "description": null, "arguments": { "params": { "url": "{{vars.url_jsonrpc}}", "body": "{{vars.payload}}", "method": "POST", "params": "", "verify": false, "headers": "", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "240", "left": "680", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "19405186-2780-4e34-8781-fbb986d95781" }, { "@type": "WorkflowStep", "name": "fmg login", "description": null, "arguments": { "arguments": { "fmg_ip": "{{vars.input.params['fmg_ip']}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/f7573ec0-2c3d-4cc2-86cf-0505387e459d" }, "status": null, "top": "40", "left": "360", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "bd6917ff-312d-41bc-87c3-d4dcd8d272b9" }, { "@type": "WorkflowStep", "name": "fmg logout", "description": null, "arguments": { "arguments": { "fmg_ip": "{{vars.fmg_ip}}", "session": "{{vars.session}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/1dfd69c8-0ad4-48c2-a6e9-fceaec91f82f" }, "status": null, "top": "140", "left": "360", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "3613cdb2-9f6b-49a6-821f-970e632de277" }, { "@type": "WorkflowStep", "name": "header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"accept\": \"application/json\"\n}", "payload": "{%- set payload = {} -%}\n{%- set params = [] -%}\n{%- set _do = payload.update({\"id\":1,\"method\":vars.method,\"session\":vars.session}) -%}\n{%- set _do = params.append({\"url\":vars.url_api}) -%}\n{%- set _do = payload.update({\"params\":params}) -%}\n{{payload}}" }, "status": null, "top": "140", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "6325bcaa-90ac-4ca3-94d3-28873c5faa8a" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fmg_api.data}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "2affd600-5c61-41d6-8dcb-669eeebf0317" }, { "@type": "WorkflowStep", "name": "setup env", "description": null, "arguments": { "fmg_ip": "{{vars.input.params['fmg_ip']}}", "method": "{{vars.input.params.method|default(\"get\")}}", "session": "{{vars.steps.fmg_login.output.session}}", "url_api": "{{vars.input.params['resource_url']}}", "url_jsonrpc": "https://{{vars.fmg_ip}}/jsonrpc" }, "status": null, "top": "40", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "7468f8c1-fad6-45a3-87df-2e1b571fc6f6" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "__triggerLimit": true, "step_variables": { "input": { "params": [] } }, "triggerOnSource": true, "triggerOnReplicate": false }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "7c81ff54-0bd8-4c01-af89-8beb91ca0bff" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fmg_api -> fmg logout", "targetStep": "/api/3/workflow_steps/3613cdb2-9f6b-49a6-821f-970e632de277", "sourceStep": "/api/3/workflow_steps/19405186-2780-4e34-8781-fbb986d95781", "label": null, "isExecuted": false, "group": null, "uuid": "eb3efc95-779c-58b7-8428-4e14bfc04837" }, { "@type": "WorkflowRoute", "name": "fmg login -> setup env", "targetStep": "/api/3/workflow_steps/7468f8c1-fad6-45a3-87df-2e1b571fc6f6", "sourceStep": "/api/3/workflow_steps/bd6917ff-312d-41bc-87c3-d4dcd8d272b9", "label": null, "isExecuted": false, "group": null, "uuid": "2ad7162d-ea9f-57c9-aa38-0ca1f13a157a" }, { "@type": "WorkflowRoute", "name": "fmg logout -> return", "targetStep": "/api/3/workflow_steps/2affd600-5c61-41d6-8dcb-669eeebf0317", "sourceStep": "/api/3/workflow_steps/3613cdb2-9f6b-49a6-821f-970e632de277", "label": null, "isExecuted": false, "group": null, "uuid": "69ff9d49-9f58-55ba-927d-39db12572c1c" }, { "@type": "WorkflowRoute", "name": "header_payload -> fmg_api", "targetStep": "/api/3/workflow_steps/19405186-2780-4e34-8781-fbb986d95781", "sourceStep": "/api/3/workflow_steps/6325bcaa-90ac-4ca3-94d3-28873c5faa8a", "label": null, "isExecuted": false, "group": null, "uuid": "ef6e4515-69d4-5f53-8ad1-6b47e7f1e6e2" }, { "@type": "WorkflowRoute", "name": "setup env -> header_payload", "targetStep": "/api/3/workflow_steps/6325bcaa-90ac-4ca3-94d3-28873c5faa8a", "sourceStep": "/api/3/workflow_steps/7468f8c1-fad6-45a3-87df-2e1b571fc6f6", "label": null, "isExecuted": false, "group": null, "uuid": "140963fd-ddec-58fb-8c8b-76a00c875557" }, { "@type": "WorkflowRoute", "name": "Start -> fmg login", "targetStep": "/api/3/workflow_steps/bd6917ff-312d-41bc-87c3-d4dcd8d272b9", "sourceStep": "/api/3/workflow_steps/7c81ff54-0bd8-4c01-af89-8beb91ca0bff", "label": null, "isExecuted": false, "group": null, "uuid": "ed7b9bfe-4acd-55ea-a5fc-1c5de79a7739" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "uuid": "2e0ec9f0-6bbc-4d2f-b3e1-414c62813691", "isPrivate": false, "recordTags": [] }, { "@type": "Workflow", "triggerLimit": null, "name": "> firmware template - set scope", "aliasName": null, "tag": null, "description": "Set the scope of a firmware template.", "isActive": false, "debug": false, "singleRecordExecution": false, "remoteExecutableFlag": false, "parameters": [ "fmg_ip", "username", "password", "device", "adom", "firmware_template" ], "synchronous": false, "triggerStep": "/api/3/workflow_steps/79556541-411c-442e-99ec-76b31a3fcae4", "steps": [ { "@type": "WorkflowStep", "name": "fmgapi_gettemplate", "description": null, "arguments": { "params": { "url": "{{vars.url_jsonrpc}}", "body": "{{vars.payload_get_template}}", "method": "POST", "params": "", "verify": false, "headers": "", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "340", "left": "680", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "10021b1a-478b-4e21-96a4-2d4048300b7a" }, { "@type": "WorkflowStep", "name": "fmg_api_update", "description": null, "arguments": { "params": { "url": "{{vars.url_jsonrpc}}", "body": "{{vars.payload_updatetemplate}}", "method": "POST", "params": "", "verify": false, "headers": "", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "540", "left": "680", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "9c1c9607-c6a3-444b-89d4-9b75b7a74e98" }, { "@type": "WorkflowStep", "name": "fmgapi_update_scope", "description": null, "arguments": { "params": { "url": "{{vars.url_jsonrpc}}", "body": "{{vars.payload_update_scopemember}}", "method": "POST", "params": "", "verify": false, "headers": "", "password": "", "username": "", "auth_config": "" }, "version": "3.3.0", "connector": "cyops_utilities", "operation": "api_call", "operationTitle": "Utils: Make REST API Call", "step_variables": [] }, "status": null, "top": "240", "left": "680", "stepType": "/api/3/workflow_step_types/0109f35d-090b-4a2b-bd8a-94cbc3508562", "group": null, "uuid": "c543de38-d99f-4f65-99ec-040a451ed0b0" }, { "@type": "WorkflowStep", "name": "fmg login", "description": null, "arguments": { "arguments": { "fmg_ip": "{{vars.input.params['fmg_ip']}}", "password": "{{vars.input.params.password}}", "username": "{{vars.input.params.username}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/f7573ec0-2c3d-4cc2-86cf-0505387e459d" }, "status": null, "top": "40", "left": "360", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "81d55117-7645-4605-a822-8930d46bd4ee" }, { "@type": "WorkflowStep", "name": "fmg logout", "description": null, "arguments": { "arguments": { "fmg_ip": "{{vars.fmg_ip}}", "session": "{{vars.session}}" }, "apply_async": false, "step_variables": [], "pass_parent_env": false, "pass_input_record": false, "workflowReference": "/api/3/workflows/1dfd69c8-0ad4-48c2-a6e9-fceaec91f82f" }, "status": null, "top": "140", "left": "360", "stepType": "/api/3/workflow_step_types/74932bdc-b8b6-4d24-88c4-1a4dfbc524f3", "group": null, "uuid": "ece2ec0f-a263-4f17-8b16-2762152db777" }, { "@type": "WorkflowStep", "name": "payload_update", "description": null, "arguments": { "payload_updatetemplate": "{%- set data = vars.steps.fmgapi_gettemplate.data.result[0].data -%}\n{%- set _do = data[\"fwmprof setting\"].update({ \"description\" : \"Updated \" + arrow.utcnow().int_timestamp|string }) -%}\n{\n \"id\": 1,\n \"method\": \"update\",\n \"params\": [\n {\n \"data\": {{data}},\n \"url\": \"{{vars.firmware_url}}\"\n }\n ],\n \"session\": \"{{vars.session}}\"\n}" }, "status": null, "top": "440", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "33a2e348-9cf2-4cf6-a47f-3b8a3ffc64e5" }, { "@type": "WorkflowStep", "name": "return", "description": null, "arguments": { "output": "{{vars.steps.fmgapi_update_scope.data}}" }, "status": null, "top": "140", "left": "40", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "c70b4f99-1140-43ac-a257-4ff980b99d35" }, { "@type": "WorkflowStep", "name": "setup env", "description": null, "arguments": { "adom": "{{vars.input.params.adom}}", "device": "{{vars.input.params.device}}", "fmg_ip": "{{vars.input.params['fmg_ip']}}", "session": "{{vars.steps.fmg_login.output.session}}", "url_api": "dvmdb/device", "url_jsonrpc": "https://{{vars.fmg_ip}}/jsonrpc", "firmware_template": "{{vars.input.params['firmware_template']}}" }, "status": null, "top": "40", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "3ce1670b-b12d-4818-8648-196c8bae9e4c" }, { "@type": "WorkflowStep", "name": "Start", "description": null, "arguments": { "__triggerLimit": true, "step_variables": { "input": { "params": [] } }, "triggerOnSource": true, "triggerOnReplicate": false }, "status": null, "top": "40", "left": "40", "stepType": "/api/3/workflow_step_types/b348f017-9a94-471f-87f8-ce88b6a7ad62", "group": null, "uuid": "79556541-411c-442e-99ec-76b31a3fcae4" }, { "@type": "WorkflowStep", "name": "url_header_payload", "description": null, "arguments": { "header": "{\n \"Content-Type\": \"application/json\",\n \"accept\": \"application/json\"\n}", "firmware_url": "/pm/fwmprof/adom/{{vars.adom}}/{{vars.firmware_template}}", "payload_get_template": "{\n \"id\": 1,\n \"method\": \"get\",\n \"params\": [\n {\n \"url\": \"{{vars.firmware_url}}\"\n }\n ],\n \"session\": \"{{vars.session}}\"\n}", "payload_update_scopemember": "{\n \"id\": 1,\n \"method\": \"add\",\n \"params\": [\n {\n \"data\": [\n {\n \"name\": \"{{vars.device}}\",\n \"vdom\": \"root\"\n }\n ],\n \"url\": \"{{vars.firmware_url}}/scope member\"\n }\n ],\n \"session\": \"{{vars.session}}\"\n}" }, "status": null, "top": "140", "left": "680", "stepType": "/api/3/workflow_step_types/04d0cf46-b6a8-42c4-8683-60a7eaa69e8f", "group": null, "uuid": "923f7b24-adb9-4d19-ad9c-9f2764d51428" } ], "routes": [ { "@type": "WorkflowRoute", "name": "fmgapi_gettemplate -> payload_update", "targetStep": "/api/3/workflow_steps/33a2e348-9cf2-4cf6-a47f-3b8a3ffc64e5", "sourceStep": "/api/3/workflow_steps/10021b1a-478b-4e21-96a4-2d4048300b7a", "label": null, "isExecuted": false, "group": null, "uuid": "86cb6e39-055f-59ec-bace-acb1f164cd4c" }, { "@type": "WorkflowRoute", "name": "fmg_api_update -> fmg logout", "targetStep": "/api/3/workflow_steps/ece2ec0f-a263-4f17-8b16-2762152db777", "sourceStep": "/api/3/workflow_steps/9c1c9607-c6a3-444b-89d4-9b75b7a74e98", "label": null, "isExecuted": false, "group": null, "uuid": "61c4af1d-ad68-5d22-bba2-f3338360147f" }, { "@type": "WorkflowRoute", "name": "fmgapi_update_scope -> fmgapi_gettemplate", "targetStep": "/api/3/workflow_steps/10021b1a-478b-4e21-96a4-2d4048300b7a", "sourceStep": "/api/3/workflow_steps/c543de38-d99f-4f65-99ec-040a451ed0b0", "label": null, "isExecuted": false, "group": null, "uuid": "9dec4a67-8c4f-5304-bbe2-a74b5fb9bf39" }, { "@type": "WorkflowRoute", "name": "fmg login -> setup env", "targetStep": "/api/3/workflow_steps/3ce1670b-b12d-4818-8648-196c8bae9e4c", "sourceStep": "/api/3/workflow_steps/81d55117-7645-4605-a822-8930d46bd4ee", "label": null, "isExecuted": false, "group": null, "uuid": "4609b21f-9148-57cd-9394-a47347a3cd0c" }, { "@type": "WorkflowRoute", "name": "fmg logout -> return", "targetStep": "/api/3/workflow_steps/c70b4f99-1140-43ac-a257-4ff980b99d35", "sourceStep": "/api/3/workflow_steps/ece2ec0f-a263-4f17-8b16-2762152db777", "label": null, "isExecuted": false, "group": null, "uuid": "f43aa28f-4415-5fd4-9683-072cd28c6058" }, { "@type": "WorkflowRoute", "name": "payload_update -> fmg_api_update", "targetStep": "/api/3/workflow_steps/9c1c9607-c6a3-444b-89d4-9b75b7a74e98", "sourceStep": "/api/3/workflow_steps/33a2e348-9cf2-4cf6-a47f-3b8a3ffc64e5", "label": null, "isExecuted": false, "group": null, "uuid": "a6cc5c88-da0d-5187-aa36-98bcf821472a" }, { "@type": "WorkflowRoute", "name": "setup env -> url_header_payload", "targetStep": "/api/3/workflow_steps/923f7b24-adb9-4d19-ad9c-9f2764d51428", "sourceStep": "/api/3/workflow_steps/3ce1670b-b12d-4818-8648-196c8bae9e4c", "label": null, "isExecuted": false, "group": null, "uuid": "71e1d1d7-4b6a-5696-9dcf-50009d2e5628" }, { "@type": "WorkflowRoute", "name": "Start -> fmg login", "targetStep": "/api/3/workflow_steps/81d55117-7645-4605-a822-8930d46bd4ee", "sourceStep": "/api/3/workflow_steps/79556541-411c-442e-99ec-76b31a3fcae4", "label": null, "isExecuted": false, "group": null, "uuid": "a490de33-2d3e-5945-ab43-cb282b7663a9" }, { "@type": "WorkflowRoute", "name": "url_header_payload -> fmgapi_update_scope", "targetStep": "/api/3/workflow_steps/c543de38-d99f-4f65-99ec-040a451ed0b0", "sourceStep": "/api/3/workflow_steps/923f7b24-adb9-4d19-ad9c-9f2764d51428", "label": null, "isExecuted": false, "group": null, "uuid": "6c180fb7-4145-50f8-898f-e860a37ea83a" } ], "groups": [], "priority": "/api/3/picklists/2b563c61-ae2c-41c0-a85a-c9709585e3f2", "uuid": "e6984467-8fd7-414a-808c-a556c5ed6af0", "isPrivate": false, "recordTags": [] } ] } ] }