migrate_stap_config

This command configures and moves one or more S-TAPs to Guardium® Insights.

Before you can migrate the S-TAPs, you must push Guardium Insights certificate chain (either from the Guardium Data Protection GUI or by using the push_insights_trust API.

If the migrate_stap_config command is successful, the S-TAP® is removed from Guardium Data Protection.

Notes:
  • Guardium Insights 3.1 or later is required.
  • You can migrate only UNIX S-TAPs.

This API is available in Guardium v11.4 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/stap_config

GuardAPI syntax

migrate_stap_config parameter=value

Parameters

Parameter Value type Description
routeName String Required. The DNS hostname for the Guardium Insights deployment. The DNS hostname is the same as the URL for the UI (without the https:// prefix).
stapHost String Required. Specify the name of one or more S-TAP hosts (separated by a comma), or specify all_unix_active.For valid values, call migrate_stap_config from the command line with --help=true.
tenantId String Required. The Guardium Insights tenant ID, including the TNT_ prefix.
api_target_host String
Specifies the target hosts where the API executes. Valid values:
  • all_managed: Run on all managed units but not the central manager
  • group:<group name>: Run 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.
Note: 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.

Example

vm150.mycompany.com> grdapi migrate_stap_config stapHost=rh6u9x64t.mycompany.com api_target_host=sys-vm154.mycompany.com routeName=sys.tokyo-0a94651246c65639d6ebe7da606c1234-0000.ca-tor.containers.appdomain.cloud tenantId=TNT_DARBESKTVGTGYAMF7RABCD
ID=0
sys-vm154.isslab.usga.ibm.com
ID=0
Insights data sent to active synchronized S-TAP hosts:
rh6u9x64t.mycompany.com