IP Maestro : User Manual : Network Management
Network Management
The Network Management menu allows to configure network devices and manage its performance. It shows data on network elements such as device information, image upgrade, license information, network configuration and so on.
This menu has the following sub-menus:
Manage Inventory
The Inventory page provides options used to administer the network devices. It displays all the known network devices for this controller and helps with the mounting of the devices on the domain controller.
Icons located at the top-right of the table are primarily used to mount network devices, monitor operational progress, and for bulk execution.
This page shows the devices that are configured on the domain controller. You can mount/connect or unmount/disconnect the registered devices.
Procedure
In the IP Maestro home page, click Network Management > Inventory.
The Inventory page is displayed with the following details:
Field
Description
Host Name
The assigned name or label generated by the system.
Device
Ipv4 address provided by the user.
Status
Operational connection status. The possible values are:
Connected
Unable to connect
Connecting
Unknown
Rebooting
Groups
Group in which the device is located
Device Type
Device description details generated by the system.
License
License type.
Image
Installed image details.
Action
A set of actions that can be performed on each device.
Mount a device
You can mount one or many devices on the domain controller. Each network device is known as a mount point and each mount point must be configured and registered to the controller.
Prerequisites
Ensure that the device exists in the network.
The Management IP must be reachable.
Procedure
1. Click the icon at the top right.
2. In the Device Mount dialog box, add the required details in the following fields:
 
Field
Description
Device
The registered device to be updated.
Username
The username used to gain access to the device.
Password
Password used to gain access to the device.
3. In the Device Mount dialog box, click the icon to define the device groups.
4. In the Device Groups dialog box, add the required details in the following fields:
 
Field
Description
Group name
A user-defined name or label that can be used to group devices together.
Owner (username)
Originator and/or owner of the group.
Notes
Describes the general purpose of the group.
5. Click Save.
6. In the Device Mount dialog box, click Apply to save the changes on the device.
7. In the Inventory page, click the icon to check the status of the device.
The new device is configured.
Discover a Device
You can discover and mount several devices on the Inventory page by specifying the start range and the end range of the device IPs.
Prerequisites
The device exists in the network.
The Management IP is reachable.
Procedure
1. On the Inventory page, click the icon.
2. In the Device Discovery dialog box, add the required details in the following fields:
 
Field
Description
Device Range
 
