Task Configuration
Network Automation lets you connect to network devices via SSH and automatically execute commands. For example, you can schedule daily backups of router configuration files or register tasks that automatically run diagnostic commands when specific events occur.
To add a task, you need account credentials (username/password or SSH key file) that allow SSH access to the target device.
Viewing the task list
Go to Network Automation > Task Configuration to view the list of registered tasks. Select an NMS Manager from the Select Manager dropdown at the top of the screen, then search by device alias, host, username, or memo to quickly locate tasks.
The number of tasks per status is displayed at the top of the screen. Click a chip to filter tasks by that status.
| Chip | Description |
|---|---|
| All | Total number of registered tasks |
| Active | Number of tasks currently active and running |
| Inactive | Number of suspended tasks |
| Scheduled | Number of tasks set to run automatically on a recurring basis |
Key list columns
Key information available in the task list.
| Column | Description |
|---|---|
| No. | Task sequence number |
| Active | Green dot (blinking) = active; gray dot = inactive |
| Alias | Device alias. Click to navigate to the task's execution history |
| Host | Device IP address or hostname |
| Username | SSH login account name |
| Port | SSH connection port |
| Auth method | Password or Key file |
| Schedule | manual, every N min (periodic), or detector (event-triggered) |
| Commands | Number of commands registered in the task |
| Retries | Number of retry attempts on failure |
| Key file | Key file name when key file authentication is used |
| Timeout | Command execution time limit |
| Last status | Last execution result: success, failure, or pending |
| Last run time | Time of the last execution |
| Next run time | Next scheduled execution time (blank for manual) |
| Memo | Task description memo |
Adding a task
-
Click the Add Task button in the upper right.
-
Configure each field in the popup and click Save.
Step 1: Enter basic information
Specify which device to connect to and with which account.
| Field | Required | Description |
|---|---|---|
| Device | Required | Select the target device to run commands on |
| Username | Required | SSH login account name |
| SSH port | Required | SSH port — change only if different from the default (22) |
| Device type | Required | CLI driver type. If unsure, enable Auto Detect and the server will determine it automatically when the task is saved |
| Enabled | Enable or disable this task configuration | |
| Retries | Required | For unstable network environments, 1–3 retries is recommended |
| Timeout (sec) | Required | For slow-responding devices, set higher than the default |
| Memo | Free-text note about the task |
Step 2: Choose execution timing (schedule)
Decide when this task should run.
| Schedule type | When to use |
|---|---|
Manual | Run by clicking the execute button manually — for tasks that do not need automatic execution |
Scheduler | Automatic execution every N minutes or at a specific time each day — suitable for periodic backups and data collection |
Detector | Automatic execution when a specific event or condition is detected — suitable for automated incident response |
Step 3: Choose SSH authentication method
| Auth method | When to use |
|---|---|
Password | Enter the SSH password directly — for quick setup |
Key file | Authenticate with an SSH key file for secure, password-free access — the key file must be uploaded in SSH Key Management in advance |
Privilege escalation (Enable Mode)
Some network devices do not allow configuration lookup or change commands with the default privileges of the login account, and require raising the privilege level with the enable command. Use Enable Mode and Enable Password below the login password to include this step in the task.
| Field | Required | Description |
|---|---|---|
| Enable Mode | Switch that turns privilege escalation on or off. Off by default when created | |
| Enable Password | Required when Enable Mode is on | Password used for privilege escalation. It can differ from the SSH login password |
Turning Enable Mode off disables the Enable Password field. The value you entered is not cleared, so it remains when you turn the switch back on. If Enable Mode is on and Enable Password is left empty, the task is not saved and an error appears on the field.
Enable Mode requires NMS Manager 1.3.3 or later
Managers on 1.3.2 or earlier do not recognize the two values and silently drop them from the save request. The save appears to succeed without an error, but the scheduled run fails with privilege escalation missing. To prevent this, when the manager version is insufficient, only the switch and the password field are disabled and the message "Enable mode is not supported on manager version 1.3.2 or earlier. On 1.3.2 or earlier, enter an account with top-level privileges." is displayed.
Only these two fields are locked; the other items can still be edited. If the manager version cannot be read, it is also treated as unsupported.
Step 4: Register commands to execute
Add commands to execute in order. At least one command is required.
-
Click the + Add Command button and enter a command.
-
Use the ↑↓ buttons to adjust the execution order.
-
Adding a description for each command makes them easier to identify later.
Test connection before saving
It is recommended to verify connectivity before saving.
-
Click the Test Connection button.
-
The result appears at the bottom of the popup.
-
Success: preview of the connection prompt
-
Failure: error type and cause message
-
Edit, run now, and delete tasks
Use the action buttons on the right side of the list to perform each operation.
| Button | Description |
|---|---|
| Edit | Opens the configuration popup to modify existing values |
| Run Now | Confirms and immediately executes the task — results are viewable in Task Status |
| Delete | Deletes the task — execution history is also removed |
SSH key file management
Key file authentication requires registering the key file first. Click the SSH Key Management button in the upper right.
| Action | How to |
|---|---|
| Upload | Select an SSH private key file (e.g., .pem), enter a file name, and enter the passphrase if the key is passphrase-protected |
| Delete | Remove key files no longer in use from the list |