Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
ContentIndex
  
[+] Expand All
[-] Collapse All

KPI Templates RESTful Web Services

The following operations can be performed using the Edge Services Director KPI Templates Management RESTful Web Services.

Create or Clone a KPI Template

This request is used to clone a template definition to quickly create a new template definition with a new name but same properties. To modify a template definition without disabling templates based upon that definition, first clone the definition, then modify the clone.

URI

/api/sgd/sdgmgmt/kpiTemplate/cloneKPI

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.sdgmgmt.kpiTemplate.
cloneKPI+json;version=1;charset=UTF-8

Consumes

None

Produces

Creates a KPI template

Response Status Code

Message

Description

204 No Content

The server fulfilled the request, but does not need to return a response message body.

Input

Sample JSON Input

{ "KPITemplateTO" : { "ADCKpi" : { "connTableCount" : { "enabled" : false,
              "greenRange" : { "maxVal" : 60,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 80,
                  "minVal" : 61
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 81
                }
            },
          "cpuControlStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 40,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 80,
                  "minVal" : 41
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 81
                }
            },
          "cpuDataStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 69,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 95,
                  "minVal" : 70
                },
              "redRange" : { "maxVal" : 0,
                  "minVal" : 96
                }
            },
          "cpuDatacoreStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 21,
                  "minVal" : 10
                },
              "orangeRange" : { "maxVal" : 9,
                  "minVal" : 6
                },
              "redRange" : { "maxVal" : 5,
                  "minVal" : 1
                }
            },
          "dpAllocationFailure" : { "count" : 1,
              "enabled" : false
            },
          "egressInterfaceStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "enabled" : false,
          "npuAllocationFailure" : { "count" : 1,
              "enabled" : false
            },
          "realServersStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 100,
                  "minVal" : 61
                },
              "orangeRange" : { "maxVal" : 60,
                  "minVal" : 31
                },
              "redRange" : { "maxVal" : 30,
                  "minVal" : 0
                }
            },
          "servicePicStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "vipStatus" : { "count" : 1,
              "enabled" : false
            }
        },
      "CGNATKpi" : { "cpuStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 59,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 80,
                  "minVal" : 60
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 81
                }
            },
          "enabled" : true,
          "memoryStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 100,
                  "minVal" : 61
                },
              "orangeRange" : { "maxVal" : 60,
                  "minVal" : 31
                },
              "redRange" : { "maxVal" : 30,
                  "minVal" : 0
                }
            },
          "natPoolPortUtilizationStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 84,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 95,
                  "minVal" : 85
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 96
                }
            },
          "packetDropStatus" : { "count" : 1,
              "enabled" : false
            },
          "servicePicStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "statefulSyncCPUUtilization" : { "enabled" : true,
              "greenRange" : { "maxVal" : 19,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 29,
                  "minVal" : 20
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 30
                }
            }
        },
      "ChassisKpi" : { "chassisLevelKpi" : { "cpuUtilization" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                },
              "enabled" : false,
              "fanStatus" : { "enabled" : false,
                  "serviceAvailable" : false
                },
              "fruStatus" : { "enabled" : false,
                  "serviceAvailable" : false
                },
              "memoryUtilization" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "powerSupply" : { "enabled" : false,
                  "serviceAvailable" : false
                },
              "temperature" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                }
            },
          "enabled" : false,
          "fpcKpi" : { "buffer" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "cpuUtilization" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                },
              "enabled" : false,
              "memoryUtilization" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "temperature" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                }
            },
          "reKpi" : { "buffer" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "cpuUtilization" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                },
              "enabled" : false,
              "memoryUtilization" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "temperature" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                }
            },
          "servicePicKpi" : { "buffer" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "cpuUtilization" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                },
              "enabled" : false,
              "memoryUtilization" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "packetDropStatus" : { "count" : 1,
                  "enabled" : false
                },
              "temperature" : { "enabled" : false,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                }
            }
        },
      "HAKpi" : { "adcVipRouteStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "bgpAdvertising" : { "count" : 1,
              "enabled" : false
            },
          "cgnatRouteStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "cgnatSfwHaStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "enabled" : false,
          "sdgStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "tlbRoutingInstanceRouteStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "vrrpStatus" : { "count" : 1,
              "enabled" : false
            }
        },
      "SFWKpi" : { "cpuStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 59,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 79,
                  "minVal" : 60
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 80
                }
            },
          "enabled" : false,
          "memoryStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 100,
                  "minVal" : 61
                },
              "orangeRange" : { "maxVal" : 60,
                  "minVal" : 31
                },
              "redRange" : { "maxVal" : 30,
                  "minVal" : 0
                }
            },
          "packetDropStatus" : { "count" : 1,
              "enabled" : false
            },
          "servicePicStatus" : { "enabled" : false,
              "serviceAvailable" : false
            }
        },
      "TLBKpi" : { "cpuStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 59,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 90,
                  "minVal" : 60
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 91
                }
            },
          "egressInterfaceStatus" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "enabled" : false,
          "realServersStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 4,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 30,
                  "minVal" : 5
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 31
                }
            },
          "routingInstanceHopIndex" : { "enabled" : false,
              "serviceAvailable" : false
            },
          "servicePicStatus" : { "enabled" : false,
              "serviceAvailable" : false
            }
        },
      "description" : "CGNAT_statefulSyncCPUUtilization",
      "name" : "CGNAT_statefulSyncCPUUtilization"
    } }

