Skip to content

Commit

Permalink
Merge pull request #2180 from nickanderson/CFE-3104/3.10
Browse files Browse the repository at this point in the history
CFE-3104: Improved hostrange() documentation (3.10)
  • Loading branch information
nickanderson committed Jul 15, 2019
2 parents f54a99a + b1ab369 commit 97d68af
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions reference/functions/hostrange.markdown
Expand Up @@ -7,29 +7,26 @@ tags: [reference, communication functions, functions, hostrange]

[%CFEngine_function_prototype(prefix, range)%]

**Description:** Returns whether the current host lies in the `range` of
enumerated hostnames specified with `prefix`.
**Description:** Returns whether the unqualified name of the current host lies
in the `range` of enumerated hostnames specified with `prefix`.

This is a pattern matching function for non-regular (enumerated)
expressions.
expressions. The `range` specification is in the format `A-B` (using a minus
character `-`) where `A` and `B` are decimal integers, optionally prefixed with
zeroes (e.g. `01`). The unqualified name of the current host used in this
function is the same as the contents of the [`sys.uqhost`][sys.uqhost]
variable. The function is using integer comparison on `range` and the last
numeric part of the unqualified host name and string comparison of `prefix`
(lowercase) with the part of the unqualified host name until the last numeric
part.

[%CFEngine_function_attributes(prefix, range)%]

**Example:**

```cf3
bundle agent example
{
classes:
[%CFEngine_include_example(hostrange.cf, #\+begin_src\s+cfengine3\s*, .*end_src)%]

"compute_nodes" expression => hostrange("cpu-","01-32");
**Example Output:**

reports:
compute_nodes::
"No computer is a cluster";
}
```
[%CFEngine_include_example(hostrange.cf, #\+begin_src\s+static_example_output\s*, .*end_src)%]

0 comments on commit 97d68af

Please sign in to comment.