---
title: influxdb3 test schedule_plugin
description: The influxdb3 test schedule_plugin command tests a schedule plugin file without needing to create a trigger.
url: https://docs.influxdata.com/influxdb3/enterprise/reference/cli/influxdb3/test/schedule_plugin/
estimated_tokens: 1234
product: InfluxDB 3 Enterprise
version: enterprise
publisher: InfluxData
canonical: https://docs.influxdata.com/influxdb3/enterprise/reference/cli/influxdb3/test/schedule_plugin/
date: '2026-07-11T10:53:18+00:00'
lastmod: '2026-07-11T10:53:18+00:00'
---

The `influxdb3 test schedule_plugin` command tests a schedule plugin. Use this command to verify plugin behavior without creating a trigger.

## Usage

```bash
influxdb3 test schedule_plugin [OPTIONS] --database <DATABASE_NAME> <FILENAME>
```

## Arguments

* **FILENAME**: Path to the plugin file. Use the absolute path or the path relative to the current working directory, such as `<plugin-dir>/<plugin-file-name>.py`.

## Options

|Option|       Flag        |                                                  Description                                                   |
|------|-------------------|----------------------------------------------------------------------------------------------------------------|
| `-H` |     `--host`      |            URL of the running InfluxDB 3 Enterprise server  <br/>(default: `http://127.0.0.1:8181`)            |
| `-d` |   `--database`    |                     *(Required)* Name of the database you want to test the plugin against                      |
|      |     `--token`     |                                       *(Required)* Authentication token                                        |
|      |`--input-arguments`|Comma-separated list of `key=value` pairs to pass as plugin input arguments (for example, `key1=val1,key2=val2`)|
|      |   `--schedule`    |                 Cron schedule to simulate when testing the plugin  <br/>(default: `* * * * *`)                 |
|      |  `--cache-name`   |                                 Optional cache name to associate with the test                                 |
|      |    `--tls-ca`     |                        Path to a custom TLS certificate authority for self-signed certs                        |
|      | `--tls-no-verify` | Disable TLS certificate verification (**Not recommended in production**, useful for self-signed certificates)  |
| `-h` |     `--help`      |                                          Show basic help information                                           |
|      |   `--help-all`    |                                        Show all available help options                                         |

### Option environment variables

You can use the following environment variables to set command options:

|  Environment Variable   |Corresponding Option|
|-------------------------|--------------------|
|  `INFLUXDB3_HOST_URL`   |      `--host`      |
|`INFLUXDB3_DATABASE_NAME`|    `--database`    |
| `INFLUXDB3_AUTH_TOKEN`  |     `--token`      |
|   `INFLUXDB3_TLS_CA`    |     `--tls-ca`     |
|`INFLUXDB3_TLS_NO_VERIFY`| `--tls-no-verify`  |

## Examples

In the examples below, replace the following:

* `DATABASE_NAME`: Your target database
* `AUTH_TOKEN`: Your authentication token
* `PLUGIN_DIR`:
  the path to the plugin directory you provided when starting the server
* `FILENAME`:
  Plugin file name

### Test a schedule plugin

```bash
influxdb3 test schedule_plugin \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  PLUGIN_DIR/FILENAME.py
```

### Test with input arguments and a custom cron schedule

You can pass input arguments to your plugin as key-value pairs and specify a custom cron schedule (using Quartz cron syntax with six fields):

```bash
influxdb3 test schedule_plugin \
  --host http://localhost:8182 \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  --input-arguments threshold=10,unit=seconds \
  --schedule "0 0 * * * ?" \
  PLUGIN_DIR/FILENAME.py
```

* Pass plugin parameters using `--input-arguments` as comma-separated key=value pairs.
* Use `--schedule` to set the plugin’s execution time with a Quartz cron expression. For example, “0 0 \* \* \* ?” runs the plugin at the start of every hour.
| Option | Flag | Description |
| --- | --- | --- |
| Option | Flag | Description |
| -H | --host | URL of the running InfluxDB 3 Enterprise server (default:  http://127.0.0.1:8181 ) |
| -d | --database | ( Required )  Name of the database you want to test the plugin against |
|  | --token | ( Required )  Authentication token |
|  | --input-arguments | Comma-separated list of  key=value  pairs to pass as plugin input arguments (for example,  key1=val1,key2=val2 ) |
|  | --schedule | Cron schedule to simulate when testing the plugin (default:  * * * * * ) |
|  | --cache-name | Optional cache name to associate with the test |
|  | --tls-ca | Path to a custom TLS certificate authority for self-signed certs |
|  | --tls-no-verify | Disable TLS certificate verification ( Not recommended in production , useful for self-signed certificates) |
| -h | --help | Show basic help information |
|  | --help-all | Show all available help options |

| Environment Variable | Corresponding Option |
| --- | --- |
| Environment Variable | Corresponding Option |
| INFLUXDB3_HOST_URL | --host |
| INFLUXDB3_DATABASE_NAME | --database |
| INFLUXDB3_AUTH_TOKEN | --token |
| INFLUXDB3_TLS_CA | --tls-ca |
| INFLUXDB3_TLS_NO_VERIFY | --tls-no-verify |