To enable the RMM agent, the configuration file of each agent must also be modified. It should be noted that it works for both GNU/Linux® and MS Windows® agents. The value of the ''rmm_enabled'' line must be changed to ''1''. Other parameters:
+
To enable the RMM agent, the configuration file of each agent must also be modified. It should be noted that it works for both Linux® and MS Windows® agents. The value of the ''rmm_enabled'' line must be changed to ''1''. Other parameters:
-
RMM エージェントを有効にするには、各エージェントの設定ファイルも変更する必要があります。これは GNU/Linux® エージェントと MS Windows® エージェントの両方で機能することに注意してください。''rmm_enabled'' 行の値を ''1'' に変更する必要があります。その他のパラメータ:
+
RMM エージェントを有効にするには、各エージェントの設定ファイルも変更する必要があります。これは Linux® エージェントと MS Windows® エージェントの両方で機能することに注意してください。''rmm_enabled'' 行の値を ''1'' に変更する必要があります。その他のパラメータ:
''rmm_interval'': It determines how often the RMM agent checks whether there are queued executions for itself and runs them. By default it is set to 30 seconds. It also indicates how often it will send ''.keepalive'' files to report its connection status.
''rmm_interval'': It determines how often the RMM agent checks whether there are queued executions for itself and runs them. By default it is set to 30 seconds. It also indicates how often it will send ''.keepalive'' files to report its connection status.
''rmm_temp'': It specifies the local directory for temporary files related to RMM executions. By default it will indicate ''/tmp'' on GNU/Linux® agents and ''C:\Program Files\pandora_agent\temp'' for MS/Windows® agents.
+
''rmm_temp'': It specifies the local directory for temporary files related to RMM executions. By default it will indicate ''/tmp'' on Linux® agents and ''C:\Program Files\pandora_agent\temp'' for MS/Windows® agents.
''rmm_extra_opts'': This parameter indicates the additional options to connect to the ''tentacle_rmm'' service, among others, it includes the password or key needed to establish the connection through **Tentacle** for RMM executions. It is configured by default, if necessary it can be found in the ''/etc/tentacle/tentacle_rmm.conf'' file of the server, in the ''password'' parameter.
''rmm_extra_opts'': This parameter indicates the additional options to connect to the ''tentacle_rmm'' service, among others, it includes the password or key needed to establish the connection through **Tentacle** for RMM executions. It is configured by default, if necessary it can be found in the ''/etc/tentacle/tentacle_rmm.conf'' file of the server, in the ''password'' parameter.
''rmm_debug'': It indicates the local file where the log or debug entries will be stored, in case this mode is enabled. In GNU/Linux® agents it is ''/var/log/pandora/pandora_rmm.debug'' and in MS/Windows® agents it is ''C:\Program Files\pandora_agent\pandora_rmm.debug'' by default.
+
''rmm_debug'': It indicates the local file where the log or debug entries will be stored, in case this mode is enabled. In Linux® agents it is ''/var/log/pandora/pandora_rmm.debug'' and in MS/Windows® agents it is ''C:\Program Files\pandora_agent\pandora_rmm.debug'' by default.
Once the changes have been saved, you may wait for the next agent interval or [[:en:documentation:pandorafms:installation:05_configuration_agents#ks5|restart it manually]]. Once the changes take effect, the ''pandora_rmm_agent'' process can be seen in the device:
Once the changes have been saved, you may wait for the next agent interval or [[:en:documentation:pandorafms:installation:05_configuration_agents#ks5|restart it manually]]. Once the changes take effect, the ''pandora_rmm_agent'' process can be seen in the device:
行 135:
行 135:
<wrap #ks3_1 />
<wrap #ks3_1 />
-
==== .data files ====
+
==== .data ファイル ====
The ''.data''' files will be sent to the server only when script executions have been carried out in the previous time interval, where they will include, as well as in the ''.keepalive''' files, the agent name (''agent_name''), the contact date, the RMM agent time interval, and the difference is the presence of data about the execution carried out. The execution ID, the step where the execution ended, the status in numerical format, the output message (''STDOUT'') and the error message (''STDERR'') will be indicated:
The ''.data''' files will be sent to the server only when script executions have been carried out in the previous time interval, where they will include, as well as in the ''.keepalive''' files, the agent name (''agent_name''), the contact date, the RMM agent time interval, and the difference is the presence of data about the execution carried out. The execution ID, the step where the execution ended, the status in numerical format, the output message (''STDOUT'') and the error message (''STDERR'') will be indicated:
The ''.keepalive'' files are sent at all RMM agent intervals and will indicate to the server that the RMM agent is available/connected. The contents of these files include the agent name (''agent_name'') to facilitate linking to the corresponding agent previously registered in the console, a timestamp indicating the exact date the file was sent to work as a last contact date, and the time interval it follows:
The ''.keepalive'' files are sent at all RMM agent intervals and will indicate to the server that the RMM agent is available/connected. The contents of these files include the agent name (''agent_name'') to facilitate linking to the corresponding agent previously registered in the console, a timestamp indicating the exact date the file was sent to work as a last contact date, and the time interval it follows:
===== Views and settings from the Web Console =====
+
===== Webコンソールからの表示と設定 =====
At this point, communication between agent and RMM server should be working properly. It can be checked by accessing the RMM Agents list or <wrap :en>**Heatmap**</wrap> view in the <wrap :en>**Management → RMM**</wrap> section of the left side menu of the Web Console.
At this point, communication between agent and RMM server should be working properly. It can be checked by accessing the RMM Agents list or <wrap :en>**Heatmap**</wrap> view in the <wrap :en>**Management → RMM**</wrap> section of the left side menu of the Web Console.
In case the connection is successful between agents and **RMM server**, a different box will be shown for each RMM agent in the <wrap :en>**Heatmap**</wrap> view, represented with a color or color scheme and a legend to interpret the status of the RMM agent based on those colors.
In case the connection is successful between agents and **RMM server**, a different box will be shown for each RMM agent in the <wrap :en>**Heatmap**</wrap> view, represented with a color or color scheme and a legend to interpret the status of the RMM agent based on those colors.
From the <wrap :en>**Agent list**</wrap> view you will find the same color system for RMM agent statuses, besides having additional data such as the agent name, its IP address, its operating system and version and its description (if any).
From the <wrap :en>**Agent list**</wrap> view you will find the same color system for RMM agent statuses, besides having additional data such as the agent name, its IP address, its operating system and version and its description (if any).
In this view you may find all the scripts registered in the environment, as well as information about them and the possibility to create new scripts, edit existing ones or delete them.
+
In this view you may find all the scripts registered in the environment, as well as information about them and the possibility to create new scripts, edit or copy existing ones or delete them.
The form to create scripts is the same as to edit them. If you click on <wrap :en>**New script**</wrap> or on the name of one of the existing scripts, they will be opened for creation or editing.
The form to create scripts is the same as to edit them. If you click on <wrap :en>**New script**</wrap> or on the name of one of the existing scripts, they will be opened for creation or editing.
Each script can be given a name, a description, the operating system in which it will be used or will be supported by, as well as the version of that OS. //This part is only organizational, as it has no limitation when assigning executions to RMM agents.//
Each script can be given a name, a description, the operating system in which it will be used or will be supported by, as well as the version of that OS. //This part is only organizational, as it has no limitation when assigning executions to RMM agents.//
+
+
各スクリプトには、名前、説明、使用されるまたはサポートされるオペレーティングシステム、およびその OS のバージョンを指定できます。//この部分は組織的なもので、RMM エージェントに実行を割り当てる際には制限はありません。//
It is also necessary to indicate a group to which this script will belong, and next to it you will see an option called <wrap :en>**Notify before executing**</wrap>. If enabled, the agent will execute this script will report <wrap :en>**success**</wrap> status before the actual execution of the script. **This is useful in cases where** the RMM agent process would be stopped and it would be impossible to report correctly the execution data after the execution, for example when restarting the equipment. This correct status will be represented in the queue list, but in a different way than the correct status of a real finished execution, so that it can be easily identified. The status column will show a green box with white stripes or lines.
It is also necessary to indicate a group to which this script will belong, and next to it you will see an option called <wrap :en>**Notify before executing**</wrap>. If enabled, the agent will execute this script will report <wrap :en>**success**</wrap> status before the actual execution of the script. **This is useful in cases where** the RMM agent process would be stopped and it would be impossible to report correctly the execution data after the execution, for example when restarting the equipment. This correct status will be represented in the queue list, but in a different way than the correct status of a real finished execution, so that it can be easily identified. The status column will show a green box with white stripes or lines.
The following <wrap :en">**Inputs**</wrap> section will allow you to further customize the script when creating executions. By clicking on <wrap :en>**Add input**</wrap>, it will be possible to give a name, choose a type between <wrap :en>**string**</wrap> and <wrap :en>**resource**</wrap>, indicate a tip or help on this input, and the macro value that this input will have, which is automatically filled in.
The following <wrap :en">**Inputs**</wrap> section will allow you to further customize the script when creating executions. By clicking on <wrap :en>**Add input**</wrap>, it will be possible to give a name, choose a type between <wrap :en>**string**</wrap> and <wrap :en>**resource**</wrap>, indicate a tip or help on this input, and the macro value that this input will have, which is automatically filled in.
The difference between <wrap :en>**string**</wrap> and <wrap :en>**resource**</wrap> types is that with an input of type string, when creating an execution, the value of this input can be indicated by hand and, as its name indicates, it would be a text or character string.
The difference between <wrap :en>**string**</wrap> and <wrap :en>**resource**</wrap> types is that with an input of type string, when creating an execution, the value of this input can be indicated by hand and, as its name indicates, it would be a text or character string.
If a script that restarts a service makes use of string inputs, this script may be used for multiple services, just by indicating a different service for each execution. With resource inputs, it will be possible to choose the resource to be used by the script in each execution. To do this, you need to upload the resources beforehand, as we will see later on.
If a script that restarts a service makes use of string inputs, this script may be used for multiple services, just by indicating a different service for each execution. With resource inputs, it will be possible to choose the resource to be used by the script in each execution. To do this, you need to upload the resources beforehand, as we will see later on.
Out of these three types, only script configuration, located in the middle, is required:
Out of these three types, only script configuration, located in the middle, is required:
+
+
これら 3 つのタイプのうち、中央にあるスクリプト設定のみが必須です。
{{ :wiki:pandora_rmm-image_100.png }}
{{ :wiki:pandora_rmm-image_100.png }}
The configuration structure is the same for all three types. You may indicate which parameters each script will use in the <wrap :en>**Parameters**</wrap> field by indicating the macro name seen in the <wrap :en>**Inputs**</wrap> section. In the <wrap :en>**Interpreter**</wrap> section indicate which command interpreter will be used to run the script. You may use some such as Bash, Python, Perl… always taking into account that they must be installed and available in the agent environment.
The configuration structure is the same for all three types. You may indicate which parameters each script will use in the <wrap :en>**Parameters**</wrap> field by indicating the macro name seen in the <wrap :en>**Inputs**</wrap> section. In the <wrap :en>**Interpreter**</wrap> section indicate which command interpreter will be used to run the script. You may use some such as Bash, Python, Perl… always taking into account that they must be installed and available in the agent environment.
In <wrap :en>**File extension**</wrap>, the extension of the script file will be indicated and finally the <wrap :en>**Code**</wrap> section, where the script code itself will be entered. The file extension is especially important in MS Windows® systems, since in case of not indicating the appropriate one, the scripts would not be executed correctly.
In <wrap :en>**File extension**</wrap>, the extension of the script file will be indicated and finally the <wrap :en>**Code**</wrap> section, where the script code itself will be entered. The file extension is especially important in MS Windows® systems, since in case of not indicating the appropriate one, the scripts would not be executed correctly.
+
+
<wrap :ja>**ファイル拡張子(File extension)**</wrap> にはスクリプトファイルの拡張子が示され、最後に <wrap :ja>**コード(Code)**</wrap> セクションにスクリプトコード自体が入力されます。ファイル拡張子は MS Windows® システムでは特に重要です。適切な拡張子を指定しないと、スクリプトが正しく実行されないためです。
Once the script is configured, just click on <wrap :en>**Update configuration**</wrap> to update it if was edited or <wrap :en>**Save configuration**</wrap> if a new one was created.
Once the script is configured, just click on <wrap :en>**Update configuration**</wrap> to update it if was edited or <wrap :en>**Save configuration**</wrap> if a new one was created.
This view contains the uploaded resources that may later be used in executions. By default, this view will not show anything, but rather your own resources should be added.
This view contains the uploaded resources that may later be used in executions. By default, this view will not show anything, but rather your own resources should be added.
The file must be selected from the explorer, clicking on <wrap :en>**Select a file**</wrap> and indicating a <wrap :en>**short name**</wrap> that will work as a unique identifier for the resource. When uploading a resource using a <wrap :en>**short name**</wrap> that already exists, you will be asked if you wish to update the previous resource.
The file must be selected from the explorer, clicking on <wrap :en>**Select a file**</wrap> and indicating a <wrap :en>**short name**</wrap> that will work as a unique identifier for the resource. When uploading a resource using a <wrap :en>**short name**</wrap> that already exists, you will be asked if you wish to update the previous resource.
These resources will be stored, as well as the ''keepalive'' and ''data'' folders, in the RMM directory indicated in the server configuration file under the name ''res''.
These resources will be stored, as well as the ''keepalive'' and ''data'' folders, in the RMM directory indicated in the server configuration file under the name ''res''.
In the Web Console, it will be displayed as follows:
In the Web Console, it will be displayed as follows:
+
+
Web コンソールでは次のように表示されます。
{{ :wiki:pandora_rmm-image_110.png }}
{{ :wiki:pandora_rmm-image_110.png }}
There is also the option of deleting these resources individually or in bulk. These resources may be used as inputs in the [[#ks4_3|scripts]] if the input type is set to <wrap :en>**Resource**</wrap>.
There is also the option of deleting these resources individually or in bulk. These resources may be used as inputs in the [[#ks4_3|scripts]] if the input type is set to <wrap :en>**Resource**</wrap>.
To be able to see the <wrap :en>**Queues**</wrap> and <wrap :en>**Schedules**</wrap> views in a correct way, it is necessary to add executions in some agent, otherwise no content will be displayed.
To be able to see the <wrap :en>**Queues**</wrap> and <wrap :en>**Schedules**</wrap> views in a correct way, it is necessary to add executions in some agent, otherwise no content will be displayed.
To do this, from <wrap :en>**Agent list**</wrap> or <wrap :en>**Heatmap**</wrap> you may access the <wrap :en>**Agent details**</wrap> view of the chosen agent by clicking on its name. Default view without any execution created:
To do this, from <wrap :en>**Agent list**</wrap> or <wrap :en>**Heatmap**</wrap> you may access the <wrap :en>**Agent details**</wrap> view of the chosen agent by clicking on its name. Default view without any execution created:
Here you may use the first drop-down list to filter according to your operating system (organizational data). Then, with the <wrap :en>**Scripts**</wrap> drop down list you may choose which script will be used by the execution you are creating.
Here you may use the first drop-down list to filter according to your operating system (organizational data). Then, with the <wrap :en>**Scripts**</wrap> drop down list you may choose which script will be used by the execution you are creating.
Afterwards, the name of the execution and its type of programming may be indicated:
Afterwards, the name of the execution and its type of programming may be indicated:
+
+
その後、実行の名前とプログラミングの種類が示される場合があります。
* <wrap :en>**Only once**</wrap>: It will add the execution right away to the queue, so it will be executed immediately after its creation and as soon as the RMM agent reads the execution in the server. They will be visible in the <wrap :en>**Queues**</wrap> view.
* <wrap :en>**Only once**</wrap>: It will add the execution right away to the queue, so it will be executed immediately after its creation and as soon as the RMM agent reads the execution in the server. They will be visible in the <wrap :en>**Queues**</wrap> view.
* <wrap :en>**Schedule**</wrap>: It will show drop-downs to select, in **cron** format, when the execution will take place. Until the indicated time elapses, this type of executions will not appear in the <wrap :en>**Queues**</wrap> view but will always be visible and editable from the <wrap :en>**Schedules**</wrap> view.
* <wrap :en>**Schedule**</wrap>: It will show drop-downs to select, in **cron** format, when the execution will take place. Until the indicated time elapses, this type of executions will not appear in the <wrap :en>**Queues**</wrap> view but will always be visible and editable from the <wrap :en>**Schedules**</wrap> view.
Depending on the chosen script, its inputs, if any, will appear. <wrap :en>**S****tring**</wrap> ones will let you fill in the text as needed, and resource ones will offer the list of RMM resources uploaded to the environment.
Depending on the chosen script, its inputs, if any, will appear. <wrap :en>**S****tring**</wrap> ones will let you fill in the text as needed, and resource ones will offer the list of RMM resources uploaded to the environment.
After finishing the configuration for execution, click <wrap :en>**Confirm**</wrap> to save. It will be listed in the <wrap :en>**Agent details**</wrap> view:
After finishing the configuration for execution, click <wrap :en>**Confirm**</wrap> to save. It will be listed in the <wrap :en>**Agent details**</wrap> view:
The executions will be automatically grouped by task name and script, so that if there are executions at different times that share name and script, their execution histories will be merged and will be visible by clicking on the <wrap :en>**Execution history**</wrap> button that appears in the <wrap :en>**Actions**</wrap> column of the table.
The executions will be automatically grouped by task name and script, so that if there are executions at different times that share name and script, their execution histories will be merged and will be visible by clicking on the <wrap :en>**Execution history**</wrap> button that appears in the <wrap :en>**Actions**</wrap> column of the table.
As for the scheduled runs, they will appear in the lower table and their consecutive runs will only appear when the time indicated in the <wrap :en>**Cron**</wrap> section goes by.
As for the scheduled runs, they will appear in the lower table and their consecutive runs will only appear when the time indicated in the <wrap :en>**Cron**</wrap> section goes by.
In this view you may find all the consecutive runs in the environment together with a series of data that will help to identify them.
In this view you may find all the consecutive runs in the environment together with a series of data that will help to identify them.
+
+
この画面では、環境内でのすべての連続実行と、それらを識別するのに役立つ一連のデータが表示されます。
{{ :wiki:pandora_rmm-image_190.png }}
{{ :wiki:pandora_rmm-image_190.png }}
A number of filters will help to limit the data displayed, such as <wrap :en>**Free search**</wrap> (will search in the columns <wrap :en>**Task name, agent, script, step, output, error**</wrap>) and filters by <wrap :en>**scripts, status, last queue, step**</wrap>.
A number of filters will help to limit the data displayed, such as <wrap :en>**Free search**</wrap> (will search in the columns <wrap :en>**Task name, agent, script, step, output, error**</wrap>) and filters by <wrap :en>**scripts, status, last queue, step**</wrap>.
In addition, there are actions in the table to open the execution detail or to delete it from the queue. **If it was not executed yet, this will prevent its future execution ** If it was executed, it will just be deleted both from the list of RMM agent executions and from the queue view.
In addition, there are actions in the table to open the execution detail or to delete it from the queue. **If it was not executed yet, this will prevent its future execution ** If it was executed, it will just be deleted both from the list of RMM agent executions and from the queue view.