Skip to content

Commit 85d57b2

Browse files
authored
Merge pull request #3541 from nickanderson/special-control-variables/master
Added documentation for special control variables
2 parents 3643bfc + e9f130b commit 85d57b2

15 files changed

+968
-52
lines changed

content/reference/components/_index.markdown

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,8 @@ vars:
126126
}
127127
```
128128

129+
**See also:** [`default:control_common.bundlesequence`](/reference/special-variables/control_common/#defaultcontrol_commonbundlesequence)
130+
129131
**History:** The default to `{ "main" }` was introduced in version 3.7.0, so if
130132
you expect your policies to be run by older version, you'll need an explicit
131133
`bundlesequence`.
@@ -163,6 +165,8 @@ body common control
163165
In this example, bwlimit is set to 10MBytes/sec = 80Mbit/s meaning that
164166
CFEngine would only consume up to ~80% of any 100Mbit ethernet interface.
165167

168+
**See also:** [`default:control_common.bwlimit`](/reference/special-variables/control_common/#defaultcontrol_commonbwlimit)
169+
166170
### cache_system_functions
167171

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

302+
**See also:** [`default:control_common.ignore_missing_bundles`](/reference/special-variables/control_common/#defaultcontrol_commonignore_missing_bundles)
303+
304+
**History:** Added in CFEngine 3.0.0
305+
298306
### ignore_missing_inputs
299307

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

331+
**See also:** [`default:control_common.ignore_missing_inputs`](/reference/special-variables/control_common/#defaultcontrol_commonignore_missing_inputs)
332+
333+
**History:** Added in CFEngine 3.0.0
334+
323335
### inputs
324336

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

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

350362
**Notes:**
351363

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

377+
**History:** Added in CFEngine 3.0.0
378+
365379
### lastseenexpireafter
366380

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

388-
**See also:** [hostsseen()][hostsseen], [cf-hub][cf-hub]
402+
**See also:** [hostsseen()][hostsseen], [cf-hub][cf-hub], [`default:control_common.lastseenexpireafter`](/reference/special-variables/control_common/#defaultcontrol_commonlastseenexpireafter)
403+
404+
**History:** Added in CFEngine 3.0.0
389405

390406
### output_prefix
391407

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

463-
**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]
479+
**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)
464480

465481
**History:**
466482

@@ -597,6 +613,8 @@ body common control
597613
}
598614
```
599615

616+
**See also:** [`default:control_common.system_log_level`](/reference/special-variables/control_common/#defaultcontrol_commonsystem_log_level)
617+
600618
**History:**
601619

602620
- Introduced in 3.19.0, 3.18.1
@@ -619,7 +637,7 @@ body common control
619637
}
620638
```
621639

622-
**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]
640+
**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)
623641

624642
**History:** Introduced in CFEngine 3.7.0
625643

@@ -637,7 +655,7 @@ body common control
637655
}
638656
```
639657

640-
**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]
658+
**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)
641659

642660
**History:** Introduced in CFEngine 3.7.0
643661

0 commit comments

Comments
 (0)