Create widget for IP page custom title

Overview

Configure a custom title for the IP page to display one or more widgets that are attached to the IP and the currently selected IP Version.

Custom title widgets for the IP page must be enabled by an Admin.

Considerations

• Use the CLI to add, edit, and delete widgets that are used for custom titles.

• Use the IP title drop-down to expand or collapse the custom title.

• Custom title content can occupy four grid rows before it scrolls vertically. If the content is less than four grid rows, the height of the content is shrunk appropriately.

• The visibility of the custom title is remembered between:

  • IP page leave/return

  • IP page refresh

  • Login sessions

Before you begin

Before you create a custom title widget using the CLI, it is helpful to prototype the type of widget you want to create using the Widget Editor. Once you are satisfied with how your widget looks, use the JSON generated by the Widget Editor in the command line procedure to create your custom title widget.

Assign widget to the IP page custom title from CLI

Assign a widget to an IP or IPV using CLI:

1. Run the following command

   Copy

   1
   pi attr set <IP/V FQN> <widget-name> --file <path-to-widget-JSON>

   
   

2. Set the “dashboard” property in the JSON:

   Copy

   1
   "dashboard": "ip-title"

Example JSON

The below is an example of a pie chart that will be displayed in the custom title.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
   "display": "pie",
   "dashboard": "ip-title",
   "placement": [0,0,3,3],
   "config": {
       "title": "Custom Title Pie Chart"
   },
   "data": [
       {
           "name": "label1",
           "data": 12
       },
       {
           "name": "label2",
           "data": 20,
           "color": "darkgreen"
       },
       {
           "name": "label3",
           "data": 50
       }
   ]
}