Skip to content

Commit 0c2568a

Browse files
committed
(doc) Update REFERENCE for the new check task
1 parent edf2467 commit 0c2568a

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

REFERENCE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,32 @@
66

77
### Tasks
88

9+
* [`check`](#check): Check whether a Puppet(tm) implementation is installed. Optionally checks the version.
910
* [`install`](#install): Installs an openvox package. By default, this will be the latest openvox-agent from the latest collection.
1011
* [`install_build_artifact`](#install_build_artifact): Downloads and installs a package directly from the openvox build artifact server.
1112

1213
## Tasks
1314

15+
### <a name="check"></a>`check`
16+
17+
Check whether a Puppet(tm) implementation is installed. Optionally checks the version.
18+
19+
**Supports noop?** false
20+
21+
#### Parameters
22+
23+
##### `version`
24+
25+
Data type: `Optional[String]`
26+
27+
The version of the implementation to check. To check if version meets a minimum, set test to 'ge' and version to x, x.y or x.y.z
28+
29+
##### `test`
30+
31+
Data type: `Enum['eq', 'lt', 'le', 'gt', 'ge']`
32+
33+
Version comparison operator.
34+
1435
### <a name="install"></a>`install`
1536

1637
Installs an openvox package. By default, this will be the latest openvox-agent from the latest collection.

0 commit comments

Comments
 (0)