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 51 52 53 54 55 56 57 58 59 60 61
|
-----------
work submit
-----------
.. contents::
:local:
``receptorctl work submit`` requests a Receptor node to run a unit of work.
Command syntax: ``receptorctl --socket=<socket_path> work submit [<<Options>>] <<WorkType>> [<<Runtime Parameters>>]``
``socket_path`` is the control socket address for the Receptor connection.
The default is ``unix:`` for a Unix socket.
Use ``tcp://`` for a TCP socket.
The corresponding environment variable is ``RECEPTORCTL_SOCKET``.
.. code-block:: text
ss --listening --processes --unix 'src = unix:<socket_path>'
Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process
u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7))
``ps -fp $(pidof receptor)``
``lsof -p <pid>``
``WorkType`` specifies an execution request type for the work unit. Use the ``receptorctl status`` command to find available work types for Receptor nodes.
``Runtime Parameters`` are parameters passed by Receptor to the work command.
^^^^^^^^^^^^^^^^^^^
Work submit options
^^^^^^^^^^^^^^^^^^^
You can use the following options with the ``work submit`` command:
.. list-table::
:header-rows: 1
:widths: auto
* - Option
- Description
* - ``-a``, ``--param <<KEY>>=<<VALUE>>``
- Adds a Receptor parameter in key=value format.
* - ``-f``, ``--follow``
- Keeps Receptorctl to remain attached to the job and displays the job results.
* - ``-l``, ``--payload-literal <<TEXT>>``
- Uses the value of ``<<TEXT>>`` as the literal unit of work data.
* - ``-n``, ``--no-payload``
- Sends an empty payload.
* - ``--node <<Node ID>>``
- Specifies the Receptor node on which the work runs. The default is the local node.
* - ``-p``, ``--payload <<TEXT>>``
- Specifies the file that contains data for the unit of work. Specify ``-`` for standard input (stdin).
* - ``--rm``
- Releases the work unit after completion.
* - ``--signwork``
- Digitally signs remote work submissions to standard output (stdout).
* - ``--tls-client <<TEXT>>``
- Specifies the TLS client that submits work to a remote node.
* - ``--ttl <<TEXT>>``
- Specifies the time to live (TTL) for remote work requests in ``##h##m##s`` format; for example ``1h20m30s`` or ``30m10s``. Use the ``receptorctl work list`` command to display units of work on Receptor nodes and determine appropriate TTL values.
|