Get All KPI Templates

This request is used to collect all the defined KPI templates.

URI

/api/sgd/sdgmgmt/kpiTemplate/kpitemplatesByVersion
?osVersion=12.1

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.kpiTemplate.
kpitemplatesByVersion?osVersion=12.1
+json;version=1;charset=UTF-8

Consumes

None

Produces

Obtains the defined KPI templates

Response Status Code

Message

Description

200 OK

Successfully retrieved the KPI templates

Output

Sample JSON Output

{ "response" : { "data" : [ { "ADCKpi" : { "connTableCount" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 600,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 800,
                        "minVal" : 601
                      },
                    "redRange" : { "maxVal" : 1000,
                        "minVal" : 801
                      }
                  },
                "cpuControlStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 40,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 80,
                        "minVal" : 41
                      },
                    "redRange" : { "maxVal" : 100,
                        "minVal" : 81
                      }
                  },
                "cpuDatacoreStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 0,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 5,
                        "minVal" : 1
                      },
                    "redRange" : { "maxVal" : 21,
                        "minVal" : 6
                      }
                  },
                "enabled" : true,
                "realServersStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 100,
                        "minVal" : 61
                      },
                    "orangeRange" : { "maxVal" : 60,
                        "minVal" : 31
                      },
                    "redRange" : { "maxVal" : 30,
                        "minVal" : 0
                      }
                  },
                "servicePicStatus" : { "enabled" : true,
                    "serviceAvailable" : false
                  },
                "vipStatus" : { "count" : 0,
                    "enabled" : true
                  }
              },
            "CGNATKpi" : { "cpuStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 59,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 80,
                        "minVal" : 60
                      },
                    "redRange" : { "maxVal" : 100,
                        "minVal" : 81
                      }
                  },
                "enabled" : true,
                "memoryStatus" : { "enabled" : true,
                    "serviceAvailable" : false
                  },
                "natPoolPortUtilizationStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 84,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 95,
                        "minVal" : 85
                      },
                    "redRange" : { "maxVal" : 100,
                        "minVal" : 96
                      }
                  },
                "packetDropStatus" : { "count" : 0,
                    "enabled" : true
                  },
                "servicePicStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  }
              },
            "ChassisKpi" : { "chassisLevelKpi" : { "cpuUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      },
                    "enabled" : true,
                    "fanStatus" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "fruStatus" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "memoryUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "powerSupply" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "temperature" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      }
                  },
                "enabled" : true,
                "fpcKpi" : { "buffer" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "cpuUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      },
                    "enabled" : true,
                    "memoryUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "sdgCardState" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "temperature" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      }
                  },
                "reKpi" : { "buffer" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "cpuUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      },
                    "enabled" : true,
                    "memoryUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "sdgCardState" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "temperature" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      }
                  }
              },
            "HAKpi" : { "adcVipRouteStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "cgnatRouteStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "cgnatSfwHaStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "enabled" : true,
                "iclLinkStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "sdgStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "vrrpStatus" : { "count" : 0,
                    "enabled" : true
                  }
              },
            "MOID" : "net.juniper.jmp.sgd.sdgmgmt.kpiprofile.jpa.KPITemplateEntity:32769",
            "SFWKpi" : { "cpuStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 59,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 79,
                        "minVal" : 60
                      },
                    "redRange" : { "maxVal" : 100,
                        "minVal" : 80
                      }
                  },
                "enabled" : true,
                "memoryStatus" : { "enabled" : true,
                    "serviceAvailable" : false
                  },
                "packetDropStatus" : { "count" : 0,
                    "enabled" : true
                  },
                "servicePicStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  }
              },
            "TLBKpi" : { "enabled" : true,
                "realServersStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 100,
                        "minVal" : 31
                      },
                    "orangeRange" : { "maxVal" : 30,
                        "minVal" : 5
                      },
                    "redRange" : { "maxVal" : 4,
                        "minVal" : 0
                      }
                  },
                "routingInstanceHopIndex" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "servicePicStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  }
              },
            "createdTime" : "2014-11-17T14:12:11+05:30",
            "description" : "System Default Template",
            "isSystemCreated" : true,
            "modifiedTime" : "2014-11-17T14:12:11+05:30",
            "name" : "SystemDefault"
          },
          { "ADCKpi" : { "connTableCount" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 600,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 800,
                        "minVal" : 601
                      },
                    "redRange" : { "maxVal" : 1000,
                        "minVal" : 801
                      }
                  },
                "cpuControlStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 40,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 80,
                        "minVal" : 41
                      },
                    "redRange" : { "maxVal" : 100,
                        "minVal" : 81
                      }
                  },
                "cpuDatacoreStatus" : { "enabled" : false,
                    "greenRange" : { "maxVal" : 0,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 5,
                        "minVal" : 1
                      },
                    "redRange" : { "maxVal" : 21,
                        "minVal" : 6
                      }
                  },
                "enabled" : true,
                "realServersStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 100,
                        "minVal" : 61
                      },
                    "orangeRange" : { "maxVal" : 60,
                        "minVal" : 31
                      },
                    "redRange" : { "maxVal" : 30,
                        "minVal" : 0
                      }
                  },
                "servicePicStatus" : { "enabled" : true,
                    "serviceAvailable" : false
                  },
                "vipStatus" : { "count" : 0,
                    "enabled" : true
                  }
              },
            "CGNATKpi" : { "cpuStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 59,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 80,
                        "minVal" : 60
                      },
                    "redRange" : { "maxVal" : 100,
                        "minVal" : 81
                      }
                  },
                "enabled" : true,
                "memoryStatus" : { "enabled" : true,
                    "serviceAvailable" : false
                  },
                "natPoolPortUtilizationStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 84,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 95,
                        "minVal" : 85
                      },
                    "redRange" : { "maxVal" : 100,
                        "minVal" : 96
                      }
                  },
                "packetDropStatus" : { "count" : 0,
                    "enabled" : true
                  },
                "servicePicStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  }
              },
            "ChassisKpi" : { "chassisLevelKpi" : { "cpuUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      },
                    "enabled" : true,
                    "fanStatus" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "fruStatus" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "memoryUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "powerSupply" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "temperature" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      }
                  },
                "enabled" : true,
                "fpcKpi" : { "buffer" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "cpuUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      },
                    "enabled" : true,
                    "memoryUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "sdgCardState" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "temperature" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      }
                  },
                "reKpi" : { "buffer" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "cpuUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      },
                    "enabled" : true,
                    "memoryUtilization" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 89,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 90
                          }
                      },
                    "sdgCardState" : { "enabled" : true,
                        "serviceAvailable" : true
                      },
                    "temperature" : { "enabled" : true,
                        "greenRange" : { "maxVal" : 79,
                            "minVal" : 0
                          },
                        "orangeRange" : { "maxVal" : 94,
                            "minVal" : 80
                          },
                        "redRange" : { "maxVal" : 100,
                            "minVal" : 95
                          }
                      }
                  }
              },
            "HAKpi" : { "adcVipRouteStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "cgnatRouteStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "cgnatSfwHaStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "enabled" : true,
                "iclLinkStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "sdgStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "vrrpStatus" : { "count" : 0,
                    "enabled" : true
                  }
              },
            "MOID" : "net.juniper.jmp.sgd.sdgmgmt.kpiprofile.jpa.KPITemplateEntity:37479",
            "SFWKpi" : { "cpuStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 59,
                        "minVal" : 0
                      },
                    "orangeRange" : { "maxVal" : 79,
                        "minVal" : 60
                      },
                    "redRange" : { "maxVal" : 100,
                        "minVal" : 80
                      }
                  },
                "enabled" : true,
                "memoryStatus" : { "enabled" : true,
                    "serviceAvailable" : false
                  },
                "packetDropStatus" : { "count" : 0,
                    "enabled" : true
                  },
                "servicePicStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  }
              },
            "TLBKpi" : { "enabled" : true,
                "realServersStatus" : { "enabled" : true,
                    "greenRange" : { "maxVal" : 100,
                        "minVal" : 31
                      },
                    "orangeRange" : { "maxVal" : 30,
                        "minVal" : 5
                      },
                    "redRange" : { "maxVal" : 4,
                        "minVal" : 0
                      }
                  },
                "routingInstanceHopIndex" : { "enabled" : true,
                    "serviceAvailable" : true
                  },
                "servicePicStatus" : { "enabled" : true,
                    "serviceAvailable" : true
                  }
              },
            "createdBy" : "super",
            "createdTime" : "2014-11-19T09:39:10+05:30",
            "description" : "TestKpi",
            "isSystemCreated" : false,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-19T09:39:10+05:30",
            "name" : "TestKpi"
          }
        ],
      "schemaName" : "KPITemplateTO",
      "success" : true,
      "totalRows" : 2
    } }

