[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Get Mnr Metadata Mapping
DescriptionGet Mnr mappings for all packages
Request
URLURL
https://{api_host}tcsa.host.com/v1/Mnrgateway/mappings
Query Parameters
Query Parameters
boolean
enabled
Optional
If set to true only mapping documents with enabled set true will be fetched
enabled example
false
string
type
Optional
Type of mapping {event/metrics}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
object
of type application/json
{
"Netflow": {
"Netflow": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"AZ_BYTES": "AZ_BYTES",
"AZ_PACKETS": "AZ_PACKETS",
"BYTES": "BYTES",
"BYTESIN": "BYTESIN",
"BYTESOUT": "BYTESOUT",
"FLOW_COUNT": "FLOW_COUNT",
"MINUS_X": "MINUS_X",
"MINUS_Y": "MINUS_Y",
"MINUS_Z": "MINUS_Z",
"PACKETS": "PACKETS",
"PACKETSIN": "PACKETSIN",
"PACKETSOUT": "PACKETSOUT",
"ZA_BYTES": "ZA_BYTES",
"ZA_PACKETS": "ZA_PACKETS"
},
"mappedProps": {
"APPLICATION_CLASS": "properties.APPLICATION_CLASS",
"APPLICATION_CRITICALITY": "properties.APPLICATION_CRITICALITY",
"APPLICATION_DESC": "properties.APPLICATION_DESC",
"APPLICATION_ID": "properties.APPLICATION_ID",
"APPLICATION_NAME": "properties.APPLICATION_NAME",
"APPLICATION_TYPE": "properties.APPLICATION_TYPE",
"A_ADDR": "properties.A_ADDR",
"A_IF_SNMP": "properties.A_IF_SNMP",
"A_IF_SNMP_NAME": "properties.A_IF_SNMP_NAME",
"A_PORT": "properties.A_PORT",
"DIRECTION": "properties.DIRECTION",
"DSCP": "properties.DSCP",
"DSCP_ECN": "properties.DSCP_ECN",
"DST_ADDR": "properties.DST_ADDR",
"DST_AS": "properties.DST_AS",
"DST_MASK": "properties.DST_MASK",
"DST_PORT": "properties.DST_PORT",
"DURATION": "properties.DURATION",
"FIRST_SWITCHED": "properties.FIRST_SWITCHED",
"FLOW_SEQUENCE": "properties.FLOW_SEQUENCE",
"HOST_ADDR": "properties.entityName",
"HOST_NAME": "properties.HOST_NAME",
"HOST_PORT": "properties.HOST_PORT",
"INPUT_SNMP": "properties.INPUT_SNMP",
"INPUT_SNMP_NAME": "properties.INPUT_SNMP_NAME",
"INTERFACE": "properties.INTERFACE",
"IPV4_DST_ADDR": "properties.IPV4_DST_ADDR",
"IPV4_DST_NET": "properties.IPV4_DST_NET",
"IPV4_NEXT_HOP": "properties.IPV4_NEXT_HOP",
"IPV4_SRC_ADDR": "properties.IPV4_SRC_ADDR",
"IPV4_SRC_NET": "properties.IPV4_SRC_NET",
"L4_DST_PORT": "properties.L4_DST_PORT",
"L4_SRC_PORT": "properties.L4_SRC_PORT",
"LAST_SWITCHED": "properties.LAST_SWITCHED",
"OUTPUT_SNMP": "properties.OUTPUT_SNMP",
"OUTPUT_SNMP_NAME": "properties.OUTPUT_SNMP_NAME",
"PORT": "properties.PORT",
"PROTOCOL": "properties.source",
"REMOTE_PORT": "properties.REMOTE_PORT",
"ROUTER_SRC": "properties.deviceName",
"ROUTER_SRC_NAME": "properties.ROUTER_SRC_NAME",
"SNMP_NAME": "properties.SNMP_NAME",
"SOURCE_ID": "properties.SOURCE_ID",
"SRC_ADDR": "properties.SRC_ADDR",
"SRC_AS": "properties.SRC_AS",
"SRC_MASK": "properties.SRC_MASK",
"SRC_PORT": "properties.SRC_PORT",
"STREAM": "properties.entityType",
"TCP_FLAGS": "properties.TCP_FLAGS",
"TOS": "properties.TOS",
"TOS_REST": "properties.TOS_REST",
"Z_ADDR": "properties.Z_ADDR",
"Z_IF_SNMP": "properties.Z_IF_SNMP",
"Z_IF_SNMP_NAME": "properties.Z_IF_SNMP_NAME",
"Z_PORT": "properties.Z_PORT",
"eventId": "properties.eventId",
"eventTmst": "timestamp",
"source": "instance",
"unitFLOW_COUNT": "properties.unitFLOW_COUNT"
},
"staticPropDefn": {
"deviceType": "Router",
"metricType": "Netflow-mnr",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway-events"
}
},
"metadata": {
"description": "Netflow",
"enabled": false,
"keys": [
"source"
],
"metricMapDefn": {
"unit": "unit{METRICNAME}"
},
"type": "event"
}
},
"VMWareCollector": {
"Datastore:Datastore": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Capacity": "Capacity",
"FreeCapacity": "FreeCapacity",
"Uncommitted": "Uncommitted"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Storage",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"DistributedVirtualSwitch": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"deviceid": "properties.entityName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Availability",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"DistributedVirtualSwitch:DVPortGroup": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Availability",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"deviceid": "properties.entityName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Availability",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:Datastore": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Storage",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:Disk": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability",
"Capacity": "Capacity",
"Latency": "Latency",
"QueueLatency": "QueueLatency",
"ReadLatency": "ReadLatency",
"ReadRequests": "ReadRequests",
"ReadThroughput": "ReadThroughput",
"WriteLatency": "WriteLatency",
"WriteRequests": "WriteRequests",
"WriteThroughput": "WriteThroughput"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Storage",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:DiskPath": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability",
"Reachability": "Reachability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Availability",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:Interface": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability",
"Received": "Received",
"Throughput": "Throughput",
"Transmitted": "Transmitted"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"ip": "properties.ip",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "NetworkAdapter",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:Memory": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Active": "Active",
"Balloon": "Balloon",
"CurrentUtilization": "CurrentUtilization",
"Granted": "Granted",
"Shared": "Shared",
"SharedCommon": "SharedCommon",
"SwapIn": "SwapIn",
"SwapOut": "SwapOut",
"SwapUsed": "SwapUsed",
"TotalMemory": "TotalMemory"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Memory",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:Multipath": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Availability",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:Port": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability",
"IORead": "IORead",
"IOWrite": "IOWrite",
"ReadLatency": "ReadLatency",
"ReadThroughput": "ReadThroughput",
"WriteLatency": "WriteLatency",
"WriteThroughput": "WriteThroughput"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "NetworkAdapter",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:PortGroup": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Reachability": "Reachability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Availability",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:Processor": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"CurrentUtilization": "CurrentUtilization",
"ProcessorSize": "ProcessorSize",
"UsageMHz": "UsageMHz"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Processor",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:VirtualNic": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"ip": "properties.ip",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Availability",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"Hypervisor:VirtualSwitch": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Availability",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability",
"CurrentSnapshot": "CurrentSnapshot",
"RemoveMeZero": "RemoveMeZero",
"TotalDisk": "TotalDisk",
"Uptime": "Uptime"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"deviceid": "properties.entityName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"ip": "properties.ip",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "VirtualMachine",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine:Datastore": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"UsedCapacity": "UsedCapacity"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Storage",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine:Disk": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"ReadRequests": "ReadRequests",
"ReadThroughput": "ReadThroughput",
"Throughput": "Throughput",
"WriteRequests": "WriteRequests",
"WriteThroughput": "WriteThroughput"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Storage",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine:File": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Capacity": "Capacity",
"PresentedCapacity": "PresentedCapacity",
"UsedCapacity": "UsedCapacity"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Storage",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine:FileSystem": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Capacity": "Capacity",
"FreeCapacity": "FreeCapacity",
"UsedCapacity": "UsedCapacity"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Storage",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine:Interface": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Availability": "Availability",
"Received": "Received",
"Throughput": "Throughput",
"Transmitted": "Transmitted"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"ip": "properties.ip",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "NetworkAdapter",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine:Memory": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Active": "Active",
"Balloon": "Balloon",
"Consumed": "Consumed",
"CurrentUtilization": "CurrentUtilization",
"Overhead": "Overhead",
"SwapIn": "SwapIn",
"SwapOut": "SwapOut",
"TotalMemory": "TotalMemory"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Memory",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine:Processor": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"CurrentUtilization": "CurrentUtilization",
"Ready": "Ready",
"UsageMHz": "UsageMHz"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Processor",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"VirtualMachine:Virtual Disk": {
"discardedMetrics": [],
"discardedProps": [],
"mappedMetrics": {
"Capacity": "Capacity",
"PresentedCapacity": "PresentedCapacity",
"ReadLatency": "ReadLatency",
"ReadRequests": "ReadRequests",
"ReadThroughput": "ReadThroughput",
"WriteLatency": "WriteLatency",
"WriteRequests": "WriteRequests",
"WriteThroughput": "WriteThroughput"
},
"mappedProps": {
"customer": "tags.customer",
"device": "properties.deviceName",
"devtype": "properties.deviceType",
"hostname": "tags.hostname",
"hypervsr": "tags.hypervsr",
"part": "properties.entityName",
"parttype": "properties.entityType",
"source": "instance",
"vcenter": "properties.dataSource"
},
"staticPropDefn": {
"metricType": "Storage",
"processedTimestamp": "{TIMESTAMP_MS}",
"type": "mnrgateway"
}
},
"metadata": {
"description": "VMWareCollector",
"enabled": true,
"keys": [
"devtype",
"parttype"
],
"metricMapDefn": {
"metricDataType": "float",
"name": "metrics.$name",
"unit": "metrics.$name.unit"
},
"type": "metric"
}
}
}
Errors
object
400
Invalid Request sent by the user
object
401
User authentication failed
object
403
Access to the requested resource/operation is forbidden
object
404
Cannot find requested resource
object
500
Internal server error
Code Samples
cURL Command
curl https://{api_host}tcsa.host.com/v1/Mnrgateway/mappings
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance