The infrastructure agent is an application written on Go that can be run as a Windows service in order to facilitate communication and task handling between SimpleOne instance and external systems.
In SimpleOne, communication among the instance and customer infrastructure (for example, LDAP servers or mail servers) is implemented using the "server-agent" technology.
Use the infrastructure agent when you need to integrate your SimpleOne instance with any other software. Main aims of this collaboration are:
These templates are the scripts that enable handling some specific tasks. |
The server and the agent have been developed as a very lightweight application and do not require any considerable system resources, such as CPU, RAM or hard disk space.
Software | HW Requirements (minimum) | SW Requirements |
---|---|---|
Agent |
|
|
The infrastructure server is configured on the SimpleOne instance as a dictionary record, implementing appropriate business logic on the server and client sides. |
To configure the interaction, complete the following steps:
As a result, the interaction is configured and starts. The agent sends requests to the server to get a job assignment. The request interval usually takes the couple of minutes.
The diagram below illustrates the process:
To add the server parameters into the appropriate table, complete the following steps:
MID Server form fields
Field | Mandatory | Description |
---|---|---|
Name | Y | Specify the infrastructure server name displayed on the list. |
Hostname | Y | Specify the hostname of the external server to which to connect. |
User | Y | Specify a system user with access to the infrastructure agent functionality. |
In the .env file, set the following configurations:
Field | Description |
---|---|
MID_API_USERNAME | The system username with granted access to the functionality of the infrastructure agent. |
MID_API_PASSWORD | The password of the specified user. |
MID_API_SERVERID | The server ID that is configured in the MID Server table. |
MID_API_ENDPOINT | Link to the SimpleOne instance. |
Example of the configuration file:
MID_API_USERNAME=admin
MID_API_PASSWORD=123456
MID_API_SERVERID=157237947616342741
MID_API_ENDPOINT=https://instance.example.com/rest
After you set up your infrastructure agent, configure the scripts for it.
MID Script form fields
Field | Mandatory | Description | ||||
---|---|---|---|---|---|---|
Name | Y | Specify the infrastructure server name displayed on the list. | ||||
Description | N | Add a brief description of the script. | ||||
Is Active | N | Select this checkbox to activate the script. | ||||
Script | Y | Specify a script that handles the necessary tasks and responsibilities associated with the corresponding activities.
|
To set up a job on the external infrastructure element, you need to create a record in the MID Queue (sys_mid_queue) table. For this, please complete the steps below.
MID Queue form fields
Field | Mandatory | Description |
---|---|---|
Request | N | Enter a request to an external server in JSON format. |
Response | N | The server response containing the output of the command (the stdout response) and other feedback. This field is populated automatically. |
Description | N | Add a brief description of the job. |
Server | Y | Specify a record that contains the information about the previously configured infrastructure server in the MID Server table. |
Script | Y | Specify a record that contains the infrastructure script that you configured earlier in the MID Script table. |
Status | Y | The job status. This field is populated automatically. Available options:
|
Processed at | N | The date and time when the request was processed. |