list_managed_units

Run this command on a central manager or a managed unit to output the list all managed units that are managed by the central manager.

This API is available in Guardium v11.4 and later.

REST API syntax

This API is available as a REST service with the GET method. Call this API as follows:
GET https://[Guardium hostname or IP address]:8443/restAPI/managed_units

GuardAPI syntax

list_managed_units parameter=value

Parameters

Parameter Value type Description
unit_type String Specify to limit the out to units of the specified type only. Valid values:
  • Col
  • Collector
  • Agg
  • Aggregator
verbose Boolean Valid values:
  • 0 (false): Lists the host names of the systems.
  • 1 (true): Lists the host names, IPs, IP mode, versions, whether the system is online, and the central manager or aggregator that the collector reports to (if data is aggregated).

Default = 0 (false)

Examples

To output a list of collectors only:
grdapi list_managed_units unit_type=col verbose=1
Unit Host = server-1, IP=n.n.n.n, type=ManagedCollector,  IPMode-IPv4, version=11.4.0_r110686_trunk_1-el79-20210607_1543,online=true
Unit Host = server-2, IP=n.n.n.n, type=ManagedCollector,  IPMode-IPv4, version=11.4.0_r110686_trunk_1-el79-20210607_1543,online=true
ok
To output a list of all managed units:
grdapi list_managed_units  verbose=1        
Unit Host = server-1, IP=n.n.n.n, type=ManagedCollector,  IPMode-IPv4, version=11.4.0_r110686_trunk_1-el79-20210607_1543,online=true
Unit Host = server-2, IP=n.n.n.n, type=ManagedCollector,  IPMode-IPv4, version=11.4.0_r110686_trunk_1-el79-20210607_1543,online=true
Unit Host = server-3, IP=n.n.n.n, type=ManagedAggregator,  IPMode-IPv4, version=11.4.0_r110686_trunk_1-el79-20210607_1543,online=true
ok