Skip to end of metadata
Go to start of metadata

APIs

  • system.cirruslink.distributor.createConfig(type, props) → void
    • 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)
            • Username (str)
            • Password (str)
            • ACLs (str)
    • Return Value
      • None
  • system.cirruslink.distributor.readConfig(type) → List
    • 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)
  • system.cirruslink.distributor.updateConfig(type, id, collisionPolicy, props) → void
    • Parameters
      • String type
        • The type of configuration to update with valid options:

          • General
          • Users
      • Long id
        • The ID of the record to update
      • String collisionPolicy
        • Either "MergeOverwrite" or "Overwrite"
      • Map props
        • 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)
    • Return Value
      • None
  • system.cirruslink.distributor.deleteConfig(type, id) → void
    • Parameters
      • String type
        • The type of configuration to delete with valid options:

          • Users
      • Long id
        • The ID of the record to delete
    • Return Value
      • None


  • No labels