Start
The IPv4 address to begin the search with.
End
The IPv4 address to conclude the search.
Note: The ending address must be within the same subnet (network ID).
Username
The username to gain access to the device.
Password
The password to gain access to the device.
Port
The port number of the device.
3. Click Discover to display the list of the devices within the range you have specified.
4. In the Device Discovery dialog box, select the devices that you want to mount, and then click Mount to add the devices to the Inventory page.
The selected devices are mounted on the Inventory page.
Unmount a Device
You can unmount one or many devices that are mounted.
Prerequisites
The device(s) must be mounted.
Procedure
1. Click the check-box on the device rows you want to unmount and click the icon.
2. In the Confirmation dialog box, click Yes.
Import Device Details
You can import the Comma Separated Value (CSV) files to the Inventory page. The Import and Export features allow you to save and restore your registered devices. This feature also allows offline customization through custom imports of CSV file.
Prerequisites
Ensure that the device already exists and is configured on the domain controller.
All devices mentioned in the CSV files are reachable.
Procedure
1. On the Inventory page, click the icon.
2. Select the CSV files that you want to import to the Inventory page.
The selected CSV files are imported. This enables you to configure a large number of devices at once.
Export Device Details
You can export the current device details in a CSV format. The Import and Export features allow you to save and restore your registered devices. This feature also allows offline customization via custom imports. This file format is comma-separated values (CSV).
Prerequisite
Ensure that the device already exists and is configured on the domain controller.
Procedure
1. On the Inventory page, select the devices that you want to export.
2. Click the icon.
The devices’ details are exported as CSV files in Excel format. You can open these CSV files on Notepad for better representation.
Monitor Operation Progress on Device
You can monitor the progress of various operations such as Image Upgrade, License Installation, Config Backup, and Config Restore on a device using the icon at the top right of the table.
Image Upgrade
Image Upgrade is a feature that supports the upgrade of OcNOS image on a device being managed by IP Maestro. It provides a feature that enables IP Maestro to download and upgrade the software on devices. The images are created and managed externally from IP Maestro and are made available via a published repository. The portal is then used to navigate through the public folder in search of the appropriate image. The user selects the image file for the targeted device. For more information, refer to the section Upgrade New Image.
Install License
Install License is a feature that enables IP Maestro to manage device node licenses. The binary license files are created and managed externally from IP Maestro and are made available via a published repository. The portal is then used to navigate through the public folder in search of the appropriate license. The user selects the license file based on its name, which is the serial number of the targeted device. On selecting the device and license, the portal is used to notify the device as to where the license is located. The device will then retrieve and activate the license. For more information, refer to the section Install License.
Config Backup
Config Backup is used to back up Device Configuration for a single device or the entire network. A customized data table is used to define and manage the targeted devices.
The managed network devices are configured using YANG modules and each device contains its own modules. The Config Backup feature is used to store these device configurations (which can be restored at a later date). When a device is backed up, all the configurations are grouped and assigned a label. The label is then used to restore a specifically labeled backup. For more information, refer to the section Configure New Backup.
Config Restore
Config Restore is used to back up and restore Device Configuration for a single device or the entire network. A customized data table is used to define and manage the targeted devices.
The managed network devices are configured using YANG modules and each device contains its own modules. This feature is used to replace device configurations that were previously backed up. For more information, refer to the section Configure Restore.
Upgrade New Image
The image is a binary file that is installed on the OcNOS device. During the upgrade process, the image is first downloaded to the device. The actual installation however is performed according to the scheduled installation time. One or more registered devices can be selected for image upgrade at the same time. This two-step process is executed automatically.
Prerequisite
Ensure that the device already exists and is configured on the domain controller.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Inventory.
2. Click the icon, and then click Image Upgrade to display the image upgrade status and configuration.
The following details are displayed for Image Upgrade Progress:
Field
Description
Host Name
The assigned name or label generated by the system.
Device
Ipv4 address provided by the user.
Status
The status of download operation, such as:
Pending
Scheduled
In-Progress
Failed
Done
The status of image operation:
Started
Operation
Status in response (or notification). It is the current sequence of the two-step process. The operation status can be:
Download
Installation
Install Time (GMT)
The time scheduled to begin operation.
Current Version
Software version installed on the device.
Installed Version
The recently installed software version on the device.
Image Location
The fully qualified path name of the file.
Interface
The management interface used for file transfers.
1. Click the icon.
2. In the Image Upgrade dialog box, add the required details in the following fields:
Field
Description
Device
Registered device to update selected by the user from the dropdown.
Source Interface
Select an interface on the device used for data transfers (within the management VRF). The default is “eth0” interface.
Note: The source interface is used for all selected interfaces.
Image Selection
Published Images
The images that are available and hosted from an Image Repository.
Note: The repository is defined in System Management > Preferences.
User Defined
Free- form field to enter a custom, fully-qualified path and image name.
Upgrade Now
Toggle to enable the input switch to execute the upgrade.
Save Configuration
Toggle to copy the configuration to startup-config before the image upgrade.
Installation Time
Calendar to schedule an update.
3. Click Apply to save and schedule the image upgrade for all selected devices.
The new image upgrade is configured.
Edit the Image Upgrade Details
You can edit an image that is installed on the device.
Prerequisite
Ensure that the device already exists and is configured on the domain controller.
Procedure
1. On the Inventory page, in the Image Upgrade Progress menu, click the icon at the end of device row.
2. In the Image Upgrade dialog box, add the required details in the following fields:
Field
Description
Device
Registered device to update from the dropdown.
Source Interface
Select an interface on the device used for data transfers (within the management VRF). The default is “eth0” interface.
Note: The source interface is used for all selected interfaces
Image Selection
Published Images
The images that are available and hosted from an Image Repository.
Note: The repository is defined in System Management > Preferences.
User Defined
Free- form field to enter a custom, fully-qualified path and image name.
Upgrade Now
Toggle to enable the input switch to execute the upgrade.
Save Configuration
Toggle this to copy the configuration to startup-config before the image upgrade.
Installation Time
Calendar to schedule an update.
3. Click Apply to save and schedule image upgrade for all selected devices.
The image upgrade is edited.
Upgrade Image for all Selected Devices
You can perform bulk upgrade of images for selected devices.
Prerequisite
Ensure that the device already exists and is configured on the domain controller.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Inventory.
2. Click the icon, and then click Image Upgrade to display the image upgrade status.
3. In the Image Upgrade Progress panel, click the icon.
4. In the Image Upgrade dialog box, add the required details in the following fields:
Field
Description
Device
Registered device to update selected by the user from the drop-down.
Source Interface
Select an interface on the device used for data transfers (within the management VRF). The default is “eth0” interface.
Note: The source interface is used for all selected interfaces.
Image Selection
Published Images
The images that are available and hosted from an Image Repository.
Note: The repository is defined in System Management > Preferences.
User Defined
Free- form field to enter a custom, fully-qualified path and image name.
Upgrade Now
Toggle to enable the input switch to execute the upgrade.
Save Configuration
Toggle to copy the configuration to startup-config before the image upgrade.
Installation Time
Calendar to schedule an update.
5. Click Apply to save and schedule the image upgrade for all selected devices.
The image upgrade is configured for the selected device(s)
Import the Image Upgrade Details
You can import the CSV files to the Image Upgrade page. The Import and Export features allow you to save and restore your upgraded images. This feature also allows offline customization via custom imports. This file format is comma-separated values (CSV).
Prerequisites
The device already exists and is configured on the domain controller.
All devices mentioned in the CSV files are reachable.
Procedure
1. On the Inventory page,in the Image Upgrade Progress menu, click the Import icon.
2. In the Import Data dialog box, Select or Upload the CSV files that you want to import to the Image Upgrade Progress menu.
The selected CSV files are imported on the Image Upgrade Progress menu. This enables you to configure a large number of images in one go.
Export the Image Upgrade Details
You can export the current device details in a CSV format. The Import and Export features allow you to save and restore your upgraded images. This feature also allows offline customization via custom imports. This file format is CSV.
Prerequisite
Ensure that the device already exists and is configured on the domain controller.
Procedure
1. On the Inventory page, in the Image Upgrade Progress menu, select the devices for which you want to export the images.
2. Click the Export icon.
The devices’ details are exported as CSV files in Excel format. You can open these CSV files in Notepad for a better representation.
Delete the Image Upgrade Details
To cancel the scheduled image upgrade for all selected devices, you must delete the details from the Image Upgrade page.
Prerequisite
The image upgrade details are applied on the mounted devices.
Procedure
1. In the Image Upgrade Progress menu, select the device row(s) to delete the image.
2. Click Delete.
The scheduled image upgrade gets canceled for all the selected devices.
Install License
To install license on a selected device, follow the steps mentioned below:
Prerequisites
The devices are already mounted and registered on the domain controller.
Licenses are externally available via a public URL.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Inventory.
2. At the right of the device row, click the Action icon and click Operations > Install License. The License Install dialog box is displayed.
3. Enter the appropriate information as follows:
Field
Description
Device
Registered device to update.
Source Interface
Select an interface on the device used for data transfers (within the management VRF). The default is “eth0” interface.
Note: The source interface is used for all selected interfaces.
License Selection
Published Licenses
Licenses available and hosted from a License Repository. The repository is defined in System Management > Preferences.
User Defined
Free-form field to enter a custom fully-qualified path and name of license.
Device ID
Registered device to update.
4. Click Apply to apply and save the changes.
Alternatively, to install license on bulk devices at a time, follow these steps:
1. Select the check boxes on the device rows for bulk install and click the icon.
2. Click Install License to display the License Install dialog box.
3. Enter the appropriate information as follows:
Field
Description
Device
Registered device to update.
Source Interface
Select an interface on the device used for data transfers (within the management VRF). The default is “eth0” interface.
Note: The source interface is used for all selected interfaces.
License Selection
Published Licenses
Licenses available and hosted from a License Repository. The repository is defined in System Management > Preferences.
User Defined
Free-form field to enter a custom fully-qualified path and name of license.
Device ID
Registered device to update.
Edit License
To edit an available license, follow the steps mentioned below:
Prerequisites
The devices are already mounted and registered on the domain controller.
Licenses are externally available via a public URL.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Inventory.
2. Click the icon and click Install License to display the license status and configuration.
3. The Inventory page is displayed with the following details under the License Installation Progress menu:
 
