[Index]

Model: data/HcsCommandBuilderDAT

Set up a Command Builder

Use this procedure to set up a Command Builder that contains an IOS Commands template for an event.

Note

One event can trigger multiple Command Builders.

Procedure

  1. Log in as provider, reseller, or customer administrator.

  2. Set the hierarchy path to the level where you want to define your Command Builder.

  3. Choose Device Management > IOS > Command Builder.

  4. Click Add.

  5. Provide the following information:

    Field Description
    Name Enter a unique name for the builder. This field is mandatory.
    Event Name Select the event that triggers the builder. This field is mandatory
    Description Enter a description for the builder.
    Command Template Enter the IOS Commands template for the event, one command per line. You can use macros in the IOS Commands template for variable substitution.
    Enabled Clear the Enabled check box to create a builder but not have it available to run.
    Applicable Device Type Select the device type that the commands can run on. This field is mandatory.

  6. Click Save.

Clone a Command Builder

Use this procedure to clone a Command Builder that contains an IOS Commands template for an event. For instance, use this procedure to modify one of the default Command Builders to suit your needs.

Note

One event can trigger multiple Command Builders.

Procedure

  1. Log in as provider, reseller, or customer administrator.

  2. Set the hierarchy path to the level where you want to clone an existing Command Builder.

  3. Choose Device Management > IOS > Command Builder.

  4. Click the Command Builder name you want to clone.

  5. Choose Action > Clone.

  6. Modify the following information as needed:

    Field Description
    Name Enter a unique name for the builder. This field is mandatory.
    Event Name Select the event that triggers the builder. This field is mandatory
    Description Enter a description for the builder.
    Command Template Enter the IOS Commands template for the event, one command per line. You can use macros in the IOS Commands template for variable substitution.
    Enabled Clear the Enabled check box to create a builder but not have it available to run.
    Applicable Device Type Select the device type that the commands can run on. This field is mandatory.

  7. Click Save.

HcsCommandBuilderDAT

Model Details

Title Description Details
Name * Command Builder name
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Event Name * Event name
  • Field Name: eventName
  • Type: String
  • Target: data/HcsCommandEventDAT
  • Target attr: eventName
  • MaxLength: 1024
  • Format: uri
Description A description for the command builder
  • Field Name: description
  • Type: String
  • MaxLength: 4096
Command Template Command template triggered by this event
  • Field Name: commandTemplate
  • Type: String
  • MaxLength: 4096
Enabled * command builder enabled or not Default: true
  • Field Name: enabled
  • Type: Boolean
  • Default: true
Applicable Device Type * Applicable Device Type
  • Field Name: applicableDevType
  • Type: String
  • MaxLength: 1024
  • Choices: ["IOS Device", "SIP Local Gateway", "Analog Gateway"]
API reference for data/HcsCommandBuilderDAT