[Index]

Model: data/HcsIOSConsolidatedCommandDAT

Consolidate Commands

To copy IOS commands to an IOS device CLI that is generated by multiple events, follow these steps:

Procedure

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

  2. Set the hierarchy path to the customer or site for which you want to consolidate IOS commands.

  3. Choose Device Management > IOS > Consolidate Commands.

  4. Click Add.

  5. On the Consolidate Commands screen, complete at minimum, the mandatory Consolidate Commands Fields.

  6. Click the required command templates listed in the Available list, and click Select to move them to the Selected list.

    Click Remove to unselect a command template.

    Note:

    You can change the order of the command templates by clicking Move Up and Move Down. However, the consolidated commands are generated in chronological order regardless of the order of the selected command templates.

  7. Click Save.

    The new command consolidation instance appears in the list.

  8. Click the command consolidation instance you created.

    In the Command Template field, all the commands from the command templates you selected appear in one window. Comments are used to separate and identify the source command templates. You can edit the consolidated commands.

    Any modifications to the Command consolidation, displays the entire list of commands in a single instance. The commands present earlier to the modification cannot be viewed separately as the commands from the earlier events are treated as a single instance.

What to Do Next

After you have consolidated the IOS commands you want, copy them from the Commands Template field to the IOS device CLI.

Consolidate Commands Fields

Field Description
Name * Enter a unique name for the command consolidation. This field is mandatory.
Description Enter an optional description for the command consolidation.
IOS Device * Choose the IOS device from which you want to consolidate commands.
Device Type *

Choose the device types for which you want to consolidate commands.

IOS Device

Choose this to get commands for the IOS device and any SIP Local Gateway or Analog Gateway hosted on that device.

SIP Local Gateway

Choose this to get commands only for the SIP Local Gateway.

Analog Gateway

Choose this to get commands only for the Analog Gateway.

You do not get commands for devices that have been deleted.

Note:

If you select site hierarchy, only specific commands such as IOS Device or SIP Local gateway are displayed. To view both the IOS and Analog gateway commands, choose the customer hierarchy path.

HcsIOSConsolidatedCommandDAT

Model Details: data/HcsIOSConsolidatedCommandDAT

Title Description Details
Name * Command Name
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Description A description for the command set
  • Field Name: description
  • Type: String
  • MaxLength: 4096
IOS Device * IOS Device the gateway runs on
  • Field Name: iosDevice
  • Type: String
  • MaxLength: 1024
Device Type * Applicable Device Type
  • Field Name: applicableDevType
  • Type: String
  • MaxLength: 1024
  • Choices: ["IOS Device", "SIP Local Gateway", "Analog Gateway"]
Commands
  • Field Name: commands.[n]
  • Type: Array
Command Template Command template triggered by the event
  • Field Name: consolidatedCmdTemplate
  • Type: String
Timestamp Indicates when the event occured
  • Field Name: timestamp
  • Type: String
  • MaxLength: 1024