[Index]

Model: data/HcsIOSConsolidatedCommandDAT

Consolidate Commands

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

You can build a repository of IOS commands to be run when certain events, such as adding an IOS device, occur. Each set of IOS commands and associated event is known as a Command Builder.

For a list of events with default set of IOS commands and available variables, see Local Break Out and Analog Gateway Events, IOS Commands, and Variables.

The default Command Builders exist at the sys.hcs hierarchy level.

You can define customized Command Builders at any hierarchy node. When an event occurs, Command Builders nearest (at or above) the hierarchy node of the event are checked first. For instance, if an event occurs at a customer hierarchy level, Command Builders at the customer level are checked before Command Builders at the provider or sys.hcs level. Command Builders at a higher level are checked only if no builders match at a nearer hierarchy level. If no customized Command Builders are defined, the default Command Builders at sys.hcs are checked. Multiple Command Builders may be run for the same event at the same hierarchy node.

Set up a Command Builder

This procedure sets up a Command Builder that contains an IOS Commands template for an event.

To set up a Command Builder:

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 Apps 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

This procedure clones 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.

To clone a command builder:

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 Apps 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.

View IOS Commands Log

Using the IOS Commands log, an administrator can see a list of command sets that were triggered by different events. An administrator can copy the IOS Commands template and paste it into the IOS device CLI to be executed.

By default, the command sets are listed with the most recent at the top.

Perform these steps:

1. Log in as provider, reseller, or customer administrator.
2. Set the hierarchy path to the level for which you want to view IOS Commands.
3. Choose Apps Management > IOS > Commands. A table containing the Command Builders that have been triggered is displayed. The table contains this information:

Consolidate IOS Commands

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

To copy IOS commands:

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 Apps 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.

Next Steps

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

HcsIOSConsolidatedCommandDAT

Model Details: data/HcsIOSConsolidatedCommandDAT