Add Upload Job
Click the plus icon on the Upload Job page to create a new Upload Job. The 'Add Upload' page includes three additional tabs:
Job Details | Add Upload Jobs
Label
Action
Description/ Example
Job Name
Enter the appropriate name for the job.
This name will be used to identify the upload job within the system. Example: "Network Backup Job."
Job Description
Provide a brief description of the upload job.
This description helps users understand the purpose and details of the job.
Example: "Backup configuration for all routers."
Type
Select the type of upload job from the drop-down list.
Options include Regular Job and OS Upgrade Job.
Job Execution Window (Mins/Hrs)
Choose the time frame for executing the upload job.
Select the time window in minutes or hours to specify when the job should run.
Example: "Execution window: 24 hours."
Notify to
Select users to be notified about the upload job.
Choose the relevant users who should receive notifications about the job's completion or completion from the drop-down list.
Agent
Choose the respective agent from the drop-down list.
The agent refers to the entity responsible for executing the upload job.
Job Status
Toggle the button to enable or disable the job status.
Enable the job status to allow the job to run. If disabled, the job will not execute.
Download Configuration before and after Upload
Turn on this functionality if needed.
This action is used to take a backup of the configuration before the upload job begins, and once the upload is complete, another backup is taken to ensure the updated configuration is saved.
Once the details have been added, click on Next to continue.
Task Details | Add Upload Jobs
Each Job has one or more tasks to be executed in a specific order, as defined. Task is the smallest unit where command execution on Devices is defined. Every task will have its Configuration Template, and the Devices will RUN with Runtime object input.
Each Task supports multiple command executions with multiple parameter substitutions simultaneously for individual location devices. Every task gets Device Credentials from the User when it is created.
Each task requires the following inputs from the User
Task Name.
Task Description.
Vendor
Configuration Template (Based on the Vendor).
View template - used to view the selected template.
Task Command(s) - used to view and edit task-related commands.
Select Template - used to select the template from the Template(s) collection.
Note: View and Edit template functionalities can be availed only when editing the job.
Note: Configuration template options are enabled based on the applied license. The buttons (View Template & Select Template) will not be visible if the configuration template license is inactive.
Device group and IP Address and IP Address from CSV - Using the dropdown or IP Address(s) in textbox or IP address from the CSV by using Load IP Address from CSV
Configuration profile (Mandatory for null vendor)
Configuration protocol (Mandatory for null vendor)
Connection Port (Mandatory for null vendor)
Device Username
Device Password
Confirm Password
Enable Password
Confirm Enable Password
Select if Shell must be installed remotely or locally.
Update Device credentials using the dropdown menu. (This option is for performing password rotation)
Task Enabled/Disabled
Task retry count
Task retry interval window (mins/hrs)
Continue next IP Address on Error
Continue the next Command on Error
Run after (Previous Task(s) Name)
Run only (Previous Task(s)) Status)
Wait After Previous Task(s) Completion in seconds
Click Add to Add the Task to the Upload Job Execution Queue.
To Edit the Added Task, select the Task and click Edit
Select the Task and click Delete to remove the Task from the upload job.
Clicking ^ on will move the task up.
Clicking ^ on will move the task down.
Other Details | Add Upload Jobs
Schedule Details | Add Upload Jobs
Click the Schedule Details Tab. Update the information below
Select the execution schedule option.
Once
Every
Daily
Weekly
Monthly
Select the Hours and Minutes from the Execute
Access Control | Add Upload Jobs
Click the Access Control tab.
Choose the visibility using the Radio button
If visibility is “Private,” User and User group dropdown will be enabled.
Select User(s) using dropdown.
Select Team(s) using dropdown.
If the Upload job is private, only selected users and User groups can view the job.
Note: Fields marked with * are mandatory to add.
Review Job
Click Review to Review the Upload job.
The review process displays all Tasks, their definitions, and completed details, including commands to execute before saving the job.
Review results could be exported into PDF.
Click Save to configure the Upload job. Click Cancel to abort the job.
Note:
If the Upload job has been added by a White-listed user, it will be executed based on the execution time.
If a Non-White-Listed user has added an Upload job, it will be executed only after the approval process.
The task waiting Period will suspend the execution of the next Task until the end of the period, at which point the Task execution resumes.
If the device(s) vendor is not identified (due to SNMP not being reachable), then the upload Job must be selected with Profile, Protocol, and Port to override download Job null entries.
If any particular task has failed, the task will execute again based on the Retry count and interval before the dependent task execution.
If the first task fails, the second task will be executed after completing the whole retry interval of the previous task.
If a task has multiple IP(s) configured and at the time of execution, if any IP(s) fail, the next retry will happen only for the failed IPs.
Configuring Task Chain or Task Dependency
The upload job supports Task dependencies by associating ‘Previous Task’s Name’ from the previous task name list and the previous execution result status as a condition for the current task to execute.
Three tasks have been configured:
Task1 - Enabling the BGP
Task2 - BGP Additional-Paths Select
Task3 - Start the Interface
Task1 is the Parent or Previous Task for the Task2 and Task3.
Upon successful execution of Task 1, Task 2 will be executed (not Task 3).
If Task1 fails, Task3 will be executed (Task2 will not be executed).
Task 1 Details:
Task 1 has been configured with the below parameters,
Label
Value
Execution Window
2 Hours
Run After
Start
Run if Previous Task
Success
Retry Count
1
Retry Interval
2 Hours
Task 1 should be executed within 2 hours of initiating it.
If Task 1 fails during execution, it will retry the same task one more time in 2-hour intervals.
If the input for the “Run After” field is given as ‘Start’, there is no dependency on the previous task.
Task 2 Details:
Task 2 has been configured with the below parameters.
Label
Value
Execution Window
15 minutes
Run After
Task1
Run if Previous Task
Success
Retry Count
3
Retry Interval
15 Minutes
Task 2 should be executed within 15 minutes of starting the execution.
Run After is “Task1” and Run if Previous Task is “Success,” which means “Task2” is dependent on “Task1” and will only be executed if “Task1” has been successfully executed.
If Task 2 fails during execution, it will retry the same task three times within 15-minute intervals.
Task 3 Details:
Task 3 has been configured with the below parameters.
Label
Value
Execution Window
2 Hours
Run After
Task1
Run if the Previous Task
Fail
Retry Count
2
Retry Interval
30 Minutes
Task 3 should be executed within 2 hours of starting the execution.
Run After is “Task1” and Run if Previous Task is “Fail,” which means “Task3” is dependent on “Task1”; if “Task1” fails, only then will “Task3” get executed.
If Task 3 fails during execution, it will retry the same task three times within 30-minute intervals.
Note: Users will only receive notifications upon the completion of the upload job.
Edit Upload Job
To edit an upload job, select an existing job, click on Edit, and Follow the same procedure as ‘Add job’ to edit.
Note:
Job re-run cannot be in the In-progress state.
Once the job execution has been completed, we can Re-run the same job.
Re-run options are only available if the job is enabled or completed.
Job Re-Run
This will trigger the job to re-execute the same job. However, users cannot re-run a job if any associated tasks are currently in progress or if the job is disabled.
Last updated