Get SDGs Associated With a KPI Template

This request is used to collect all the SDG devices that are mapped with a KPI template.

URI

/api/sgd/sdgmgmt/kpiTemplate/associatedSDGs

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.kpiTemplate.
associatedSDGs+json;version=1;charset=UTF-8

Consumes

None

Produces

Obtains the SDGs associated with KPI templates

Response Status Code

Message

Description

200 OK

Successfully retrieved the SDGs associated with KPI templates

Input

Sample JSON Input

<Kpi template Name > 

Output

Sample JSON Output

true if any  associated and false if no SDG is associated

Get All KPI Template Statistics

This request is used to collect all the defined KPI template statistical details, regardless of whether they are applied or associated with an SDG device.

URI

/api/sgd/sdgmgmt/kpiTemplate/kpitemplatestatistics

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.kpiTemplate.
kpitemplatestatistics+json;version=1;charset=UTF-8

Consumes

None

Produces

Obtains the defined KPI template statistics

Response Status Code

Message

Description

200 OK

Successfully retrieved the KPI template statistics

Output

Sample JSON Output

[ { "SGDStatisticTO" : { "data" : 2,
        "name" : "ADC"
      } },
  { "SGDStatisticTO" : { "data" : 2,
        "name" : "TLB"
      } },
  { "SGDStatisticTO" : { "data" : 2,
        "name" : "CGNAT"
      } },
  { "SGDStatisticTO" : { "data" : 2,
        "name" : "SFW"
      } },
  { "SGDStatisticTO" : { "data" : 2,
        "name" : "CHASSIS"
      } },
  { "SGDStatisticTO" : { "data" : 2,
        "name" : "HA"
      } }
]

