plugin_add

This job adds a new plugin to a bucket.

Mandatory Parameters

Parameter Name Data Type Description
plugin_name string The name of the plugin.

Optional Parameters

Parameter Name Data Type Description
bucketfs_name string The name of the BucketFS service where the bucket is stored.
bucket_name string The name of the bucket that will store the plugin. If the bucket does not already exist, a new one will be created.
dir string The folder name and location where the plugin will be stored. The default folder name is plugins. If you created your own bucket, you must create your own folder in which to store the plugin.

Substitute Parameters

There are no substitute parameters.

Allowed Users

The following users are allowed to run this job:

  • root

Allowed Groups

The following groups are allowed to run this job:

  • root
  • exaadm

Examples

The following code snippets show how to use this job using both Python (via XML-RPC) and on the command-line using confd_client.

conn.job_exec('plugin_add', {'params': {'plugin_name': 'Plugin1', 'bucketfs_name': 'BucketFS1', 'bucket_name': 'Bucket1'}})
confd_client plugin_add plugin_name: Plugin1 bucketfs_name: BucketFS1 bucket_name: Bucket1