[Index]
NetflowSnmpIfXTable resource. The schema will be used to create data/ReporterResource instances, the description is used to store the table name of the associate field.
Model ref.: data/NetflowSnmpIfXTable
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"epochstamp": {
"title": "Epoch Timestamp",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"serverip": {
"title": "Server IP",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"tag": {
"title": "Tag",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"ifname": {
"title": "Interface Name",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"inbound_utilization": {
"title": "Inbound Utilization",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"inbound_throughput_mbps": {
"title": "Inbound Throughput (Mbps)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"outbound_utilization": {
"title": "Outbound Utilization",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"outbound_throughput_mbps": {
"title": "Outbound Throughput (Mbps)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifinmulticastpkts": {
"title": "Inbound Multicast Packets",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifinbroadcastpkts": {
"title": "Inbound Broadcast Packets",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifoutmulticastpkts": {
"title": "Outbound Multicast Packets",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifoutbroadcastpkts": {
"title": "Outbound Broadcast Packets",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhcinoctets": {
"title": "Inbound Octets (High Capacity)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhcinucastpkts": {
"title": "Inbound Unicast Packets (High Capacity)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhcinmulticastpkts": {
"title": "Inbound Multicast Packets (High Capacity)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhcinbroadcastpkts": {
"title": "Inbound Broadcast Packets (High Capacity)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhcoutoctets": {
"title": "Outbound Octets (High Capacity)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhcoutucastpkts": {
"title": "Outbound Unicast Packets (High Capacity)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhcoutmulticastpkts": {
"title": "Outbound Multicast Packets (High Capacity)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhcoutbroadcastpkts": {
"title": "Outbound Broadcast Packets (High Capacity)",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifhighspeed": {
"title": "Interface High Speed",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifindex": {
"title": "Interface Index",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"ifadminstatus": {
"title": "Interface Admin Status",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"ifoperstatus": {
"title": "Interface Operational Status",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"tag_ifname": {
"title": "Tag Interface Name",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"ifindiscards": {
"title": "Inbound Discards",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifinerrors": {
"title": "Inbound Errors",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifinunknownprotos": {
"title": "Inbound Unknown Protocols",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifoutdiscards": {
"title": "Outbound Discards",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifouterrors": {
"title": "Outbound Errors",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifalias": {
"title": "Interface Alias",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"ifdescr": {
"title": "Interface Description",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"iftype": {
"title": "Interface Type",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"ifmtu": {
"title": "Interface MTU",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifspeed": {
"title": "Interface Speed",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
},
"ifphysaddress": {
"title": "Interface Physical Address",
"description": "lxt_hpstack_snmpifxtable",
"type": "string"
},
"ifoutqlen": {
"title": "Outbound Queue Length",
"description": "lxt_hpstack_snmpifxtable",
"type": "number"
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/NetflowSnmpIfXTable/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/NetflowSnmpIfXTable/[pkid1]", "/api/data/NetflowSnmpIfXTable/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/NetflowSnmpIfXTable/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/NetflowSnmpIfXTable/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/NetflowSnmpIfXTable/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/NetflowSnmpIfXTable/ |
|
The data/NetflowSnmpIfXTable schema and all instances as JSON. |
(The list will return 0 to 3 data/NetflowSnmpIfXTable instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "serverip",
"direction": "asc",
"current": "/api/data/NetflowSnmpIfXTable/?skip=0&limit=3&order_by=serverip&direction=asc&traversal=fulltree"
},
"operations": [
"export",
"help",
"update",
"migration",
"get",
"list",
"remove",
"move",
"configuration_template",
"add",
"export_bulkload_template",
"transform",
"bulk_update_form",
"field_display_policy"
],
"meta": {
"model_type": "data/NetflowSnmpIfXTable",
"summary_attrs": [
{
"name": "serverip",
"title": "Server IP"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove"
],
"schema_version": "0.1",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/NetflowSnmpIfXTable/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/NetflowSnmpIfXTable/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/NetflowSnmpIfXTable/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/NetflowSnmpIfXTable/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/NetflowSnmpIfXTable/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/NetflowSnmpIfXTable/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/NetflowSnmpIfXTable. | GET | /api/data/NetflowSnmpIfXTable/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/NetflowSnmpIfXTable as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/NetflowSnmpIfXTable/transform/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/NetflowSnmpIfXTable/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/NetflowSnmpIfXTable/[pkid] | hierarchy=[hierarchy] | The data/NetflowSnmpIfXTable instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/NetflowSnmpIfXTable/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/NetflowSnmpIfXTable. |