Schema sender_transport_params_mqtt.json

Resolve referenced schemas (may reorder keys)

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Describes MQTT Sender transport parameters. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint. MQTT Senders must support all properties in this schema.",
  "title": "MQTT Sender Transport Parameters",
  "type": "object",
  "title": "Sender Output",
  "properties": {
    "destination_host": {
      "type": [
        "string",
        "null"
      ],
      "description": "Hostname or IP hosting the MQTT broker. If the parameter is set to auto the Sender should establish for itself which broker it should use, based on a discovery mechanism or its own internal configuration. A null value indicates that the Sender has not yet been configured.",
      "anyOf": [{
          "pattern": "^auto$"
        },
        {
          "format": "hostname"
        },
        {
          "format": "ipv4"
        },
        {
          "format": "ipv6"
        },
        {
          "type": "null"
        }
      ]
    },
    "destination_port": {
      "type": [
        "integer",
        "string"
      ],
      "description": "Destination port for MQTT traffic. If the parameter is set to auto the Sender should establish for itself which broker it should use, based on a discovery mechanism or its own internal configuration.",
      "minimum": 1,
      "maximum": 65535,
      "pattern": "^auto$"
    },
    "broker_protocol": {
      "type": "string",
      "description": "Indication of whether TLS is used for communication with the broker. 'mqtt' indicates operation without TLS, and 'secure-mqtt' indicates use of TLS. If the parameter is set to auto the Sender should establish for itself which protocol it should use, based on a discovery mechanism or its own internal configuration.",
      "enum": [
        "auto",
        "mqtt",
        "secure-mqtt"
      ]
    },
    "broker_authorization": {
      "type": [
        "string",
        "boolean"
      ],
      "description": "Indication of whether authorization is used for communication with the broker. If the parameter is set to auto the Sender should establish for itself whether authorization should be used, based on a discovery mechanism or its own internal configuration.",
      "enum": [
        "auto",
        true,
        false
      ]
    },
    "broker_topic": {
      "type": [
        "string",
        "null"
      ],
      "description": "The topic which MQTT messages will be sent to on the MQTT broker. A null value indicates that the Sender has not yet been configured."
    },
    "connection_status_broker_topic": {
      "type": [
        "string",
        "null"
      ],
      "description": "The topic which MQTT status messages such as MQTT Last Will are sent to on the MQTT broker. A null value indicates that the Sender has not yet been configured, or is not using a connection status topic."
    }
  },
  "patternProperties": {
    "^ext_[a-zA-Z0-9_]+$": {
      "$ref": "sender_transport_params_ext.json"
    }
  },
  "additionalProperties": false
}

 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Describes MQTT Sender transport parameters. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint. MQTT Senders must support all properties in this schema.",
  "title": "MQTT Sender Transport Parameters",
  "type": "object",
  "title": "Sender Output",
  "properties": {
    "destination_host": {
      "type": [
        "string",
        "null"
      ],
      "description": "Hostname or IP hosting the MQTT broker. If the parameter is set to auto the Sender should establish for itself which broker it should use, based on a discovery mechanism or its own internal configuration. A null value indicates that the Sender has not yet been configured.",
      "anyOf": [{
          "pattern": "^auto$"
        },
        {
          "format": "hostname"
        },
        {
          "format": "ipv4"
        },
        {
          "format": "ipv6"
        },
        {
          "type": "null"
        }
      ]
    },
    "destination_port": {
      "type": [
        "integer",
        "string"
      ],
      "description": "Destination port for MQTT traffic. If the parameter is set to auto the Sender should establish for itself which broker it should use, based on a discovery mechanism or its own internal configuration.",
      "minimum": 1,
      "maximum": 65535,
      "pattern": "^auto$"
    },
    "broker_protocol": {

Documentation built at 04:16:11 CDT on 2025-04-02.
(c) AMWA 2025. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.