MQTT::return

Description¶

This command gets or sets the return-code field of MQTT CONNACK messages.

Syntax¶

MQTT::return_code [<return_code>]

MQTT::return_code¶

Get the return-code field of MQTT CONNACK message.

MQTT::return_code <return_code>¶

Set the return-code field of MQTT CONNACK message to specified number. The number must be smaller than 256.
- 0 : Connection Accepted.
- 1 : Connection Refused. Protocol level not supported.
- 2 : Connection Refused. The client-identifier is not allowed by the server.
- 3 : Connection Refused. The MQTT service is not available.
- 4 : Connection Refused. The data in the username or password is malformed.
- 5 : Connection Refused. The client is not authorized to connect.
- 6-255 : Reserved for future use.

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.