MQTT::retain

Description¶

This command gets or sets the retain flag of MQTT PUBLISH messages.

Syntax¶

MQTT::retain [<0 | 1>]

MQTT::retain¶

Get the retain flag of MQTT PUBLISH message.

MQTT::retain 0¶

Reset the retain flag of MQTT PUBLISH message.

MQTT::retain 1¶

Set the retain flag of MQTT PUBLISH message.

Examples¶

Related Information¶

Valid Events:
MQTT_CLIENT_INGRESS, MQTT_SERVER_INGRESS, MQTT_CLIENT_DATA,
MQTT_SERVER_DATA

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code:

Introduced: BIGIP-13.0.0

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.