Skip to main content
show_system_properties(options=)[source]

Returns server configuration and version related information to the caller. The admin tool uses it to present server related information to the user.

Parameters

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • properties – A list of comma separated names of properties requested. If not specified, all properties will be returned.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

property_map (dict of str to str) –

A map of server configuration parameters and version information. Allowed keys are:

  • conf.enable_worker_http_servers – Boolean value indicating whether the system is configured for multi-head ingestion. Allowed values are:

    • TRUE – Indicates that the system is configured for multi-head ingestion.

    • FALSE – Indicates that the system is NOT configured for multi-head ingestion.

  • conf.worker_http_server_ips – Semicolon (‘;’) separated string of IP addresses of all the ingestion-enabled worker heads of the system.

  • conf.worker_http_server_ports – Semicolon (‘;’) separated string of the port numbers of all the ingestion-enabled worker ranks of the system.

  • conf.hm_http_port – The host manager port number (an integer value).

  • conf.enable_ha – Flag indicating whether high availability (HA) is set up (a boolean value).

  • conf.ha_ring_head_nodes – A comma-separated string of high availability (HA) ring node URLs. If HA is not set up, then an empty string.

info (dict of str to str) –

Additional information.