Field
Description
Host Name
Assigned name or label generated by the system.
Device
Ipv4 address provided by the user.
Status
Operational status of the device.
Device ID
Serial number of the device.
Device SKU
Software capabilities installed on the device.
Software Type
License type of the device.
License Validity
License status of the device.
Interface
Management interface used for file transfers.
License Path
Fully qualified path name of the file.
4. Click the icon at the end of the device row.
5. In the Edit Table Entry dialog box, add the required details in the following fields:
 
Field
Description
Device
Registered device to update.
Source Interface
Select an interface on the device used for data transfers (within the management VRF). The default is “eth0” interface.
Note: The source interface is used for all selected interfaces.
License Selection
Published Licenses
Licenses available and hosted from a License Repository. The repository is defined in System Management > Preferences.
User Defined
Free-form field to enter a custom fully-qualified path and name of license.
Device ID
Registered device to update.
6. Click Save to copy and save the license on the device.
Configure New Backup
Config Backup can be used to back up Device Configuration for a single device or the entire network.It is used to store the device configurations to be restored at a later date. When a device is backed up, all the configurations are grouped and assigned a label. The label is then used to restore a specifically labeled backup.
To define an immediate backup, click the Action icon to the right of the device row and click Operations > Config Backup. The Config Backup dialog box is displayed. Enter the appropriate information as follows:
Field
 
