create_autodetect_process

Use this command to create an auto-discovery process.

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

REST API syntax

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

GuardAPI syntax

create_autodetect_process parameter=value

Parameters

Parameter Value type Description
check_ICMP_echo Boolean Required. Whether or not Nmap sends an ICMP echo request. PE parameter to nmap. This is an nmap parameter. nmap options are configurable only by API (not by GUI). For details of nmap parameters and their impact on scan perfomance, see man nmap. Valid values:
  • 0 (false)
  • 1 (true)
Default = 0 (false)
host_timeout Integer Required. Timeout value, in seconds, for determining how long Guardium waits for a probe response before giving up or retransmitting the probe. This is an nmap parameter. nmap options are configurable only by API (not by GUI). For details of nmap parameters and their impact on scan perfomance, see man nmap.
process_name String Required. Name of the auto-discovery process
run_probe_after_scan Boolean Required. Determines whether or not to run a probe job immediately after the scan job completes. Valid values:
  • 0 (false)
  • 1 (true)
Default = 1 (true)
use_dns String Required. This is an nmap parameter. nmap options are configurable only by API (not by GUI). For details of nmap parameters and their impact on scan perfomance, see man nmap. Valid values:
  • true: always
  • false: never
  • n: never
  • R: always
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 create a process named myProcess in the Guardium system on which you enter the command:

grdapi create_autodetect_process process_name=myProcess check_ICMP_echo=false host_timeout=3 run_probe_after_scan=false use_dns=n