must_gather

This command collects information on the state of the Guardium system for use by Guardium Support.

For more information, see Basic information for IBM Support.

This API is available in Guardium V9.5 and later.

REST API syntax

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

GuardAPI syntax

must_gather parameter=value

Parameters

Parameter Value type Description
commandsList String Required. The information to gather. For valid values, call must_gather from the command line with --help=true.

For more information, see Running must gather from the CLI.
description String A description of the issue.
email String Email address for results.

If you specify an email, the logs are gathered for 10 minutes from the time you start the process and an email is sent afterward.
maxLogLength Integer Maximum number of rows to appear in the log.
pmrNumber String The PMR number for this issue.
runDuration Integer The length of time, in minutes, to gather information.

Default = 10 (minutes)
startRun Date Time to start the run.
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.

GuardAPI example

grdapi must_gather commandsList="alert_issues" description="Issues with real-time alerts"