Plugin Parameters

Parameters let scenario architects customize your plugin without editing YAML. You define them in the UI, and they’re injected into your Ansible code at build time.

Step 1: Open the Parameters Tab

In the plugin editor, switch to the Parameters tab. This is where you define all configurable inputs for your plugin.

Step 2: Add a Parameter

Click Add Parameter and fill in:

• Field Name — the variable name used in your YAML (no spaces allowed). This is what you’ll reference as {{ FieldName }}
• Description — help text shown to the scenario architect when configuring your plugin
• Type — how the input is rendered in the UI (see types below)

Step 3: Configure Options

For each parameter, set:

• Required — the build won’t proceed unless this parameter has a value
• Advanced Setting — hides the parameter behind an “Advanced” toggle so it doesn’t clutter the basic configuration

Step 4: Use in YAML

Reference any parameter in your Ansible code with {{ FieldName }}:

- name: Create new AD forest domain
  ansible.windows.win_domain:
    dns_domain_name: "{{ DomainNameFQDN }}"
    safe_mode_password: "Password1!"

The system injects the scenario architect’s values at build time.

Parameter Types

Type	UI Input	Use Case
String	Single-line text field	Hostnames, IPs, domain names
Number	Numeric input	Port numbers, counts
Boolean	Toggle switch	Enable/disable features
String Block	Multi-line text area	Scripts, config file contents
CSV	Tabular grid with columns	Bulk user/group/OU creation — see CSV Parameters

Previewing Rendered Output

Use the Preview tab in the plugin editor to test your parameters:

1. Enter sample values for each parameter
2. Click Preview Draft
3. See the fully rendered YAML with values injected

This catches injection issues before you ever launch a build — misspelled parameter names, missing defaults, and formatting problems.