# Google Drive

# Introduction

**Ver**. 26-03-2024

This plugin is intended to monitor the space and the date of the last change of a Google Drive file.

**Tipo**: Plug-in server

# Compatibility matrix

<table border="1" id="bkmrk-sistemas-donde-se-ha-1" style="width: 94.4444%; height: 59.5938px;"><tbody><tr style="height: 29.7969px;"><td style="width: 56.6667%; height: 29.7969px;">**Systems where tested**</td><td style="width: 43.3333%; height: 29.7969px;">Rocky linux, Fedora 34</td></tr><tr style="height: 29.7969px;"><td style="width: 56.6667%; height: 29.7969px;">**Systems where it works**  </td><td style="width: 43.3333%; height: 29.7969px;">Any linux system</td></tr></tbody></table>

# Pre requisites

**Prerequisites**  
Google Drive API enabled  
JSON file with credentials

  
Enable Google Drive API:  
Go to the Google Developer Console.  
Create a new project or select an existing one.  
In the left pane, click "Library."  
Search for "Google Drive API" in the list of available APIs.  
Click "Google Drive API".  
Click "enable" to enable the API for your project.

  
**Create API credentials:**  
Set up the OAuth consent screen:

In the navigation menu, go to APIs &amp; Services &gt; OAuth consent screen.  
Configure the consent screen, making sure to add the necessary scope for Google Drive.  
Create credentials:

Go to APIs &amp; Services &gt; Credentials.  
Click on "Create Credentials" and select "OAuth 2.0 Client IDs".  
Set the application type ("Desktop app") and download the credentials JSON file.

  
**Generate token for the plugin:**  
Run the plugin manually with the mandatory parameters specified in section "parameters" (example in section "manual execution", in a GUI environment, to generate a token.json file.   
The browser will open and we will be asked to log in with a google account.  
The generated token.json should be located in the same directory where the PandoraFMS plugin is configured. Next to the creds.json.  
It is necessary to run in a GUI environment to authenticate for the first time and generate a token.

# Parameters

**Meraki connection parameters**

<table border="1" id="bkmrk---url-url-de-conexi%C3%B3" style="width: 71.8519%;"><colgroup><col style="width: 20.1377%;"></col><col style="width: 79.8623%;"></col></colgroup><tbody><tr><td>**--creds\_json**</td><td>json file with google credentials</td></tr><tr><td>**--creds\_base64**</td><td>Base 64 of json file with google credentials</td></tr><tr><td>**--port**</td><td>Port. Default : 8080</td></tr><tr><td>**--file\_name**</td><td>Name of the file, which is to be monitored and the date of its last change. Need be propietary or have edit privileges.</td></tr><tr><td>**--log\_file**</td><td>Log file path</td></tr></tbody></table>

**Pandora configuration parameters**

<table border="1" id="bkmrk---agent_name-nombre-"><colgroup><col></col><col></col></colgroup><tbody><tr><td>**--agent\_prefix**  
</td><td>Prefix for all agents created by the plugin  
</td></tr><tr><td>**--module\_prefix**</td><td>Prefix for all modules created by the plugin</td></tr><tr><td>**--interval**</td><td>Agent monitoring interval</td></tr><tr><td>**--temporal**</td><td>PandoraFMS temporary directory</td></tr><tr><td>**--data\_dir**  
</td><td>PandoraFMS Data Directory</td></tr><tr><td>**--transfer\_mode**  
</td><td>Data transfer mode, local or tentacle</td></tr><tr><td>**--tentacle\_client**  
</td><td>Tentacle client path, by default "tentacle\_client".</td></tr><tr><td>**--tentacle\_opts**  
</td><td>Additional tentacle options  
</td></tr><tr><td>**--tentacle\_port**  
</td><td>Tentacle Port  
</td></tr><tr><td>**--tentacle\_address**  
</td><td>Tentacle IP</td></tr></tbody></table>

# Manual execution

The plugin execution format is as follows :

```
./pandora_googledrive --creds_json/creds_base64 <file credentials> \
[--file_name <file_name>] \
[--module_prefix <module_prefix>] \
[--agent_prefix <agent_prefix>] \
[--group <group>] \
[--interval <interval>] \
[--temporal <temporal>] \
[--data_dir <data_dir>] \
[--transfer_mode <transfer_mode>] \
[--tentacle_client <tentacle_client>] \
[--tentacle_opts <tentacle_opts>] \
[--tentacle_port <tentacle_port>] \
[--tentacle_address <tentacle_address>] \
[--log_file <log_file>]
```

Example:

```
./pandora_google_drive --creds_json "creds.json" --tentacle_address 174.42.42.123 --file_name "sistema_de_alertas.mp4"
```

# Configuration in PandoraFMS

To configure the plugin in PandoraFMS, the following steps must be followed :

**1. Upload the plugin to PandoraFMS, for example in the following path:**

```
/usr/share/pandora_server/util/plugin
```

**2. Go to the plugins section and create a new one:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/Ywyimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/Ywyimage.png)

 **3. Name, description and timeout are added:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/dhLimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/dhLimage.png)

**4. The path of the plugin is added to the command and the necessary parameters for its execution.**

<p class="callout info">For each parameter a macro must be configured, the syntax of this macro being the following : \_fieldx\_, where x is the positional number of the parameter.</p>

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/5pximage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/5pximage.png)

**5. The previous macros are configured, adding the value of the parameter in each one:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/BHwimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/BHwimage.png)

**6. Once configured, we should create a module in an agent that executes the plugin. In the modules menu of an agent we create a new plugin type module:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/ykpimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/ykpimage.png)

**7. In the module configuration menu, give it a name, select the plugin configured before and click on "create".**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/K7wimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/K7wimage.png)

**8. The agent will be created with the modules or the modules in the selected agent in the next execution of the plugin:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/qnbimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/qnbimage.png)

# Agent and modules generated by the plugin

The plugin will create an agent named &lt;Prefix&gt;Google Drive, with the following modules:

<table border="1" id="bkmrk-%3C-prefijo-%3E-%3C-google" style="width: 48.5185%;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr><td>&lt; Prefix &gt; &lt; Google Drive Used &gt;</td></tr><tr><td>&lt; Prefix &gt; &lt; File name &gt;</td></tr></tbody></table>