bRC queryParameter(bpContext *ctx, struct query_pkt *qp)

If this entry point is set, the user via bconsole can call the plugin to have information about parameters.

struct query_pkt {
   int32_t pkt_size;                  /* Size of this packet */
   char *parameter;
   char *command;
   char *api_opts;
   char *result;
   int32_t pkt_end;                   /* end packet sentinel */
};

The plugin command line is stored in command, the parameter in parameter, and the current API options in api_opts can be used directly in the OutputWriter object.

.query plugin="plugin: parameters" parameter="parameter"

See also

• newPlugin(bpContext *ctx)

• freePlugin(bpContext *ctx)

• getPluginValue(bpContext *ctx, pVariable var, void *value)

• setPluginValue(bpContext *ctx, pVariable var, void *value)

• handlePluginEvent(bpContext *ctx, bEvent *event, void *value)

• startBackupFile(bpContext *ctx, struct save_pkt *sp)

• endBackupFile(bpContext *ctx)

• startVerifyFile(bpContext *ctx, struct save_pkt *sp)

• startRestoreFile(bpContext *ctx, const char *cmd)

• createFile(bpContext *ctx, struct restore_pkt *rp)

• setFileAttributes(bpContext *ctx, struct restore_pkt *rp)

• endRestoreFile(bpContext *ctx)

• pluginIO(bpContext *ctx, struct io_pkt *io)

• bool checkFile(bpContext *ctx, char *fname)

Possible Next Steps

Go back to Plugin EntryPoints.

Go back to Bacula FD Plugin API.

Go back to Developer Guide.