summaryrefslogtreecommitdiffstats
path: root/docs/func.pod
blob: b73bcf957316743fd6b7ebaf61d23540ba5c8ef0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
=head1 NAME

Func -- Fedora Unified Network Controller.

=head1 SYNOPSIS

func target.example.org module command [args ...] [--verbose]
func "target*.example.org" module command [args ...] [--verbose]
func "webserver1;mailserver2" module command [args ...] [--verbose]

=head1 DESCRIPTION

"func" allows remote control of machines running funcd (called "minions")
that are set to obey this machine (called the "overlord").  This includes
performing various remote operations and gathering data.

"func" can address multiple machines at the same time by specifying
their names with globs, which follow shell glob syntax.

See the project homepage (below) for a list of modules available
and a more in-depth description of what each of them do.

=head1 LISTING REMOTE MODULES AVAILABLE

func target.example.org system list_modules

=head1 LISTING REMOTE FUNCTIONS AVAILABLE IN A MODULE

func target.example.org modulename list_methods

=head1 CALLING A REMOTE COMMAND

func target.example.org modulename methodname

=head1 EXIT_STATUS

Func commands have return values that vary based on the module being
called.  See the project page (linked below) for more information.

=head1 ADDITONAL RESOURCES

See https://hosted.fedoraproject.org/projects/func/ for more information, including information on scripting func from Python.

See also the manpages for "funcd", "certmaster", and "certmaster-ca".

=head1 AUTHOR

Various. See https://hosted.fedoraproject.org/projects/func