gofer man page

gofer — The goferd management tool.

Synopsis

gofer [-h]

gofer mgt [ -h ] [ -H HOST ] [ -p PORT ]
         [ -s ] [ -l PATH ] [ -r PATH ] [ -u PATH ]

gofer rmi [ -h ] [ -u URL ] [ -a ADDRESS ] [ -t TARGET ]
         [ -i INPUT ] [ -r REPLY ] [ -w SECONDS ]
         [ -p PREFIX ] [ -d DATA ] [ -S SECRET ] [ -T SECONDS ]
         [ -A PATH ] [ -U NAME ] [ -A PASSWORD ]

Description

gofer is the command line tool for managing goferd and performing RMI calls. All unmapped arguments are considered arguments to the RMI target. Keyword arguments have the form of: <name>=<value>.

See: https://github.com/jortel/gofer for more information.

Management Options

The following options are supported by gofer mgt

-h [ --help ]

Displays the help message.

-H [ --host ] HOST

The host or IP used to connect to goferd.

-p [ --port ] PORT

The port used to connect to goferd.

-s [ --status ]

Displays goferd status information.

-l [ --load ] PATH

Load the plugin using the specified PATH to the descriptor.

-r [ --reload ] PATH

Reload the plugin using the specified PATH to the descriptor. The PATH can also be the plugin name.

-u [ --unload ] PATH

Unload the plugin using the specified PATH to the descriptor. The PATH can also be the plugin name.

Call Options

The following options are supported by gofer rmi

-h [ --help ]

Displays the help message.

-u [ --url ] URL

The broker URL.

-a [ --address ] ADDRESS

The AMQP address for the agent.

-r [ --reply ] ADDRESS

The AMQP reply address.

-t [ --target ] TARGET

The RMI target.  Format is: <class>.<method>. Eg: Dog.bark

-i [ --input ] INPUT

The RMI input (json) document. Format is: [[], {}].

-w [ --wait ] SECONDS

The time in seconds to wait the RMI to complete.

-p [ --progress ] PREFIX

The progress output prefix.  Enables progress reporting to STDOUT with the prepended prefix.

-d [ --data ] DATA

User data round-tripped with the RMI request.

-S [ --secret ] SECRET

The shared secret to include with the RMI request.

-T [ --ttl ] SECONDS

The request TTL in seconds.

-A [ --authenticator ] PATH

The python path to a message Authenticator.  Eg: redhat.gofer.Authenticator.

-U [ --user ] NAME

The user name passed in the RMI request.

-P [ --password ] PASSWORD

The password passed in the RMI request.

Examples

$ gofer rmi -u qpid+amqp://localhost -a xyz -t Dog.bark "hello master"

$ gofer rmi -u qpid+amqp://localhost -a xyz -t Dog.bark words="hello master"

$ gofer rmi -u qpid+amqp://localhost -a xyz -t Dog.bark -i '[["hello master"],{}]'

$ gofer rmi -u qpid+amqp://localhost -a xyz -d '{"id": "1234"}' -t Dog.bark howdy

See Also

goferd(1)

Bugs

No known bugs.

Files

/etc/gofer/agent.conf

The main goferd configuration file

Author

Jeff Ortel (jortel@redhat.com)

Info

10 March 2015 2.6 goferd man page