Description
Device
The device to backup.
Backup Label
A user-defined label to identify the configuration.
Prerequisites
Ensure that the devices are already mounted and registered on the domain controller.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Inventory.
2. Click the icon and click Config Backup to display the backup status and configuration.
The Config Backup Progress menu is displayed with the following information:
Field
Description
Host Name
The Host name or Label.
Device
The device to backup.
Status
Displays the status of the operation. The possible values are:
Pending
Scheduled
In-Progress
Failed
Done
Start Time
Date and time provided by the date-time picker.
Label
The name assigned to the host. The label is N/A if the type is network.
1. Click the icon.
2. In the New Config Backup dialog box, add the required details in the following fields:
 
Field
Description
Device
The device to back up.
Backup Label
A user-defined label to isentify the configuration.
3. Click Save.
4. Click Apply at the bottom of the Config Backup Progress menu to apply and save the changes on the device.
The new backup is configured.
Create/Update Schedule for Backup of Registered Devices
You can schedule a backup of the registered devices.
Prerequisites
The devices are already mounted and registered on the domain controller.
Procedure
1. In the Config Backup Progress menu, click the Create/Update schedule for backup of registered devices icon.
2. The Save Backup Schedule dialog box is displayed. Add the required details in the following fields:
 
Field
Description
Start Time
Use the calendar to schedule a backup.
Recurring
The frequency to schedule a backup. The possible values are:
Daily
Weekly
Monthly
3. Toggle the Active icon to schedule the backup. The icon changes to green color indicating the “Active” status
Note: If there is an active schedule for any of the devices, the status line will display a green status icon.
4. Click Save.
5. In the Inventory page, click Apply to save the changes on the device.
6. In the Inventory page, click Refresh to check the status of the device.
The new schedule is updated.
View Backup History and Formatted Configuration
You can view the backup history and the formatted configuration of the already configured and created backup and backup schedules.
Prerequisites
The devices are already mounted and registered on the domain controller.
Procedure
1. In the Config Backup Progress menu, click the Actions icon to the right of the device details and click History.
The Backup History page is displayed showing the Label and the Backup Time of the already configured backup schedules.
2. Click the icon to view the configuration details of the specific module.
Compare Configuration
The comparing configuration process allows you to compare the configurations of the backup labels of the selected modules.
Prerequisites
The devices are already mounted and registered on the domain controller.
Procedure
1. Under the Config Backup Progress menu, click the Action icon and click Compare.
The Compare Configuration page is displayed.
2. Select the backup labels from the drop-down to compare their configurations.
Configure Restore
Config Restore can be used to back up and restore images for a single device or the entire network.
Note:  
When a device is restored, the previous configuration is removed and replaced with the new set of configurations.
To define a restore, in the Inventory screen, click the Action icon to the right of the device row and click Operations > Config Restore. In the Config Restore dialog box that is displayed, enter the appropriate information as follows:
Field
Description
Device
Registered device to update selected by the user from the drop-down.
Archive
The available labels to restore.
Click Apply to apply the changes.
Prerequisites
The devices are mounted and registered on the domain controller.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Inventory.
2. Click the icon, and then click Config Restore to display the restore status and configuration.
The Inventory page is displayed with the following details under the Config Restore Progress menu:
Field
Description
Host Name
The assigned name or label generated by the system.
Device
The host IP address.
Status
Displays the status of the operation. The possible values are:
Pending
Scheduled
In-Progress
Failed
Done
Start Time
Date and time provided by the date-time picker.
Label
The name assigned to the host. The label is N/A if the type is network.
3. Click the icon.
 
