Skip to content

test plugins

This is the list of test plugins in the ansible.builtin collection:

Plugin Description
ansible.builtin.abs is the path absolute
ansible.builtin.all are all conditions in a list true
ansible.builtin.any is any condition in a list true
ansible.builtin.boolean Return true if the object is a boolean value.
ansible.builtin.callable Return whether the object is callable.
ansible.builtin.change did the task require changes
ansible.builtin.changed did the task require changes
ansible.builtin.contains does the list contain this element
ansible.builtin.defined Return true if the variable is defined.
ansible.builtin.directory does the path resolve to an existing directory
ansible.builtin.divisibleby Check if a variable is divisible by a number.
ansible.builtin.eq Same as a == b.
ansible.builtin.equalto Same as a == b.
ansible.builtin.escaped Check if the value is escaped.
ansible.builtin.even Return true if the variable is even.
ansible.builtin.exists does the path exist, follow symlinks
ansible.builtin.failed did the task fail
ansible.builtin.failure did the task fail
ansible.builtin.false Return true if the object is False.
ansible.builtin.falsy Pythonic false
ansible.builtin.file does the path resolve to an existing file
ansible.builtin.filter Check if a filter exists by name.
ansible.builtin.finished Did async task finish
ansible.builtin.float Return true if the object is a float.
ansible.builtin.ge Same as a >= b.
ansible.builtin.greaterthan Same as a > b.
ansible.builtin.gt Same as a > b.
ansible.builtin.in Check if value is in seq.
ansible.builtin.integer Return true if the object is an integer.
ansible.builtin.is_abs is the path absolute
ansible.builtin.is_dir does the path resolve to an existing directory
ansible.builtin.is_file does the path resolve to an existing file
ansible.builtin.is_link does the path reference existing symbolic link
ansible.builtin.is_mount does the path resolve to mount point
ansible.builtin.is_same_file compares two paths to see if they resolve to the same filesystem object
ansible.builtin.isnan is this not a number (NaN)
ansible.builtin.issubset is the list a subset of this other list
ansible.builtin.issuperset is the list a superset of this other list
ansible.builtin.iterable Check if it's possible to iterate over an object.
ansible.builtin.le Same as a <= b.
ansible.builtin.lessthan Same as a < b.
ansible.builtin.link does the path reference existing symbolic link
ansible.builtin.link_exists does the path exist, no follow
ansible.builtin.lower Return true if the variable is lowercased.
ansible.builtin.lt Same as a < b.
ansible.builtin.mapping Return true if the object is a mapping.
ansible.builtin.match Does string match regular expression from the start
ansible.builtin.mount does the path resolve to mount point
ansible.builtin.nan is this not a number (NaN)
ansible.builtin.ne Same as a .
ansible.builtin.none Return true if the variable is none.
ansible.builtin.number Return true if the variable is a number.
ansible.builtin.odd Return true if the variable is odd.
ansible.builtin.reachable Task did not end due to unreachable host
ansible.builtin.regex Does string match regular expression from the start
ansible.builtin.same_file compares two paths to see if they resolve to the same filesystem object
ansible.builtin.sameas Check if an object points to the same memory address than another object.
ansible.builtin.search Does string match a regular expression
ansible.builtin.sequence Return true if the variable is a sequence.
ansible.builtin.skip Was task skipped
ansible.builtin.skipped Was task skipped
ansible.builtin.started Was async task started
ansible.builtin.string Return true if the object is a string.
ansible.builtin.subset is the list a subset of this other list
ansible.builtin.succeeded check task success
ansible.builtin.success check task success
ansible.builtin.successful check task success
ansible.builtin.superset is the list a superset of this other list
ansible.builtin.test Check if a test exists by name.
ansible.builtin.timedout did the task time out
ansible.builtin.true Return true if the object is True.
ansible.builtin.truthy Pythonic true
ansible.builtin.undefined Like :func:defined but the other way round.
ansible.builtin.unreachable Did task end due to the host was unreachable
ansible.builtin.upper Return true if the variable is uppercased.
ansible.builtin.uri is the string a valid URI
ansible.builtin.url is the string a valid URL
ansible.builtin.urn is the string a valid URN
ansible.builtin.vault_encrypted Is this an encrypted vault string
ansible.builtin.vaulted_file Is this file an encrypted vault
ansible.builtin.version compare version strings
ansible.builtin.version_compare compare version strings