func-transmit man page

Func-transmit -- cross-language func adapter


func-transmit [-h⎪--help] [-j⎪--json] [-y⎪--yaml] < data_in > data_out


Func includes a powerful Python API for addressing the overlord via software.  When writing an app in a language other than Python, func-transmit can be used to operate the overlord and recieve structured results from it.

This tool, func-transmit, is intended to be called using pipes, sending formatted data into stdin and recieving return codes via stdout.  It also can be invoked using the shell.

Formats and Usage

The input and output format is either JSON or YAML 1.0. The default is JSON. The [--yaml] option enables YAML support.

The data formats used by Func transmit are described in more detail (with examples) at


Generally func-transmit should always return 0 if loading is successful.  Return data is then expressed in the output stream, to be interpreted by a JSON or YAML  module at the other end of the pipe.  Non-zero return codes indicate more serious setup problems.

Func-transmit will exit after every command issued to the overlord, it does not await further input on the pipes.

Additonal Resources

See for more information.

See also the manpages for “func-inventory”, “funcd”, “certmaster”, and “certmaster-ca”.


Various. See

Referenced By

func-build-map(1), funcd(1).