NPM Classification APIs v2.0
Created Dec 18, 2020 at 07:09 PM

Resource: hostgroup

This resource deals with Host Group

http://{device}/api/npm.classification/2.0/hostgroups/items/{id}
  • JSON
  • {
      "desc": string,
      "enabled": boolean,
      "hosts": host_list,
      "id": number,
      "in_speed": number,
      "in_speed_unit": speed_unit,
      "member_hostgroups": id_list,
      "member_hostgroups_names": [
        string
      ],
      "name": string,
      "out_speed": number,
      "out_speed_unit": speed_unit,
      <prop>: any
    }
    Property Name Type Description Notes
    hostgroup <object> This resource deals with Host Group
    hostgroup.desc <string> Description of Host Group Optional;
    hostgroup.enabled <boolean> Status of the Host Group - enabled/disabled Optional;
    hostgroup.hosts <host_list> List of hosts(e.g. x.x.x.x, x.x.x.x/prefix), host-ranges(e.g. x.x.x.x-y.y.y.y, x.x.x.x/prefix-y.y.y.y/prefix)
    hostgroup.id <number> Unique ID assigned by the backend Read-only; Optional;
    hostgroup.in_speed <number> Inbound Utilization Optional;
    hostgroup.in_speed_unit <speed_unit> Unit of Network Traffic Speed Values: kbps, Mbps, Gbps;
    hostgroup.member_hostgroups <id_list> List of IDs
    hostgroup.member_hostgroups_names <array of <string>> List of Host Group names Optional;
    hostgroup.member_hostgroups_names[items] <string>
    hostgroup.name <string> Unique name of Host Group Optional;
    hostgroup.out_speed <number> Outbound Utilization Optional;
    hostgroup.out_speed_unit <speed_unit> Unit of Network Traffic Speed Values: kbps, Mbps, Gbps;
    hostgroup.<prop> <any> Optional;

    Resource: hostgroups

    This resource deals with Host Groups

    http://{device}/api/npm.classification/2.0/hostgroups
  • JSON
  • {
      "items": [ hostgroup ],
      <prop>: any
    }
    Property Name Type Description Notes
    hostgroups <object> This resource deals with Host Groups
    hostgroups.items <array of <hostgroup>> Optional;
    hostgroups.items[items] <hostgroup> This resource deals with Host Group
    hostgroups.<prop> <any> Optional;

    Type: bulk_deleter

    Object to trigger bulk deletion of given resource

  • JSON
  • {
      "delete_all": boolean,
      "delete_ids": id_list,
      <prop>: any
    }
    Property Name Type Description Notes
    bulk_deleter <object> Object to trigger bulk deletion of given resource
    bulk_deleter.delete_all <boolean> Delete all objects of the given resource Optional;
    bulk_deleter.delete_ids <id_list> List of IDs
    bulk_deleter.<prop> <any> Optional;

    Type: dpi_list

  • JSON
  • [
      integer
    ]
    Property Name Type Description Notes
    dpi_list <array of <integer>>
    dpi_list[items] <integer>

    Type: host_list

    List of hosts(e.g. x.x.x.x, x.x.x.x/prefix), host-ranges(e.g. x.x.x.x-y.y.y.y, x.x.x.x/prefix-y.y.y.y/prefix)

  • JSON
  • [
      string
    ]
    Property Name Type Description Notes
    host_list <array of <string>> List of hosts(e.g. x.x.x.x, x.x.x.x/prefix), host-ranges(e.g. x.x.x.x-y.y.y.y, x.x.x.x/prefix-y.y.y.y/prefix)
    host_list[items] <string>

    Type: id_list

    List of IDs

  • JSON
  • [
      number
    ]
    Property Name Type Description Notes
    id_list <array of <number>> List of IDs
    id_list[items] <number>

    Type: speed_unit

    Unit of Network Traffic Speed

  • JSON
  • string
    Property Name Type Description Notes
    speed_unit <string> Unit of Network Traffic Speed Values: kbps, Mbps, Gbps;