Controller 25.2
Controller Reference

# GetStatusOverview

The `GetStatusOverview` action enables you to track the status of the Lua scripts that you are using to monitor your services.

## Example

    a=GetStatusOverview&Summarize=True

    a=GetStatusOverview&MaxResults=100&Port=9000&ScriptName=checkGetStatus.lua

For each service, `GetStatusOverview` returns:

- The port of the service.
- The name, types, and labels for the service, as specified with the AddService action.
- If the service is an ACI server, the product type of the service.
- The current state of the service (running, stopped, starting, stopping, or unknown)
- The status of the Lua scripts being used with that service, including the name, description, current and previous status, errors, warnings and other reports.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
MaxHistoryResults | The maximum number of non-current status records to include in the results.
MaxResults | The total number of results to return.
Port | The port number of the service for which you want to return status information.
ScriptName | The script name for which you want to return status information.
Summarize | Whether to return summary information only.

## Comments

You can send the `GetStatusOverview` action from Coordinator by specifying a comma-separated list of Controller UUIDs.

For example:

    a=GetStatusOverview&ControllerUUUIDS=d267cf80-063a-8030-a2de-24be0523821c,4e572f80-460c-8030-a2de-005056bd31f6

This action returns status information (including type, ID, start time, end time, and message) for the Controller servers with the specified UUIDs. For more information, refer to the Coordinator Reference.

## See Also

- RemoveStatusRecords

Copyright 2015-2025 Open Text
Version 25.2 | Last updated April 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Controller 25.2

Topic Title: GetStatusOverview