Overview
An Operational Status Plugin should be a ZIP archive containing the files described below.
ZIP Archive Structure
| File / Folder | Description |
| logo.png | Logo displayed for the Console item in the JetPatch Agent Manager Library. |
| plugin.descriptor | Contains plugin metadata. See details below. |
| environment.descriptor | (Optional) Defines input fields to be configured for the Console item in the Library. JetPatch Agent Manager passes these field values to the plugin script. |
| bin | Folder containing the actual script file(s) to run on the backend server. |
plugin.descriptor
Contains plugin metadata in JSON format. Example:
{ "executionType": "BACKEND_CONSOLE_CLI", "tool": "MyAgent", "supportedVersion": "1", "cmdLine": "script.bat", "category": "Security" } |
Field descriptions:
| Field | Description |
| executionType | Currently must be BACKEND_CONSOLE_CLI. |
| tool | The agent name. JetPatch Agent Manager uses this name to check if the agent is managed by JetPatch Agent Manager. |
| supportedVersion | Not currently used. |
| cmdLine | The script file to be executed in the bin folder. |
| category | Not currently used. |
environment.descriptor (Optional)
Defines input fields to be configured for the Console item in the JetPatch Agent Manager Library. JetPatch Agent Manager passes these field values to the plugin script.
The format is JSON, containing a single object with a single variables attribute whose value is an array of input variable objects. Example:
{ "variables": [ { "id": "arg1", "title": "The argument title to be displayed", "help": "Yes\No", "type": "STRING", "required": true, "default": "No" }, { "id": "arg2", ... } ] } |
bin Folder - Script Requirements
The bin folder contains the actual script file(s) to run on the backend server.
The file referenced in plugin.descriptor > cmdLine will be executed and can call other files in the folder.
The script should retrieve information and generate a CSV file with a row for each endpoint.
The CSV file must be passed to $INTIGUA_OUTPUT_FILE. The script can use the user-defined values of the variables defined in environment.descriptor.
CSV Output Columns
The CSV file must contain the following 9 columns in this exact order:
| # | Column | Description |
| 1 | name | Endpoint name. |
| 2 | host | Endpoint hostname (DNS). |
| 3 | ip | Endpoint IP address. |
| 4 | isDeployed | Whether the management tool is deployed on the endpoint (Yes/No). |
| 5 | policyGroups | Groups to which the endpoint agent is registered in backend server configuration. |
| 6 | agentVersion | The version of the agent. |
| 7 | isConnected | Whether the backend server has an active connection with the management tool (Yes/No). |
| 8 | isOK | Management tool health status (Yes/No). |
| 9 | whyNotOk | An informative status report. |
Comments
0 comments
Please sign in to leave a comment.