Skip to content

Commit 14f39da

Browse files
committed
Added documentation for useringroup policy function
Ticket: ENT-12721 Signed-off-by: Victor Moene <[email protected]>
1 parent 62fa8d5 commit 14f39da

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default
3+
title: useringroup
4+
published: true
5+
---
6+
7+
[%CFEngine_function_prototype(user)%]
8+
9+
**Description:** Return whether a `user` is a member of a given `group`
10+
11+
Looks up the group `"group_name"` in the group database located in /etc/group and checks whether `"user_name"` is one of its members.
12+
13+
[%CFEngine_function_attributes(user_name, group_name)%]
14+
15+
**Example:**
16+
17+
[%CFEngine_include_snippet(useringroup.cf, #\+begin_src cfengine3, .*end_src)%]
18+
19+
Output:
20+
21+
[%CFEngine_include_snippet(useringroup.cf, #\+begin_src\s+example_output\s*, .*end_src)%]

0 commit comments

Comments
 (0)