The infrastructure agent is an PHP application that can be run as a Windows service intended for facilitating communication and task handling between SimpleOne instance and external systems.
Concepts
In SimpleOne, communication among the instance and customer infrastructure (for example, LDAP servers or mail servers) is implemented using the "server-agent" technology.
It is used for collaboration when integration with customer software is needed. Main aims of this collaboration are:
- Information synchronization on SimpleOne instance with predefined templates.
- Information synchronization on customer instances with predefined templates.
| Tip |
|---|
Technically, these templates are PowerShell scripts implementing some tasks to handle. |
System Requirements
Either server or agent have been developed as a very lightweight applications and do not require many system resources, such as CPU, RAM or hard disk space.
Software requirements
| Software | HW Requirements (minimum) | SW Requirements |
|---|
| Agent | - CPU: 1.4 GHz 64-bit processor.
- RAM: 512 MB
- HDD: 32 GB
- Internet connection: 10/100/1000 Mbit/sec
| Info |
|---|
Agent system requirements are limited to OS system requirements. |
| - Microsoft Windows server (2012r2 or higher)
- PHP interpreter (version 7.2 or higher)
- cURL library
|
| Tip |
|---|
Infrastructure server is configured on SimpleOne instance as a dictionary record implementing appropriate business server and client logic. |
Interaction procedure
Interaction configuring, if simplified, can be represented as described below:
- Install infrastructure agent on Microsoft Windows server in a customer infrastructure
- Configure infrastructure server on SimpleOne instance.
- Configure tasks for infrastructure agent.
- After that, the interaction begins.
- Agent sends requests to server to get a job assignment. Request interval can be configured via Windows Task Scheduler (generally, it is 1 minute).
- If there are no tasks to run, the agent performs further attempts within the intervals configured.
- If there are any tasks to run, the agent starts executing them in turn.
- Whether tasks were completed successfully or not, the agent will connect to server to report execution.
| Note |
|---|
Please note that you need to allow "agent→server" connections in your firewall rules |
You can find graphical principles of this process on the diagram below:
| Anchor |
|---|
| Infrastructure server |
|---|
| Infrastructure server |
|---|
|
Setting up infrastructure server
Please complete the steps below to add the server parameters into the appropriate table:
- Navigate to MID servers → MID server.
- Click New and fill in the form.
- Click Save or Save and Exit to apply changes.
MID Server form fields
| Field | Description |
|---|
| Name | The infrastructure server name displayed on the list. |
| Hostname | The hostname of the external server to which to connect. |
| Last connect | The date and time of the latest connect. This field is populated automatically and always read-only. |
| User | The system user name with access to the infrastructure agent functionality. |
| Tip |
|---|
Infrastructure agent contains two .bat files: - one for adding the infrastructure agent starting up into the external server schedule;
- and one for removing it from the scheduler.
This functionality allows monitoring task processing with at a given interval. |
Configuring infrastructure agent
To configure your infrastructure agent, you need to find the .env configuration file in the \bin directory where the infrastructure agent was installed. Copy your *.env.example file into the *.env one and modify it in appropriate with your instance settings.
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
Infrastructure Server configuration file description
| Field | Description |
|---|
| MID_API_USERNAME | The system user name with granted access to the infrastructure agent functionality. |
| MID_API_PASSWORD | The password of the appropriate user. |
| MID_API_SERVERID | The ID of the server configured earlier in the MID Server table. |
| MID_API_ENDPOINT | Link to the SimpleOne instance. |
Adding scripts
After you set up your infrastructure agent, you need to configure the PowerShell scripts for it.
| Note |
|---|
Learning how to develop PowerShell scripts is out of scope of this article; please refer to PowerShell product documentation. |
- Navigate to MID Servers → MID script.
- Click New and fill in the form.
- Click Save or Save and Exit to apply changes.
Script form fields
| Field | Description |
|---|
| Name | The infrastructure server name displayed on the list. |
| Description | Brief script description. |
| Is active | Select this checkbox to make the script active or inactive. |
| Script | Type your script here, handling necessary tasks and duties related to the corresponding activities. | Tip |
|---|
In these scripts, you can use variables facilitating data exchange within customer infrastructure and SimpleOne instance bundle. As an example, you can make such a definition in your script: | Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | MID Script |
|---|
| $title='Title:\\n';Write-Host($title);Write-Host($param1); |
So the |
|
values defined with these variables value for variable title will be transferred |
|
to queuejs | theme | Eclipse| linenumbers | true |
|---|
"request": "{\"param1\":\\",
"response": "Title:\n\And response in related MID Queue will be: | Code Block |
|---|
| language | text |
|---|
| title | MID Queue Response |
|---|
| Title:
"String value |
|
|
\",Setting up a task
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.
- Navigate to MID Servers → MID Queue.
- Click New and fill in the form.
- Click Save or Save and Exit to apply changes.
MID Queue form fields
| Field | Description |
|---|
| Status | The job status. This field is populated automatically, Available options: - Created - the job was just created but not yet processed;
- Processing - the job is processing now, and no error code was returned;
- Done - the job was completed successfully, and the error code 0 was returned;
- Error - the job was completed with errors, and any other error code was returned.
| Tip |
|---|
- If there is more than one job in the queue, then they will be executed sequentially, one by one, from old to new.
- If an external server is not responding for a minute, then the script will be terminated by timeout. Note: in this case, the corresponding task will not return the error code.
- You can run a job manually if necessary, For this, run the command:
| Code Block |
|---|
php.exe bin\agent mid:run-job |
Where run:job is a job name you need to execute. Note: bin\agent is a pathway relatively infrastructure agent installation folder. In the case of you are in the another folder, please specify the full path; otherwise, the job may not be executed. |
|
| Request | Type the request to the external server in the JSON format. |
| Response | Server response containing command output (the stdout response) and other feedback. This field is populated automatically. |
| Description | A brief job description. |
| Processed at | The date and time when the request was processed. |
| Server | Reference to the record containing information about the infrastructure server configured earlier in the MID Server table. |
| Script | Reference to the record containing the infrastructure script that was set up earlier in the MID Script table. |