ProtocolController/NetworkManagement Cluster

The following commands and attributes are accepted as JSON payloads for the ProtocolController-NetworkManagement cluster.

ProtocolController/NetworkManagement Attributes

The following attribute topics are used to retrieve the ProtocolController-NetworkManagement cluster state.

ProtocolController-NetworkManagement/NetworkManagementState Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/Reported
[PREFIX]/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster NetworkManagementState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "NetworkManagementState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NetworkManagementState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/+'
 
# Example output
 
ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/Desired { "value": <DESIRED_NETWORK_MANAGEMENT_STATE>}
ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/Attributes/NetworkManagementState/Reported { "value": <REPORTED_NETWORK_MANAGEMENT_STATE>}

ProtocolController/NetworkManagement/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Attributes/ClusterRevision/Reported
[PREFIX]/ProtocolController/NetworkManagement/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

ProtocolController/NetworkManagement Command Support

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/SupportedCommands
[PREFIX]/ProtocolController/NetworkManagement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "Write",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ProtocolController-NetworkManagement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/SupportedCommands { "value": ["Write","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for ProtocolController-NetworkManagement cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/SupportedGeneratedCommands { "value": [] }

ProtocolController/NetworkManagement Commands

ProtocolController/NetworkManagement/Write Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Commands/Write
[PREFIX]/ProtocolController/NetworkManagement/GeneratedCommands/Write

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster Write Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a ProtocolController/NetworkManagement/Write command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/Commands/Write' -m  '{  }'

To receive a ProtocolController/NetworkManagement/Write generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/NetworkManagement/GeneratedCommands/Write'

ProtocolController/NetworkManagement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ProtocolController/NetworkManagement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Commands/WriteAttributes' -m  '{  }'

‍NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

ProtocolController/NetworkManagement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/NetworkManagement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/NetworkManagement Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "NetworkManagementState"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ProtocolController/NetworkManagement attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ProtocolController/NetworkManagement attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/NetworkManagement/Commands/ForceReadAttributes' -m  '{ "value": ["NetworkManagementState"] }'