Working with Plugins from the IdentityIQ Console

The IdentityIQ Console (iiq console) provides several commands for managing plugins, as well as for performing scripted installation of multiple plugins.

The iiq console includes these plugin commands:

Install a single plugin or multiple plugins. Either a path to the zip file of the plugin or a directory containing multiple plugin zip files can be specified. If a directory is specified, any zip file in that directory is installed.

Flags:

  • file — path to a plugin file

  • dir — the directory containing the plugin zip file to install

  • no-cache — the plugin should not be cached after install

Note: For versioning information, see Developing Plugins.

Upgrade to a newer version of a plugin. Upgrading a plugin to the same version or a previous version is not supported. While developing a plugin, this behavior can be disabled for easier testing. To do so, include a "-dev" suffix on the version, for example, 2.0-dev.

The version of a plugin can either be official or development.

Development versions end with the suffix '-dev,' for example, 2.0-dev, and bypass most version checks so that the plugin can be recompiled, upgraded and tested easily.

Official versions drop the '-dev' suffix and can only be installed over a development version or an earlier official version. The minimum upgradeable version must also be valid.

Valid upgrade paths:

  • 1.0 -> 2.0-dev

  • 2.0-dev -> 2.0-dev

  • 2.0-dev -> 2.0

  • 1.0 -> 2.0

Invalid upgrade paths:

  • 2.0 -> 2.0

  • 2.0 -> 1.0

Flags:

  • file — path to a plugin file

  • no-cache — the plugin should not be cached after the upgrade

Uninstall a plugin.

Flags:

  • id — plugin id

  • name — plugin name

Enable the plugin.

Flags:

  • id — plugin id

  • name — plugin name

  • no-cache — the plugin should not be cached after being enabled

Disable a plugin.

Flags:

  • id — plugin id

  • name — plugin name

Export a single or all installed plugins to their respective zip files and, optionally, a specified directory.

Flags:

  • id — plugin id

  • name — plugin name

  • * — export all installed plugins

  • dir — the directory in which to save the zip files. If the directory does not exist, the command will attempt to create one. If none is specified, the files are save to the current working directory.

The enabled status of a single plugin, all installed plugins or the system-wide enabled status of plugins.

Flags:

  • id — plugin id

  • name — plugin name

  • * — view the status of all plugins

  • no flag — system-wide status of plugins as defined in iiq.properties

A list of all installed plugins.

The list of the classes available (from a plugin or all plugins), and the intended use for each class.

Flags:

  • id — plugin id

  • name — plugin name

  • * — the list of all available classes from all plugins