Plugin
Manage system plugins.
opal plugin <CREDENTIALS> [OPTIONS] [EXTRAS]
Options
Option |
Description |
---|---|
|
List the installed plugins. |
|
List the installed plugins that can be updated. |
|
List the new plugins that could be installed. |
|
Install a plugin by providing its name or name:version or a path to a plugin archive file (in Opal file system). If no version is specified, the latest version is installed. Requires system restart to be effective. |
|
Remove a plugin by providing its name. Requires system restart to be effective. |
|
Reinstate a plugin that was previously removed by providing its name. |
|
Get the named plugin description. |
|
Configure the plugin site properties. Usually requires to restart the associated service to be effective. |
|
Get the status of the service associated to the named plugin. |
|
Start the service associated to the named plugin. |
|
Stop the service associated to the named plugin. |
Credentials
Authentication can be done by username/password credentials OR by personal access token OR by certificate/private key pair (two-way SSL authentication).
Option |
Description |
---|---|
|
Opal server base url |
|
Credentials auth: user name (requires a password) |
|
Credentials auth: user password (requires a user name) |
|
Token auth: user’s personal access token |
|
Two-way SSL auth: certificate/public key file (requires a private key) |
|
Two-way SSL auth: private key file (requires a certificate) |
Extras
Option |
Description |
---|---|
|
Show the command help’s message. |
|
Verbose output. |
|
Output pretty-print JSON |
Example
List the plugins that are currently installed:
opal plugin -o https://opal-demo.obiba.org -u administrator -p password --list --json