delete_autodetect_scans_for_process

Use this command remove all the tasks for a process on the specified hostnames and ports. You cannot run this command on a process that is running or scheduled, or has results.

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

REST API syntax

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

GuardAPI syntax

delete_autodetect_scans_for_process parameter=value

Parameters

Parameter Value type Description
hostList String Lists of hosts. Space separated list of IPs or IP ranges and wild cards such as 192.168.0.1 192.168.1.*
portList String List of ports. Comma separated list of ports or port ranges such as 22,23,1400-1600.
process_name String Required. Name of the auto-discovery process
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

To delete the auto-discovery process myProcess from the hosts 192.168.1.1 and 192.168.1.3, on ports 22 and 23:

grdapi delete_autodetect_scans_for_process hostList="192.168.1.1 192.168.1.3" portList="22,23"