Get KPI Template Statistics Associated with Devices Only

This request is used to collect the statistical details of only KPI templates associated with an SDG device.

URI

/api/sgd/sdgmgmt/kpiTemplate/associatedkpitemplatestatistics

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.kpiTemplate.
associatedkpitemplatestatistics+json;version=1;charset=UTF-8

Consumes

None

Produces

Obtains the defined KPI template statistics associated with SDGs.

Response Status Code

Message

Description

200 OK

Successfully retrieved the KPI template statistics associated with SDGs.

Output

Sample JSON Output

[ { "SGDStatisticTO" : { "data" : 1,
        "name" : "Used"
      } },
  { "SGDStatisticTO" : { "data" : 1,
        "name" : "UnUsed"
      } }
]

Modify a KPI Template

This request is used to edit a previously created KPI template.

URI

/api/sgd/sdgmgmt/kpiTemplate/editKPI

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.kpitemplate.
editKPI+json;version=1;charset=UTF-8

Consumes

None

Produces

Modifies an existing KPI template

Response Status Code

Message

Description

204 No Content

The server fulfilled the request, but does not need to return a response message body.

Input

Sample JSON Input

{ "KPITemplateTO" : { "ADCKpi" : { "connTableCount" : { "enabled" : false,
              "greenRange" : { "maxVal" : 60,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 80,
                  "minVal" : 61
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 81
                }
            },
          "cpuControlStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 40,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 80,
                  "minVal" : 41
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 81
                }
            },
          "cpuDataStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 69,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 95,
                  "minVal" : 70
                },
              "redRange" : { "maxVal" : 0,
                  "minVal" : 96
                }
            },
          "cpuDatacoreStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 21,
                  "minVal" : 10
                },
              "orangeRange" : { "maxVal" : 9,
                  "minVal" : 6
                },
              "redRange" : { "maxVal" : 5,
                  "minVal" : 1
                }
            },
          "dpAllocationFailure" : { "count" : 1,
              "enabled" : true
            },
          "egressInterfaceStatus" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "enabled" : true,
          "npuAllocationFailure" : { "count" : 1,
              "enabled" : true
            },
          "realServersStatus" : { "enabled" : false,
              "greenRange" : { "maxVal" : 100,
                  "minVal" : 61
                },
              "orangeRange" : { "maxVal" : 60,
                  "minVal" : 31
                },
              "redRange" : { "maxVal" : 30,
                  "minVal" : 0
                }
            },
          "servicePicStatus" : { "enabled" : true,
              "serviceAvailable" : false
            },
          "vipStatus" : { "count" : 1,
              "enabled" : true
            }
        },
      "CGNATKpi" : { "cpuStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 59,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 80,
                  "minVal" : 60
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 81
                }
            },
          "enabled" : true,
          "memoryStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 100,
                  "minVal" : 61
                },
              "orangeRange" : { "maxVal" : 60,
                  "minVal" : 31
                },
              "redRange" : { "maxVal" : 30,
                  "minVal" : 0
                }
            },
          "natPoolPortUtilizationStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 84,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 95,
                  "minVal" : 85
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 96
                }
            },
          "packetDropStatus" : { "count" : 1,
              "enabled" : true
            },
          "servicePicStatus" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "statefulSyncCPUUtilization" : { "enabled" : true,
              "greenRange" : { "maxVal" : 19,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 29,
                  "minVal" : 20
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 30
                }
            }
        },
      "ChassisKpi" : { "chassisLevelKpi" : { "cpuUtilization" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                },
              "enabled" : true,
              "fanStatus" : { "enabled" : true,
                  "serviceAvailable" : true
                },
              "fruStatus" : { "enabled" : true,
                  "serviceAvailable" : true
                },
              "memoryUtilization" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "powerSupply" : { "enabled" : true,
                  "serviceAvailable" : true
                },
              "temperature" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                }
            },
          "enabled" : true,
          "fpcKpi" : { "buffer" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "cpuUtilization" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                },
              "enabled" : true,
              "memoryUtilization" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "temperature" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                }
            },
          "reKpi" : { "buffer" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "cpuUtilization" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                },
              "enabled" : true,
              "memoryUtilization" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "temperature" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                }
            },
          "servicePicKpi" : { "buffer" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "cpuUtilization" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                },
              "enabled" : true,
              "memoryUtilization" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 89,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 90
                    }
                },
              "packetDropStatus" : { "count" : 1,
                  "enabled" : true
                },
              "temperature" : { "enabled" : true,
                  "greenRange" : { "maxVal" : 79,
                      "minVal" : 0
                    },
                  "orangeRange" : { "maxVal" : 94,
                      "minVal" : 80
                    },
                  "redRange" : { "maxVal" : 100,
                      "minVal" : 95
                    }
                }
            }
        },
      "HAKpi" : { "adcVipRouteStatus" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "bgpAdvertising" : { "count" : 1,
              "enabled" : true
            },
          "cgnatRouteStatus" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "cgnatSfwHaStatus" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "enabled" : true,
          "sdgStatus" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "tlbRoutingInstanceRouteStatus" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "vrrpStatus" : { "count" : 1,
              "enabled" : true
            }
        },
      "MOID" : "net.juniper.jmp.sgd.shared.sdgmgmt.kpiprofile.KPITemplateMO:463358",
      "SFWKpi" : { "cpuStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 59,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 79,
                  "minVal" : 60
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 80
                }
            },
          "enabled" : true,
          "memoryStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 100,
                  "minVal" : 61
                },
              "orangeRange" : { "maxVal" : 60,
                  "minVal" : 31
                },
              "redRange" : { "maxVal" : 30,
                  "minVal" : 0
                }
            },
          "packetDropStatus" : { "count" : 1,
              "enabled" : true
            },
          "servicePicStatus" : { "enabled" : true,
              "serviceAvailable" : true
            }
        },
      "TLBKpi" : { "cpuStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 59,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 90,
                  "minVal" : 60
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 91
                }
            },
          "egressInterfaceStatus" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "enabled" : true,
          "realServersStatus" : { "enabled" : true,
              "greenRange" : { "maxVal" : 4,
                  "minVal" : 0
                },
              "orangeRange" : { "maxVal" : 30,
                  "minVal" : 5
                },
              "redRange" : { "maxVal" : 100,
                  "minVal" : 31
                }
            },
          "routingInstanceHopIndex" : { "enabled" : true,
              "serviceAvailable" : true
            },
          "servicePicStatus" : { "enabled" : true,
              "serviceAvailable" : true
            }
        },
      "description" : "ADC",
      "name" : "ADC"
    } }

Delete a KPI Template

This request is used to delete a previously created KPI template.

URI

/api/sgd/sdgmgmt/kpiTemplate/deleteKPI

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.kpitemplate.
deleteKPI+json;version=1;charset=UTF-8

Consumes

None

Produces

Deletes an existing a KPI template

Response Status Code

Message

Description

204 No Content

The server fulfilled the request, but does not need to return a response message body.

Input

Sample JSON Input

net.juniper.jmp.sgd.shared.sdgmgmt.kpiprofile.KPITemplateMO:463358

Associate KPI Templates With SDG Devices

This request is used to associate a KPI template with a device.

URI

/api/sgd/sdgmgmt/sdgmanagement/modifysdg

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.sdgmanagement.
modifysdg+json;version=1;charset=UTF-8

Consumes

None

Produces

Assigns a KPI template to a device

Response Status Code

Message

Description

204 No Content

The server fulfilled the request, but does not need to return a response message body.

Input

Sample JSON Input

{ "kpiBaseTemplate" : "ADC_cpuDataStatus",
  "sdgGroupTemplate" : "soumen",
  "sdgID" : "net.juniper.jmp.sgd.discovery.inventory.device.datamodel.SDGMO:754038"
}

Modified: 2016-08-02