mosquitto_pub1Mosquitto ProjectCommandsmosquitto_puban MQTT version 3.1.1/3.1 client for publishing simple messagesmosquitto_pubhostnameport numberusernamepasswordmessage-topicURLbind_addressclient_idclient id prefixkeepalive timemessage QoSfilemessagetopicpayloadqosfiledirfilefileciphersversionhex-keyidentityciphersversionsocks-urlprotocol-versionmosquitto_pubDescriptionmosquitto_pub is a simple MQTT version 3.1.1
client that will publish a single message on a topic and
exit.OptionsThe options below may be given on the command line, but may also
be placed in a config file located at
or
with one pair of
per line. The values in the config file will be used as defaults
and can be overridden by using the command line. The exceptions to
this are the message type options, of which only one can be
specified. Note also that currently some options cannot be negated,
e.g. . Config file lines that have a
as the first character are treated as comments
and not processed any further.Bind the outgoing connection to a local ip
address/hostname. Use this argument if you need to
restrict network communication to a particular
interface.Define the path to a file containing PEM encoded CA
certificates that are trusted. Used to enable SSL
communication.See also Define the path to a directory containing PEM encoded CA
certificates that are trusted. Used to enable SSL
communication.For to work correctly, the
certificate files must have ".crt" as the file ending
and you must run "c_rehash <path to capath>" each
time you add/remove a certificate.See also Define the path to a file containing a PEM encoded
certificate for this client, if required by the
server.See also .An openssl compatible list of TLS ciphers to support
in the client. See
ciphers1
for more information.Enable debug messages.Send the contents of a file as the message.Display usage information.Specify the host to connect to. Defaults to localhost.The id to use for this client. If not given, defaults
to mosquitto_pub_ appended with the process id of the
client. Cannot be used at the same time as the
argument.Provide a prefix that the client id will be built
from by appending the process id of the client. This is
useful where the broker is using the clientid_prefixes
option. Cannot be used at the same time as the
argument.When using certificate based encryption, this option
disables verification of the server hostname in the
server certificate. This can be useful when testing
initial server configurations but makes it possible for
a malicious third party to impersonate your server
through DNS spoofing, for example. Use this option in
testing only. If you need to
resort to using this option in a production
environment, your setup is at fault and there is no
point using encryption.The number of seconds between sending PING commands
to the broker for the purposes of informing it we are still
connected and functioning. Defaults to 60 seconds.Define the path to a file containing a PEM encoded
private key for this client, if required by the
server.See also .Specify specify user, password, hostname, port and topic at once as a URL.
The URL must be in the form:
mqtt(s)://[username[:password]@]host[:port]/topicSend messages read from stdin, splitting separate lines into separate messages. Note that blank lines won't be sent.Send a single message from the command line.Send a null (zero length) message.Connect to the port specified instead of the default 1883 for plain MQTT and 8883 for MQTT over TLS.Provide a password to be used for authenticating with
the broker. Using this argument without also specifying
a username is invalid. See also the
option.Specify a SOCKS5 proxy to connect through. "None" and
"username" authentication types are supported. The
must be of the form
.
The protocol prefix means that
hostnames are resolved by the proxy. The symbols %25,
%3A and %40 are URL decoded into %, : and @
respectively, if present in the username or
password.If username is not given, then no authentication is
attempted. If the port is not given, then the default
of 1080 is used.More SOCKS versions may be available in the future,
depending on demand, and will use different protocol
prefixes as described in curl1.Provide the hexadecimal (no leading 0x)
pre-shared-key matching the one used on the broker to
use TLS-PSK encryption support.
must also be provided
to enable TLS-PSK.The client identity to use with TLS-PSK support. This
may be used instead of a username if the broker is
configured to do so.Specify the quality of service to use for the message, from 0, 1 and 2. Defaults to 0.If this argument is given, no runtime errors will be
printed. This excludes any error messages given in case of
invalid user input (e.g. using without a
port).If retain is given, the message will be retained as a "last known good" value on the broker. See mqtt7 for more information.Send a message read from stdin, sending the entire content as a single message.Use SRV lookups to determine which host to connect
to. Performs lookups to
when used in
conjunction with , otherwise uses
.The MQTT topic on which to publish the message. See mqtt7 for more information on MQTT topics.Choose which TLS protocol version to use when
communicating with the broker. Valid options are
, and
. The default value is
. If the installed version of
openssl is too old, only will be
available. Must match the protocol version used by the
broker.Provide a username to be used for authenticating with
the broker. See also the
argument.Specify which version of the MQTT protocol should be
used when connecting to the rmeote broker. Can be
or .
Defaults to .Specify a message that will be stored by the broker
and sent out if this client disconnects unexpectedly. This
must be used in conjunction with .The QoS to use for the Will. Defaults to 0. This must
be used in conjunction with .If given, if the client disconnects unexpectedly the
message sent out will be treated as a retained message.
This must be used in conjunction with .The topic on which to send a Will, in the event that
the client disconnects unexpectedly.Willsmosquitto_sub can register a message with the broker that will be
sent out if it disconnects unexpectedly. See
mqtt7
for more information.The minimum requirement for this is to use to
specify which topic the will should be sent out on. This will result in
a non-retained, zero length message with QoS 0.Use the ,
and
arguments to modify the other will parameters.ExamplesPublish temperature information to localhost with QoS 1:mosquitto_pub -t sensors/temperature -m 32 -q 1Publish timestamp and temperature information to a remote host on a non-standard port and QoS 0:mosquitto_pub -h 192.168.1.1
-p 1885 -t
sensors/temperature -m "1266193804
32"Publish light switch status. Message is set to retained because there may be a long period of time between light switch events:mosquitto_pub -r-t switches/kitchen_lights/status -m "on"Send the contents of a file in two ways:mosquitto_pub -t my/topic -f ./datamosquitto_pub -t my/topic -s < ./dataSend parsed electricity usage data from a Current Cost meter, reading from stdin with one line/reading as one message:read_cc128.pl | mosquitto_pub -t sensors/cc128 -lFiles$XDG_CONFIG_HOME/mosquitto_pub$HOME/.config/mosquitto_pubConfiguration file for default options.Bugsmosquitto_pub bug information can be found at https://bugs.eclipse.org/bugs/describecomponents.cgi?product=MosquittoSee Alsomqtt7mosquitto_sub1mosquitto8libmosquitto3mosquitto-tls7AuthorRoger Light roger@atchoo.org