hostswithclass

Table of Contents

This function is only available in CFEngine Enterprise.

Prototype: hostswithclass(class, field)

Return type: slist

Description: Returns a list from the CFEngine Database with the information field of hosts on which classs is set.

On CFEngine Enterprise, this function can be used to return a list of hostnames or ip-addresses of hosts that have a given class set. Note that this function only works locally on the hub, but allows the hub to construct custom configuration files for (classes of) hosts.

Arguments:

  • class: string, in the range: [a-zA-Z0-9_]+
  • field: one of
    • name
    • address

Example:

    bundle agent debian_hosts
    {
    vars:

      am_policy_hub::
        "host_list" slist => hostswithclass( "debian", "name" );

    files:
      am_policy_hub::
        "/tmp/master_config.cfg"
             edit_line => insert_lines("host=$(host_list)"),
                create => "true";
    }

History: Was introduced in 3.3.0, Nova 2.2.0 (2012)

See also: hubknowledge(), remotescalar(), remoteclassesmatching()