This is a list of filters to optionally filter the nodes on which your RunDeck will run.
You can specify which node to include and/or to exclude using a single value, a list of values,
or a regular expression (for example the .* pattern will match any text) as the argument to the following options.
Inclusion filters
- hostname : hostname of the node
- name : resource name of the node, which may be different than hostname
- type : type name of the node, typically "Node"
- tags : a set of user defined tags. If you have multiple tags, the separator is either the comma "," for an OR between them,
or a plus "+" for an AND between them. Example : "web,prod" (either "web" or "prod"), "web+prod" (both "web" and "prod").
- os-name : operating system name, e.g. "Linux", "Macintosh OS X"
- os-family : operating system family, e.g. "windows","unix"
- os-arch : operating system CPU architecture, e.g. "x86", "x386"
- os-version : operating system version number
Exclusion filters
- exclude-hostname : hostname of the node
- exclude-name : resource name of the node, which may be different than hostname
- exclude-type : type name of the node, typically "Node"
- exclude-tags : a set of user defined tags. If you have multiple tags, the separator is either the comma "," for an OR between them,
or a plus "+" for an AND between them. Example : "web,prod" (either "web" or "prod"), "web+prod" (both "web" and "prod").
- exclude-os-name : operating system name, e.g. "Linux", "Macintosh OS X"
- exclude-os-family : operating system family, e.g. "windows","unix"
- exclude-os-arch : operating system CPU architecture, e.g. "x86", "x386"
- exclude-os-version : operating system version number
Predecence is the issue of whether a node should be included in the result set when it matches both an exclusion filter and an inclusion filter.
- exclude-precedence : boolean - whether exclusion filters take precedence (default to yes). Must be either "true" or "false".
This field should be written in the Java-Properties format, 1 option per line : key=value.
You can use Jenkins environment variables ($JOB_NAME, $WORKSPACE, etc) or System environment variables ($OSTYPE, $USER, etc) in your values,
and we will expand them when notifying RunDeck.
Example :
tags = web+prod
exclude-os-family = windows