rwmon - User documentation

Schema Globals

Global Schema Type
rw_ypbc_Rwmon_Rwmon_t_schema
Global Schema Pointer
rw_ypbc_Rwmon_Rwmon_g_schema

rwmon data

rwmon:nfvi-metrics

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics
XPath Keyed Path
/rwmon:nfvi-metrics
RW.REST URI Path
/rwmon:nfvi-metrics

Fields
NameTypeDescription
timestampDECIMAL64This is the time when the metric was captured. The timestamp is represented as the number of seconds since the beginning of the Unix epoch.
vcpuCONTAINER
memoryCONTAINER
storageCONTAINER
external-portsCONTAINER
internal-portsCONTAINER
networkCONTAINER

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:vcpu

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics/rwmon:vcpu
XPath Keyed Path
/rwmon:nfvi-metrics/rwmon:vcpu
RW.REST URI Path
/rwmon:nfvi-metrics/vcpu

Fields
NameTypeDescription
labelSTRINGLabel to show in UI
totalUINT64The total number of VCPUs available.
utilizationDECIMAL64The VCPU utilization (percentage).

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:memory

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics/rwmon:memory
XPath Keyed Path
/rwmon:nfvi-metrics/rwmon:memory
RW.REST URI Path
/rwmon:nfvi-metrics/memory

Fields
NameTypeDescription
labelSTRINGLabel to show in UI
usedUINT64The amount of memory (bytes) currently in use.
totalUINT64The amount of memory (bytes) available.
utilizationDECIMAL64The memory utilization (percentage).

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:storage

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics/rwmon:storage
XPath Keyed Path
/rwmon:nfvi-metrics/rwmon:storage
RW.REST URI Path
/rwmon:nfvi-metrics/storage

Fields
NameTypeDescription
labelSTRINGLabel to show in UI
usedUINT64The amount of storage (bytes) currently in use.
totalUINT64The amount of storage (bytes) available.
utilizationDECIMAL64The storage utilization (percentage).

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:external-ports

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics/rwmon:external-ports
XPath Keyed Path
/rwmon:nfvi-metrics/rwmon:external-ports
RW.REST URI Path
/rwmon:nfvi-metrics/external-ports

Fields
NameTypeDescription
labelSTRINGLabel to show in UI
totalUINT64The total number of external ports.

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:internal-ports

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics/rwmon:internal-ports
XPath Keyed Path
/rwmon:nfvi-metrics/rwmon:internal-ports
RW.REST URI Path
/rwmon:nfvi-metrics/internal-ports

Fields
NameTypeDescription
labelSTRINGLabel to show in UI
totalUINT64The total number of internal ports.

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:network

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics/rwmon:network
XPath Keyed Path
/rwmon:nfvi-metrics/rwmon:network
RW.REST URI Path
/rwmon:nfvi-metrics/network

Fields
NameTypeDescription
labelSTRINGLabel to show in UI
incomingCONTAINER
outgoingCONTAINER

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:incoming

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics/rwmon:network/rwmon:incoming
XPath Keyed Path
/rwmon:nfvi-metrics/rwmon:network/rwmon:incoming
RW.REST URI Path
/rwmon:nfvi-metrics/network/incoming

Fields
NameTypeDescription
labelSTRINGLabel to show in UI
bytesUINT64The cumulative number of incoming bytes.
packetsUINT64The cumulative number of incoming packets.
byte-rateDECIMAL64The current incoming byte-rate (bytes per second).
packet-rateDECIMAL64The current incoming packet (packets per second).

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:outgoing

Key Identifiers:
XPath Path
/rwmon:nfvi-metrics/rwmon:network/rwmon:outgoing
XPath Keyed Path
/rwmon:nfvi-metrics/rwmon:network/rwmon:outgoing
RW.REST URI Path
/rwmon:nfvi-metrics/network/outgoing

Fields
NameTypeDescription
labelSTRINGLabel to show in UI
bytesUINT64The cumulative number of outgoing bytes.
packetsUINT64The cumulative number of outgoing packets.
byte-rateDECIMAL64The current outgoing byte-rate (bytes per second).
packet-rateDECIMAL64The current outgoing packet (packets per second).

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:alarm

Key Identifiers:
XPath Path
/rwmon:alarm
XPath Keyed Path
/rwmon:alarm
RW.REST URI Path
/rwmon:alarm

Fields
NameTypeDescription
alarm-idSTRINGThis field is reserved for the identifier assigned by the VIM provider
nameSTRINGA human readable string to identify the alarm
descriptionSTRINGA description of this alarm
vdur-idSTRINGThe identifier of the VDUR that the alarm is associated with
actionsCONTAINER
repeatBOOLEANThis flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed.
enabledBOOLEANThis flag indicates whether the alarm has been enabled or disabled.
severityENUMA measure of the importance or urgency of the alarm
metricENUMThe metric to be tracked by this alarm.
statisticENUMThe type of metric statistic that is tracked by this alarm
operationENUMThe relational operator used to define whether an alarm should be triggered in certain scenarios, such as if the metric statistic goes above or below a specified value.
valueDECIMAL64This value defines the threshold that, if crossed, will trigger the alarm.
periodUINT32The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic.
evaluationsUINT32Defines the length of time (seconds) in which metric data are collected in order to evaluate the chosen statistic.

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:actions

Key Identifiers:
XPath Path
/rwmon:alarm/rwmon:actions
XPath Keyed Path
/rwmon:alarm/rwmon:actions
RW.REST URI Path
/rwmon:alarm/actions

Fields
NameTypeDescription
okLIST
insufficient-dataLIST
alarmLIST

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:ok

Key Identifiers:
XPath Path
/rwmon:alarm/rwmon:actions/rwmon:ok
XPath Keyed Path
/rwmon:alarm/rwmon:actions/rwmon:ok[rwmon:url='STRING']
RW.REST URI Path
/rwmon:alarm/actions/ok/STRING

Fields
NameTypeDescription
urlSTRING

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:insufficient-data

Key Identifiers:
XPath Path
/rwmon:alarm/rwmon:actions/rwmon:insufficient-data
XPath Keyed Path
/rwmon:alarm/rwmon:actions/rwmon:insufficient-data[rwmon:url='STRING']
RW.REST URI Path
/rwmon:alarm/actions/insufficient-data/STRING

Fields
NameTypeDescription
urlSTRING

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

rwmon:alarm

Key Identifiers:
XPath Path
/rwmon:alarm/rwmon:actions/rwmon:alarm
XPath Keyed Path
/rwmon:alarm/rwmon:actions/rwmon:alarm[rwmon:url='STRING']
RW.REST URI Path
/rwmon:alarm/actions/alarm/STRING

Fields
NameTypeDescription
urlSTRING

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample