Collection Plug-In AVCLI Commands

Use the AVCLI collection plug-in commands to manage the deployment of collection plug-ins.

About the Collection Plug-In AVCLI Commands

Use the AVCLI collection plug-in commands to work with plug-ins, such as downloading and listing plug-ins.

DEPLOY PLUGIN

Use the DEPLOY PLUGIN command to deploy plug-ins into Oracle Audit Vault Server homes from a given archive file.

The DEPLOY PLUGIN command deploys a plug-in into the Audit Vault Server home from a given archive file.

Syntax

DEPLOY PLUGIN <plugin archive>

Arguments

Argument Description

Argument	Description
plugin archive	The plug-in archive. Archive files have an `.zip` extension, specifying custom plug-ins that third-party vendors or partners develop to add functionality to Audit Vault Server.

plugin archive

The plug-in archive.

Archive files have an .zip extension, specifying custom plug-ins that third-party vendors or partners develop to add functionality to Audit Vault Server.

Usage Notes

No action is required after this command.

The DEPLOY PLUGIN command updates the agent archive with the contents of this plug-in for future Agent deployments.

When a newer version of the plug-in is available, use the DEPLOY PLUGIN command to update the plug-in artifacts. Multiple plug-ins can support a single target type.

Example

avcli> DEPLOY PLUGIN /opt/avplugins/sample_plugin.zip;

Deploys the plug-in at /opt/avplugins/sample_plugin.zip into the Audit Vault Server and updates the agent archive by adding the plug-in to its contents.

LIST PLUGIN FOR TARGET TYPE

Use the LIST PLUGIN FOR TARGET TYPE command to list all of the plug-ins in Audit Vault Server installations.

The LIST PLUGIN FOR TARGET TYPE command lists all the plug-ins that support a particular target type.

Syntax

LIST PLUGIN FOR TARGET TYPE <target-type-name>

Arguments

Argument	Description
target type name	The name of the target type

Usage Notes

To find a list of available target types, see “LIST TARGET TYPE”.

Examples

avcli> LIST PLUGINS FOR TARGET TYPE "Oracle Database";

The plug-ins that support the target type “Oracle Database” are listed.

UNDEPLOY PLUGIN

Use the UNDEPLOY PLUGIN command to undeploy plug-ins from Oracle Audit Vault Server homes.

The UNDEPLOY PLUGIN command deletes a plug-in from an Audit Vault Server home.

Syntax

UNDEPLOY PLUGIN <plugin_id>

Arguments

Argument	Description
plugin_id	The `ID` of the plug-in that you want to undeploy.

Usage Notes

UNDEPLOY PLUGIN attempts to identify dependent plug-ins or packages prior to deleting the plug-in.

This command undeploys a plug-in specified by the plug-in ID from the Audit Vault Server. It also updates the agent archive removing this plug-in, so that it is not deployed in future agent deployments.

Examples

avcli> UNDEPLOY PLUGIN <com.abc.sample_plugin>;

The plug-in, com.abc.sample_plugin, is undeployed from Oracle Audit Vault Server and the agent archive is updated by removing the plug-in.