---
sourceDocument: Brazil IT Operations Management
sourceDocumentLink: https://www.servicenow.com/docs/r/it-operations-management

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Create check parameters for a check

# Create check parameters for a check {#ariaid-title1}

Release version: Brazil  
Updated September 28, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read  
Create a check parameter to add a configurable input that customizes how
a
check runs, without changing the underlying script or command.

## Before you begin

Role required: agent_client_collector_admin

## About this task

A check parameter contains:

* Check Parameter Definition: defines each check type. It declares the parameter's name, meaning, default value, and the command-line flag it maps to.
* Check Parameter Value: specify the value of the defined parameter which is specific to a check instance.

{#create-check-parameters-for-a-check__ul_qpn_twp_skc}  
Note:  
The meaning and valid values of any parameter depend on the related check definition.

## Procedure

1. Navigate to AllAgent Client CollectorCheck 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 Parameter Definitions tab.
4. Select New.  
   The Check Parameter Definition New Record page appears.
5. Configure the fields on the page.

   | Field | Description |
   | Name | Name of the parameter, formatted as a reference prefix. |
   | Active | Activates the check parameter on selection. |
   | Default Value | Indicates that the parameter must contain a default value. |
   | Flag | A prefix that must be added before the parameter value in the command. For example `-p`. |
   | Check Definition | The name of the check definition connected to the parameter. |
   | Mandatory | Indicates that the parameter is mandatory. |
   | Value required | Indicates that a value must be provided for the parameter. |
   |-|-|

   {#create-check-parameters-for-a-check__choicetable_jz2_g32_1mb}  
   Note:  
   The Active, Flag, and Value required options are displayed only when the Command Auto Generation option is selected.
6. Select Submit.  
   The configured parameter appears in the table on the Check Parameter Definitions tab.

   Repeat this procedure to enter multiple check parameters.
7. Enter the check parameters in the Command field of the check definition.  
   Each check definition has a Command field containing a template. Parameter values are substituted into this template at execution time:

       check-kernel-parameter.rb {{if .labels.params_parameter_value}} -v {{.labels.params_parameter_value}} {{end}} {{if .labels.params_parameter_name}} -p {{.labels.params_parameter_name}} {{end}}

   * `.labels.params_<parameter_name>` refers to the value configured for that parameter.
   * `{{if ...}} ... {{end}}` adds the flag and value only when the parameter has a value. If the parameter is empty, its flag is omitted.
   * The flag prefix such as `-v`, `-p`, and so on is picked from the Flag field on the check parameter definition.

   {#create-check-parameters-for-a-check__ul_fxl_t15_skc}

   This command is assembled automatically from the configured parameter values.

   Example:

   The `os.linux.check-kernel-parameter` check defines two parameters:
   {#create-check-parameters-for-a-check__table_y5j_qb5_skc__entry__3}

   | Parameter name | Flag | Purpose |
   |-|-|-|
   | `parameter_name` | -p | The Linux kernel parameter to check. For example, `kernel.shmmni` |
   | `parameter_value` | -v | The expected value for that kernel parameter. |
   [Table 1. Example parameter values]

   {#create-check-parameters-for-a-check__table_y5j_qb5_skc}  
   When you configure `parameter_name` with the following settings:


       Name:           parameter_name
       Active:         true
       Mandatory:      true
       Flag:           -p
       Value required: true
       Value:          kernel.shmmni

   You also specify the `parameter_value` as 4096. The check runs as follows:

       check-kernel-parameter.rb -v 4096 -p kernel.shmmni

{#create-check-parameters-for-a-check__steps_kp4_nxp_skc}
**Related tasks**   

* [Create a check definition](https://www.servicenow.com/docs/cufP9V6D2gP7_XL2E_4W6A "Create a check definition to execute the osquery command on the Agent.")  
**Related reference**   

* [Agent Client Collector check definition page](https://www.servicenow.com/docs/1x7VfXSHadzyls0xKhQqPw "The fields to be configured on the Check Definition page, when creating a check definition.")

*[\>]: and then