Skip to content

Added documentation for special control variables #3541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2025
Merged

Added documentation for special control variables #3541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions content/reference/components/_index.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ vars:
}
```

**See also:** [`default:control_common.bundlesequence`](/reference/special-variables/control_common/#defaultcontrol_commonbundlesequence)

**History:** The default to `{ "main" }` was introduced in version 3.7.0, so if
you expect your policies to be run by older version, you'll need an explicit
`bundlesequence`.
Expand Down Expand Up @@ -163,6 +165,8 @@ body common control
In this example, bwlimit is set to 10MBytes/sec = 80Mbit/s meaning that
CFEngine would only consume up to ~80% of any 100Mbit ethernet interface.

**See also:** [`default:control_common.bwlimit`](/reference/special-variables/control_common/#defaultcontrol_commonbwlimit)

### cache_system_functions

**Description:** Controls the caching of the results of system
Expand Down Expand Up @@ -295,6 +299,10 @@ This authorizes the bundlesequence to contain possibly
undefined bundles cause a fatal error in parsing, and a transition
to failsafe mode.

**See also:** [`default:control_common.ignore_missing_bundles`](/reference/special-variables/control_common/#defaultcontrol_commonignore_missing_bundles)

**History:** Added in CFEngine 3.0.0

### ignore_missing_inputs

**Description:** If any input files do not exist, ignore and continue
Expand All @@ -320,6 +328,10 @@ not found.
ignore_missing_inputs => "true";
```

**See also:** [`default:control_common.ignore_missing_inputs`](/reference/special-variables/control_common/#defaultcontrol_commonignore_missing_inputs)

**History:** Added in CFEngine 3.0.0

### inputs

**Description:** The `inputs` slist contains additional filenames to parse for promises.
Expand All @@ -345,7 +357,7 @@ inputs => {
}
```

**See also:** [`inputs`][file control#inputs] in `body file control`
**See also:** [`inputs`][file control#inputs] in `body file control`, [`default:control_common.inputs`](/reference/special-variables/control_common/#defaultcontrol_commoninputs)

**Notes:**

Expand All @@ -362,6 +374,8 @@ again with path `/x/./y/z.cf`, the duplicate file will be rejected
regardless of any path tricks or symbolic links. The contents are
hashed, so the same file can't be included twice.

**History:** Added in CFEngine 3.0.0

### lastseenexpireafter

**Description:** The value of `lastseenexpireafter` is the number of minutes
Expand All @@ -385,7 +399,9 @@ lastseenexpireafter => "72";
}
```

**See also:** [hostsseen()][hostsseen], [cf-hub][cf-hub]
**See also:** [hostsseen()][hostsseen], [cf-hub][cf-hub], [`default:control_common.lastseenexpireafter`](/reference/special-variables/control_common/#defaultcontrol_commonlastseenexpireafter)

**History:** Added in CFEngine 3.0.0

### output_prefix

Expand Down Expand Up @@ -460,7 +476,7 @@ body common control
using the [`body copy_from protocol_version`][files#protocol_version]
attribute. When undefined (the default) peers automatically negotiate the latest protocol version.

**See also:** [`body copy_from protocol_version`][files#protocol_version], `allowlegacyconnects`, [`allowtlsversion`][cf-serverd#allowtlsversion], [`allowciphers`][cf-serverd#allowciphers], [`tls_min_version`][Components#tls_min_version], [`tls_ciphers`][Components#tls_ciphers], [`encrypt`][files#encrypt], [`logencryptedtransfers`][cf-serverd#logencryptedtransfers], [`ifencrypted`][access#ifencrypted]
**See also:** [`body copy_from protocol_version`][files#protocol_version], `allowlegacyconnects`, [`allowtlsversion`][cf-serverd#allowtlsversion], [`allowciphers`][cf-serverd#allowciphers], [`tls_min_version`][Components#tls_min_version], [`tls_ciphers`][Components#tls_ciphers], [`encrypt`][files#encrypt], [`logencryptedtransfers`][cf-serverd#logencryptedtransfers], [`ifencrypted`][access#ifencrypted], [`default:control_common.protocol_version`](/reference/special-variables/control_common/#defaultcontrol_commonprotocol_version)

**History:**

Expand Down Expand Up @@ -597,6 +613,8 @@ body common control
}
```

**See also:** [`default:control_common.system_log_level`](/reference/special-variables/control_common/#defaultcontrol_commonsystem_log_level)

**History:**

- Introduced in 3.19.0, 3.18.1
Expand All @@ -619,7 +637,7 @@ body common control
}
```

**See also:** [`protocol_version`][Components#protocol_version], [`allowciphers`][cf-serverd#allowciphers], [`tls_min_version`][Components#tls_min_version], [`allowtlsversion`][cf-serverd#allowtlsversion], [`encrypt`][files#encrypt], [`logencryptedtransfers`][cf-serverd#logencryptedtransfers], [`ifencrypted`][access#ifencrypted]
**See also:** [`protocol_version`][Components#protocol_version], [`allowciphers`][cf-serverd#allowciphers], [`tls_min_version`][Components#tls_min_version], [`allowtlsversion`][cf-serverd#allowtlsversion], [`encrypt`][files#encrypt], [`logencryptedtransfers`][cf-serverd#logencryptedtransfers], [`ifencrypted`][access#ifencrypted], [`default:control_common.tls_ciphers`](/reference/special-variables/control_common/#defaultcontrol_commontls_ciphers)

**History:** Introduced in CFEngine 3.7.0

Expand All @@ -637,7 +655,7 @@ body common control
}
```

**See also:** [`protocol_version`][Components#protocol_version], [`allowciphers`][cf-serverd#allowciphers], [`tls_ciphers`][Components#tls_ciphers], [`allowtlsversion`][cf-serverd#allowtlsversion], [`encrypt`][files#encrypt], [`ifencrypted`][access#ifencrypted], [`logencryptedtransfers`][cf-serverd#logencryptedtransfers]
**See also:** [`protocol_version`][Components#protocol_version], [`allowciphers`][cf-serverd#allowciphers], [`tls_ciphers`][Components#tls_ciphers], [`allowtlsversion`][cf-serverd#allowtlsversion], [`encrypt`][files#encrypt], [`ifencrypted`][access#ifencrypted], [`logencryptedtransfers`][cf-serverd#logencryptedtransfers], [`default:control_common.tls_min_version`](/reference/special-variables/control_common/#defaultcontrol_commontls_min_version)

**History:** Introduced in CFEngine 3.7.0

Expand Down
Loading