get_solr_status

This command returns the status of solr installation on the specified Guardium® system(s).

This command can return a few outputs (which can be translated on ApplicationResources.properties). If solr is not enabled:
  • If solr is not enabled: Solr is not enabled on this machine
  • If solr is enabled but not running: Solr is not running
  • If solr is enabled and running: Solr is running

This API is available in Guardium V10.6 and later.

GuardAPI syntax

get_solr_status parameter=value

Parameters

Parameter Value type Description
get_error_details Boolean If this parameter is set to true and solr is not running because of some exception, this exception is also written to console. Valid values:
  • 0 (false)
  • 1 (true)
Default = 0 (false)
api_target_host String

Specifies the target hosts where the API executes. Valid values:
  • all_managed: execute on all managed units but not the central manager
  • all: execute on all managed units and the central manager
  • group:<group name>: execute on all managed units identified by <group name>
  • host name or IP address of a managed unit: specified from the central manager to execute on a managed unit.  For example, api_target_host=10.0.1.123.
  • host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, api_target_host=10.0.1.123.

IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.

Examples

grdapi get_solr_status get_error_details=true