VDBManagement

With the VDBManagement action, you can dynamically (without restarting the Distributed Action Handler) bring VDBs online or take them offline, when running in non-Mirror mode.

If a VDB is marked as offline, the Distributed Action Handler sends no requests (even polling requests) to it, until it is brought back online again.

You specify the action to perform by setting VDBAction. Depending on the value of VDBAction, you might need to set additional parameters:

NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the Admin standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

Example

http://localhost:9060/action=VDBManagement&VDBAction=PowerDown&VDBID=2,4

This action takes offline the VDBs with IDs 2 and 4.

Required Parameters

The following action parameters are required.

Parameter Description
VDBAction The action to take on the specified VDBs.

Depending on the value of VDBAction, you might need to set one or more of the following parameters.

Parameter Description
VDBID The IDs of the VDBs to perform the specified action on.
VDBName The names of the VDBs to perform the specified action on.
VDBMapsTo The database(s) to which the virtual database is mapped.
VDBType Type of virtual databases, identified by either Distributor or Combinator.

Optional Parameters

This action accepts the following optional parameters.

Parameter Description
VDBInternal Whether to make the virtual database internal.

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
EncryptResponse Encrypt the output.
FileName The file to write output to.
ForceTemplateRefresh Forces the server to load the template from disk.
Output Writes output to a file.
ResponseFormat The format of the action output.
Template The template to use for the action output.
TemplateParamCSVs A list of variables to use for the specified template.

Comments