Applying command sets

When applying a command set, the system verifies that the running and stored (candidate) configurations on each impacted resource are the same. If these are not the same, a mismatch error will be presented. This mismatch must be resolved before submitting any changes to the resource. After a successful configuration change, the system writes the running configuration to the stored/candidate configuration on each resource, ensuring that all three configurations (current, running, stored) are in synch.

Before you begin

There are a number of different windows presented in both the modelled command sets and native command sets. The sequence of the windows are dependent on the type and composition of the command set.
Restriction: When applying native command sets ensure that the 'native compare' option is disabled in the RAD. Instead, use 'smartmodel diff', as this option will handle non-comparable lines in the configuration.

About this task

This task describes how to apply a command set.
Note: There are several different ways to apply a command set. A command set can be selected, and applied to one or more network resources. One or more network resources can be selected, and then a command set applied to the network resource(s). Also multiple command sets can be supplied to multiple network resources. In addition, one or more command sets can be applied to a realm.

Procedure

  1. Navigate to the Resource Browser, and highlight the command set required from the listing of network resources.
  2. From the menu bar, select Tools > Apply (Native) Command Set.
  3. When the Select Command Sets window is displayed choose the command sets required using the Add/Remove buttons in between the panels. The Move Up and Move Down icons are used for prioritizing the order in which the command sets are applied. Select Next to proceed.
  4. The Scope of Application dialog displays. Using the following table as a guide, please enter the appropriate information requested. When the scope selection has been chosen, select Next.
    Table 1. Scope of Application dialog
    Selection Description

    Apply the Command Sets to Network Resources in a Realm

    Will apply the command set(s) to all network resources in the realm selected.

    Apply the Command Sets to specific Network Resources

    Will apply the command set(s) only to the specific network resources chosen.

    Apply the Command Sets to the Network Resources retrieved from a Realm

    Will apply the command set(s) to all network resources in the retrieved realm.

  5. The second part of Scope of Application window displays. Select the realm name/network resources as applicable to the choice made in the previous window. This filters devices based on their support level e.g, to display SmartModel only. Units of Work can also be filtered by Name or VTMOS filter as required. However, this is an optional step. Wildcards are in place by default to retrieve all possibilities. Click Next to proceed.
  6. The Configure Execution Options dialog displays. Using the following table as a guide, please enter the appropriate information requested. Select Next to proceed.
    Table 2. Configure Execution Options dialog
    Element Description

    Execution Mode

    Execute Mode

    Applies command set to selected network resources.

    Report Only Mode

    Does not change resources, but produces a report detailing the changes that would be made to those resources if in execute mode.

    Apply Device at a time

    Applies all command sets to one individual device at a time.

    Apply Command Set at a time

    Applies one command set at a time to a resource.

    Failure Options

    Ignore All Errors

    Indicates that the UOW will continue processing, regardless of any failures that occur. If each command set is to be applied to each resource regardless of any errors, select the Override flag as well.

    Fail After X Total Errors.

    User has the ability to select how many errors can occur before total failure of process.

    Fail After X Percent Errors

    User has the ability to select the maximum percentage of failures that can occur before the UOW stops processing.

    Pre-Emptive Compliance Options

    Note: These options are only available if the user is a member of a group with Pre-Emptive compliance activities. Pre-emptive options are only available for Modeled Command Sets.

    Enable Pre-Emptive Compliance Checks

    When in Execute mode all Pre-emptive modes are available. However if the user has selected Report Only execution mode, then report only pre-emptive mode is automatically selected. If the user has ‘Manage Work' rights they will be able to disable Pre-emptive Compliance checks by deselecting the check box. Users who do not have 'Manage Work' rights will not be able to modify pre-emptive settings.

    Block Configuration Change if projected configuration contains compliance failures

    Policy is run against the current and projected configuration to determine if a violation is present. If a violation is found, the configuration change is blocked.

    Block Configuration Change if projected configuration contains new compliance failures only

    If a compliance violation is found within the projected configuration and the current configuration has no violations then the configuration change will be blocked. If both projected and current configurations have failures then the configuration change will not be blocked and changes will be made to the device.

    Report Compliance Failure(s) only (Configuration change will not be blocked)

    Produces a report providing information on violations in both the current and projected configuration. Pre-Emptive failures are ignored and the command set continues to execute.

    Command Sets

    This lists the command sets that will be rolled back.

    Note: If Execute Mode has been chosen, the Rollback Options window will be displayed. Otherwise, the wizard skips ahead to the Enter Parameters window.
  7. The Rollback Options window displays. A Rollback can be requested in the event that a command set fails. The Rollback can be carried out for a single command set, or multiple command sets. Using the following table as a guide, please enter the appropriate information requested. Select Next to proceed.
    Table 3. Rollback Options fields
    Field Definition

    How should Rollbacks on Command Set failures be handled?

    No Rollback

    Select this to turn off the rollback option.

    Use Modeled Rollback

    This option will enable a rollback to a modeled configuration.

    Reload the configuration and reboot the device

    This option will load the original configuration and reboot the device.

    Check here to have Rollbacks verified

    Select this checkbox to enable rollback verification.

    How should Rollbacks be done for each Network Resource?

    Rollback only the failed Command Set on the failed Network Resource

    This option rolls back only that command set that failed.

    Rollback all Command Sets on the failed Network Resources

    This option rolls back all command sets on the failed resource.

  8. The Enter Parameters window displays. Using the following table as a guide, please enter the appropriate information requested. Select Next to proceed.
    Table 4. Enter Parameters fields
    Field Definition

    Manual

    Used where the same parameter name is used in multiple command sets, but each different value can be defined depending on the command set.

    Local

    Uses the Command Set Editor to step through each command set, providing a value for each parameter.

  9. The Password Overridewindow displays. Using the following table as a guide, please enter the appropriate information requested.
    Table 5. Password Override fields
    Field Definition

    Override ITNCM - Base Authentication

    Select this check box to override the default authentication information.

    Login Name

    Provide the login name for the device you are accessing.

    Password

    Provide the password for the device you are accessing.

    Enable Password

    Provide the device enable password for the device you are accessing.

    Only Use This Authentication

    Select this check box if you will always use this authentication for your resource.

  10. The Execution Priority window displays. By default all UOWs are submitted with a priority of Medium. Select the priority required and click Next .
  11. The Schedule Work window displays. If you select Immediate, the Describe Work window will be displayed. If you select Scheduled or Recurring Schedule, use the information in the following table to make the rest of your selections in the Schedule Work window.
    Table 6. Schedule Work options
    Option Definition

    Scheduled

    The job will run at a specific time, based on the values entered for Scheduled Start and Scheduled End.

    Hourly

    Use this option to specify that the process should run each hour, or every n hours after the scheduled start time, for example, Every 3 hours after Scheduled Start.

    Daily

    Use this option to specify that the process should run every n days, for example, Every 5 days, or else every weekday (Monday - Friday).

    Weekly

    Use this option to specify that the process should run every n weeks on a specific day of the week, for example, Every 3 weeks on a Monday.

    Monthly

    Use this option to specify that the process should run on a specific day of every n months, for example, Day 30 of every 6 months. Or, you can specify that the process runs on a relative day of every month, for example, The First Monday of every 3 months.

    Yearly

    Use this option to specify that the process runs on a specific day and month of every year, for example, Every January 1st. Or, you can specify that the process should run on a relative day of the week of a specific month, for example, The First Monday of January

    Scheduled Start

    Enter the scheduled start time and date.

    Scheduled End

    Enter the scheduled end time and date.

    Next Execution

    Enter the time and date for the next execution.

    Window Size

    Use the drop-down lists to indicate the window size.

    Every n hours after Scheduled Start

    Choose the number of hours from the drop-down list.

    Every n days

    Choose the number of days from the drop-down list.

    Every Weekday

    The job will run every weekday.

    Recur every n weeks

    Choose the number of weeks from the drop-down list and select the appropriate day.

    Day n of every n months

    Choose the number of days and months from the drop-down lists.

    The specific day of every n month

    Choose the specific day and month from the drop-down lists.

    Every specific date

    Choose the month and day from the drop-down lists.

    The specific day of every n month

    Choose the specific day and month from the drop-down lists.

  12. The Resources per UOW window is displayed if more than one network resource has been chosen to synchronize. Make the required selections or go to the next step if you only chose one resource. Click Next to proceed.
  13. The Describe Work window displays. Enter a description for the UOW, and then click Finish.

What to do next

The command set is now submitted as a UOW and will run when scheduled, as long as the proper approvals are granted. The number of approvals required for the UOW depends on the group policy.