1FUNC(1) func FUNC(1)
2
6 Func -- Fedora Unified Network Controller.
7
9 func "*" list_minions
10 func target.example.org call module method [args ...]
12 func "target*.example.org" call module method [args ...]
14 func "webserver1;mailserver2" call module method [args ...]
16
18 "func" allows remote control of machines running funcd (called "min‐
19 ions") that are set to obey this machine (called the "overlord"). This
20 includes performing various remote operations and gathering data.
21 "func" can address multiple machines at the same time by specifying
23 their names with globs, which follow shell glob syntax.
24 Groups of machines can also be specified in /etc/func/groups. To invoke
26 func on a group of machines specifying "@groupname".
27 See the project homepage (below) for a list of modules available and a
29 more in-depth description of what each of them do.
30
32 The "call" module is used for running func modules remotely.
33 Format: func "*.example.org" call <module> <function> [ args ... ]
35
37 It's possible to ask func minions what modules they have installed:
38 func "*.example.org" call system list_modules
40
42 It is also possible to ask remote func modules what functions they sup‐
43 port:
44 func target.example.org call modulename list_methods
46
48 Once you have the name of a module you want to run, use call to invoke
49 it:
50 func target.example.org call modulename methodname
52
54 The "call" command by default outputs data using a "pretty printer".
55 Other display options include --raw, --json, and --xmlrpc, which may be
56 more desirable if you are running func inside another script or prefer
57 to read those display formats.
58 Example: func "*" call --json service inventory
60
62 In addition to "call", there are other modules that make control of
63 remote machines, as well as data display, more user friendly. They
64 augment "call" by providing some additional functionality.
65 You will notice that the syntax for using one of these helper modules
67 varies slightly from just using "call" directly.
68 For example "show" can be used to show remote data. The normal command
70 "func '*' command would dump a very large amount of data, while the
71 show command can mine only a few details. This might make things more
72 readable, for instance, when not going through the Python API (where
73 you would not care).
74 func "*.example.org" show hardware --help
76 func "*.example.org" show hardware systemMemory
78 func "*.example.org" show hardware os
80 Another useful helper command module is copyfile, which allows func to
82 work like scp from the shell, though it can address multiple systems at
83 the same time.
84 The following example pushes one file out to multiple systems:
86 func "*.example.org" copyfile --file=/tmp/foo --remotepath=/tmp/foo
88 While these helper modules will grow over time, usage of "call" syntax
90 directly is fine also. See the Wiki for more examples as they evolve.
91
93 Use this flag to output extra information from func while it is run‐
94 ning. All func commands can take this flag.
95
97 Func commands have return values that vary based on the module being
98 called. See the project page (linked below) for more information.
99
101 See https://fedorahosted.org/func/ for more information, including
102 information on scripting func from Python.
103 See also the manpages for "func-inventory", "funcd", "certmaster",
105 "certmaster-ca", and "func-transmit".
106
108 Various. See https://fedorahosted.org/func/
109 2012-10-15 FUNC(1)