virtualhostmanager

Description

Provides the namespace for the Virtual Host Manager methods.

Namespace:

virtualhostmanager

Method: create

Description:

Creates a Virtual Host Manager from given arguments

Parameters:

  • string sessionKey - Session token, issued at login

  • string label - Virtual Host Manager label

  • string moduleName - the name of the Gatherer module

  • parameters parameters - additional parameters (credentials, parameters for virtual-host-gatherer)

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: delete

Description:

Deletes a Virtual Host Manager with a given label

Parameters:

  • string sessionKey - Session token, issued at login

  • string label - Virtual Host Manager label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getDetail

Description:

Gets details of a Virtual Host Manager with a given label

Parameters:

  • string sessionKey - Session token, issued at login

  • string label - Virtual Host Manager label

Returns:

  • * struct - virtual host manager

    • string "label"

    • int "org_id"

    • string "gatherer_module"

    • struct "configs"

Method: getModuleParameters

Description:

Get a list of parameters for a virtual-host-gatherer module. It returns a map of parameters with their typical default values.

Parameters:

  • string sessionKey - Session token, issued at login

  • string moduleName - The name of the module

Returns:

  • map module_params - module parameters

Method: listAvailableVirtualHostGathererModules

Description:

List all available modules from virtual-host-gatherer

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • array :

    • string - moduleName

Method: listVirtualHostManagers

Description:

Lists Virtual Host Managers visible to a user

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • array :

  • struct - virtual host manager

    • string "label"

    • int "org_id"

    • string "gatherer_module"

    • struct "configs"