Page History

Basic Operations

The following

...

basic operations are available for the MQTT Distributor Module and can be executed within any of the available Ignition scopes

...

• createConfig
• readConfig
• updateConfig
• deleteConfig

APIs

...

using the format system.cirruslink.distributor.operation

• createConfig(type,

...

• Parameters
  • String type

    • The type of configuration to create with valid options:

      • Users
  • Map props
    • Dictionary of properties making up the configuration with the following keys and datatypes:
      • Users
        • Id (long)(cannot be null)
        • Username (str)
        • Password (str)
        • ACLs (str)
• Return Value
  • A map representing the newly created configuration after it has been written to the database. (added 4.0.16)

...

• Parameters
  • String type

    • The type of configuration to read with valid options:

      • General
      • Users
• Return Value
  • A List of Dictionaries of properties making up the configurations with the following keys and datatypes: 
    
    • General
      
      • Id (long)
      • Enabled (bool)
      • EnableTCP (bool)
      • Port (int)
      • EnableWebsocket (bool)
      • WebsocketPort (int)
      • EnableTLS (bool)
      • SecurePort (int)
      • EnableSecureWebsocket (bool)
      • SecureWebsocketPort (int)
      • AllowAnonymousConnections (bool)
    • Users
      
      • Id (long)
      • Username (str)
      • Password (str)
      • ACLs (str)

...

• The type of configuration to update with valid options:

  • General
  • Users

...

• The ID of the record to update

...

• name, config, enabled, description)
  
  • enabled (boolean) and description (string) are optional calls
  • returns a dictionary that represents the config.json of the specified resource
• deleteConfig(type, name)
  • returns a boolean
• getConfigNames(type, enabled)
  • enabled is an optional call
  • returns a list strings
• isConfigEnabled(type, name)
  • returns a boolean
• readConfig(type, name)
  • returns a dictionary that represents the config.json of the specified resource
• setConfigEnabled(type, name, enabled)
  • returns a boolean 
• updateConfig(type, name, collisionPolicy, config)
  • returns a dictionary that represents the config.json of the specified resource

where:

• type
  • string denoting the type of configuration to operate on
• name
  • string denoting the unique name for the configuration resource to operate on
• config
  • dictionary of properties making up the configuration resource to operate on
    • general
    • user
• enabled
  • boolean
• collisionPolicy
  • string with options "MergeOverwrite" or "Overwrite"
    • "MergeOverwrite" will replace the existing properties in the

...

• • • resource name with only those included in the call
    • "Overwrite" will replace all properties in the

...

• • • resource name with those in the call

...

• Dictionary of properties making up the configuration with the following keys and datatypes:
  • General
    
    • Id (long)
    • Enabled (bool)
    • EnableTCP (bool)
    • Port (int)
    • EnableWebsocket (bool)
    • WebsocketPort (int)
    • EnableTLS (bool)
    • SecurePort (int)
    • EnableSecureWebsocket (bool)
    • SecureWebsocketPort (int)
    • AllowAnonymousConnections (bool)
  • Users
    
    • Id (long)
    • Username (str)
    • Password (str)
    • ACLs (str)

• general
• user

Anchor
general general

Distributor 'general' keys

Anchor
user user

Distributor 'user' keys

...

• A map representing the updated configuration after it has been written to the database. (added 4.0.16)

...

• String type

  • The type of configuration to delete with valid options:

    • Users
• Long id
  • The ID of the record to delete

...