4. In the New Config Restore dialog, add the required details in the following fields:
Field
Description
Device
Registered device to update.
Archive
The available labels to restore.
5. Click Save.
6. Click Apply at the bottom of the Config Restore Progress menu to apply and save the changes on the device.
7. In the Inventory page, click Refresh to check the status of the device.
The new restore is configured.
Action
In the Inventory home page, every device row contains the icon to the right which enables the following actions:
Field
Description
Device information
Contains the basic information about the device such as operational status, port speed, fan, temperature, power, transceiver details etc.
Device Terminal Access
Redirects to the Device Terminal Access page to gain direct access to a shell on any device on the network using a secure connection.
Interfaces
Interface details of the device. The assigned name or label generated by the system.
Operations
Unmount Device
Image Upgrade
Install License
Config Backup
Config Restore
Device Groups
 
To unmount the device
To add a published or user defined image
To install published or user defined license
To apply backup for the device
To apply config restore using the available labels on the device
To assign the device to a group
Monitoring
Device Metric
Chassis Monitoring
Interface Statistics
Device Logs
 
Allows to monitor the resources for the device
Visualization of the hardware metrics for the device
Visualization of the interface for the device
Displays the device log details.
View Topology
This menu is used to represent a topology view of the network based on Link Layer Discovery Protocol (LLDP). The map consists of nodes and edges where each node represents a registered network device and shows connections between each node using bidirectional edges.
The devices that are configured can be viewed in the topology. The LLDP topology is a vendor-neutral link layer protocol used by network devices. It is used for advertising their identity, capabilities, and neighbors on a local area network based on IEEE 802 technology, principally, wired Ethernet. The LLDP topology is configured on the domain controller.
Note: The nodes are initially positioned based on a d3-force algorithm, but each node can be dragged to improve visibility.
The following list describes some of the key features and functionalities:
Field
Description
Toolbar
Displays device link details on an information panel.
Provides options to customize the graph.
Provides access to User Manual.
Manual topology refresh.
Node mouse events
Shift-click to show device details.
Shift-click to show an enlarged view of the nodes.
Right-click to show the sub-menu containing device links.
Node legend
Normal operation.
Fault detected.
View Devices on the Topology Menu
The configured devices are shown on the Topology page as follows:
Prerequisite
Ensure that the configured devices (through the device registration process) are available and connected.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Topology. The Topology page is displayed.
You can view the nodes according to the Alarm and Groups.
2. Click the icon and then hover over the node icon to view the device details. The following details of the selected device are displayed:
 
