Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Add a Network Cleanup Task

You can add a network cleanup task to clean up the network automatically. Automating this process saves time, especially in large networks.

To add a network cleanup task:

  1. Select Administration > Task Scheduler.

    The Task Scheduler page appears.

  2. Click Add.

    The Create New Task page (wizard) appears.

  3. Configure the fields in each step of the wizard according to the guidelines provided in Table 1.

    Click Next to go to the next step.

    Note:

    Fields marked with an asterisk (*) are mandatory.

  4. After you complete steps 1, 2, and 3 in the wizard, click Submit.

    The details of the task that you added are displayed on the Task Scheduler page.

    After the task is completed, select the task in the list to view the results in the Summary, Status, and History tabs.

    You can view the post-cleanup topology on the Topology page (Network > Topology). To ensure that you have the latest topology, right-click the blank space in the topology map and select Reload Network. The latest topology is displayed in the topology map.

Table 1: Fields on the Create New Task Wizard (Network Cleanup)

Field

Description

Step 1

Name

Specify a meaningful name for the task.

Task Group

From the list, select Utility Tasks.

Task Type

From the list, select Network Cleanup.

Step 2

Options

Select one or more check boxes corresponding to the following options. By default, all the available options are selected except Force remove links with user attributes.

  • Purge down links—If you select this option, the links that are down are removed from the live network and database.

  • Force remove links with user attributes—If you select this option, the links that have custom attributes defined in the controller are removed from the live network and database.

  • Purge down nodes—If you select this option, the nodes that are down are removed from the live network and database.

  • Generate purge report—If you select this option, a report is generated every time the task is executed. The report indicates the actions taken as a result of the cleanup. Purge reports, identified with a timestamp, are stored in /opt/northstar/data/.network_plan/Report/purge_reports/

  • Add notifications to timeline—If you select this option, you can see notifications relevant to the execution of the task in the Timeline page. To get there, navigate to the Topology page (Network > Topology) and right-click on the blank space on the topology map. From the list that appears, select Timeline.

Step 3

Schedule

Schedule the task to be triggered once or to recur automatically based on the intervals you specify.

Startup Options:

  • Starts Now—Select this option to start the network cleanup task at the current time.

  • Starts On—Select this option and click the calendar icon to select the date and time at which the task starts. To start the task at the current date and time, click Current Date and Time at the bottom of the calendar.

  • Timezone—Displays the client timezone.

Recurrence Options:

  • Repeats—Specify the frequency (Never, Minutes, Hours, Days, Weekly, Monthly, or Yearly) with which the task recurs.

  • Every—Specify the periodicity of recurrence.

  • Ends—Select Never if you want the task to recur at the specified interval automatically. Alternatively, select On, and click the calendar icon to specify a date and time at which you want the task to end. To end a task at the current date and time, click Current Date and Time at the bottom of the calendar.

  • Timezone—Displays the client timezone.

Note:

Instead of scheduling recurrence, you can select to chain the task after an already-scheduled recurring task, so that it launches immediately after the other task completes. Select Chain after another task. From the list of recurring tasks that is displayed, select the task after which you want to launch the task that you added.