export_certificate

Use this command to distribute a certificate from a central manager to some or all of its associated managed units.

This API is available in Guardium v11.3 and later.

Note: This command restarts the GUI.

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/export_certificate

GuardAPI syntax

export_certificate parameter=value

Parameters

Parameter Value type Description
alias String Required.
check_mu Boolean Valid values:
  • 0 (false)
  • 1 (true)
  • false
  • true

Default = 0 (false)

file String  
force Boolean Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)

host String Required. The hostname, where host can be one of the following options:
  • all_managed: execute on all managed units but not the central manager
  • group:<group name>: execute on all managed units identified by <group name>
  • Hostname or IP address of a managed unit: specified from the central manager to execute on a managed unit. For example, 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.

restart_gui Boolean

Default = 1 (true)

Example

The following command exports the 'tomcat' certificate to managed units in the 'eastern-mus' managed unit group. Force is enabled to proceed to the next unit if one or more units failed to retrieve the certificate.
grdapi export_certificate alias=tomcat host=group:eastern-mus force=true