Field
Description
Details
Host Name
Network node name defined for the topology.
Node ID
Unique identifier for the node.
Software Version
OcNOS version installed on the device.
Software Build
Build details of software installed on the device.
Boot Time
Device boot time.
Time Zone
Time zone for the device boot time.
License Type
License type.
License Status
License status.
License Remaining Days
Number of days for license validity.
Active Alarm Severity
Severity of the active alarm.
Groups
Groups
Shows the group for the selected node, if any.
Customize Nodes and Links of Configured Devices
You can customize nodes and links of the configured devices as follows:
Prerequisite
Ensure that the configured devices (through the device registration process) are available.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Topology.The Topology page is displayed.
2. Click the icon, which allows you to customize the Nodes and Links of the configured devices.
3. Navigate and customize the following details:
Nodes:
Show Node Labels: The names of the nodes in the configured devices. The node labels are shown by default.
Node Label: Sets the node label in topology to Host Name or Node ID.
Links:
Link Thickness (px): Drag to set the stroke-width property to define the thickness of the links or edges.
Curved Lines: Select the checkbox to display links as curved lines.
Link Curve Size: Drag to adjust the shape of the curved lines.
Bidirectional links: Select the checkbox to display the bidirectional links.
Arrow Size: Drag to adjust the size of the arrows.
Arrow Position: Drag to adjust the position of arrows in the links.
4. Click Reset to restore the changes back to default or click Close to apply the changes.
View the Device-level Dashboards
You can view the dashboards from a device level by right-clicking the configured device in the Topology menu.
Prerequisite
Ensure that the configured devices are available.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Topology.The Topology page is displayed.
2. Right-click the configured device, for which you want to see the device-level information. The following details of the device are displayed:
Field
Description
Network Management
Inventory
 
Device Terminal Access
 
Redirects to the Inventory page for information on the devices’ mount transaction.
Redirects to the Device Terminal Access page to gain direct access to a shell on any device on the network using a secure connection.
Network Monitoring
Device Metrics
Chassis Monitoring
Active Alarms
Interface Statistics
Device Logs
 
Allows to monitor the resources for the device
Visualization of the hardware metrics for the device
Displays the active alarms for the device.
Visualization of the interface for the device
Displays the device log details.
Manage Device Terminal Access
Terminals are web-based command-line applications to access the devices from which you can directly connect to the OcNOS device over Secure Shell Protocol (SSH). This is a fully-featured terminal emulator that can be used to gain direct access to a shell on any device on the network using an SSH connection.
Prerequisite
Ensure that the configured devices (through the device registration process) are available.
Procedure
1. In the IP Maestro home page, navigate to Network Management > Device Terminal Access. The Device Terminal Access page is displayed.
2. Click the icon. This allows you to manage the New Connection and Registered Devices as follows:
New Connection:
Host: IP Address/hostname for connecting to the terminal over SSH.
Username: Username for connecting the terminal to a host/device over SSH.
Registered Devices: Select a host from the drop-down menu.
3. Click Connect to view the running configuration.
The OcNOS device is connected. To terminate a session, type exit in the terminal>_ or just click the Close icon on the terminal tab.