Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Create secure parameters for a check

When creating a check definition or check instance, you can configure the parameters you want to be secured when the agent executes the check. During check execution, the secured parameters are obfuscated, securing their information. Only credential information is obfuscated.

Before you begin

Role required: agent_client_collector_admin

Procedure

  1. Navigate to All > Agent Client Collector > Check Definitions.

  2. Select a check definition from the displayed list.

    The Check Definition page for the selected check appears.

  3. Scroll to the bottom of the page and select the Check Secure Parameter Definitions tab.

  4. Click New.

    The Check Secure Parameter Definition New Record page appears.

Image omitted: ACC-Check-Secure-Parameter.png
Check Secure Parameter Definition New Record page
  1. Configure the fields on the page.
Field NameDescription
NameThe name of the parameter, formatted as a reference prefix. For example, `cred_` is a reference prefix for the credentials table.
Check DefinitionThe name of the check definition connected to the parameter.
Order

A number indicating the order in which the parameter is sent to the check command/script. For example, if you configure the following parameters:- Name=cred_user_name, Order=1 - Name=cred_password, Order=2 The username parameter is sent first to the standard input, and the password parameter is sent second to the standard input.

The READ command is performed first on the username parameter and then on the password parameter. You can then use $username and $password in your Bash script.

ActiveSelect the check box to activate the secure parameter.
  1. Click Submit.

    The configured parameter appears in the table on the Check Secure Parameter Definitions tab.

    Repeat this procedure to enter multiple secure parameters.

  2. Enter the secure parameters into the Command prefix field of the check definition.