rwmon - Programmers API Reference
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics |
| Python Proto-GI Type | RwmonYang.NfviMetrics |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics Rwmon_data_NfviMetrics Rwmon_NfviMetrics |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics |
Fields
| Name | Type | Description |
|---|---|---|
| timestamp | DECIMAL64 | This is the time when the metric was captured. The timestamp is represented as the number of seconds since the beginning of the Unix epoch. |
| vcpu | CONTAINER | |
| memory | CONTAINER | |
| storage | CONTAINER | |
| external-ports | CONTAINER | |
| internal-ports | CONTAINER | |
| network | CONTAINER |
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics/rwmon:vcpu |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics/rwmon:vcpu |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics.Vcpu |
| Python Proto-GI Type | RwmonYang.NfviMetrics_Vcpu |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics__Vcpu |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics_Vcpu Rwmon_data_NfviMetrics_Vcpu Rwmon_NfviMetrics_Vcpu |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics_Vcpu |
Fields
| Name | Type | Description |
|---|---|---|
| label | STRING | Label to show in UI |
| total | UINT64 | The total number of VCPUs available. |
| utilization | DECIMAL64 | The VCPU utilization (percentage). |
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics/rwmon:memory |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics/rwmon:memory |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics.Memory |
| Python Proto-GI Type | RwmonYang.NfviMetrics_Memory |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics__Memory |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics_Memory Rwmon_data_NfviMetrics_Memory Rwmon_NfviMetrics_Memory |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics_Memory |
Fields
| Name | Type | Description |
|---|---|---|
| label | STRING | Label to show in UI |
| used | UINT64 | The amount of memory (bytes) currently in use. |
| total | UINT64 | The amount of memory (bytes) available. |
| utilization | DECIMAL64 | The memory utilization (percentage). |
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics/rwmon:storage |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics/rwmon:storage |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics.Storage |
| Python Proto-GI Type | RwmonYang.NfviMetrics_Storage |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics__Storage |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics_Storage Rwmon_data_NfviMetrics_Storage Rwmon_NfviMetrics_Storage |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics_Storage |
Fields
| Name | Type | Description |
|---|---|---|
| label | STRING | Label to show in UI |
| used | UINT64 | The amount of storage (bytes) currently in use. |
| total | UINT64 | The amount of storage (bytes) available. |
| utilization | DECIMAL64 | The storage utilization (percentage). |
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics/rwmon:external-ports |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics/rwmon:external-ports |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics.ExternalPorts |
| Python Proto-GI Type | RwmonYang.NfviMetrics_ExternalPorts |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics__ExternalPorts |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics_ExternalPorts Rwmon_data_NfviMetrics_ExternalPorts Rwmon_NfviMetrics_ExternalPorts |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics_ExternalPorts |
Fields
| Name | Type | Description |
|---|---|---|
| label | STRING | Label to show in UI |
| total | UINT64 | The total number of external ports. |
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics/rwmon:internal-ports |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics/rwmon:internal-ports |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics.InternalPorts |
| Python Proto-GI Type | RwmonYang.NfviMetrics_InternalPorts |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics__InternalPorts |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics_InternalPorts Rwmon_data_NfviMetrics_InternalPorts Rwmon_NfviMetrics_InternalPorts |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics_InternalPorts |
Fields
| Name | Type | Description |
|---|---|---|
| label | STRING | Label to show in UI |
| total | UINT64 | The total number of internal ports. |
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics/rwmon:network |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics/rwmon:network |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics.Network |
| Python Proto-GI Type | RwmonYang.NfviMetrics_Network |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics__Network |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics_Network Rwmon_data_NfviMetrics_Network Rwmon_NfviMetrics_Network |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics_Network |
Fields
| Name | Type | Description |
|---|---|---|
| label | STRING | Label to show in UI |
| incoming | CONTAINER | |
| outgoing | CONTAINER |
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics/rwmon:network/rwmon:incoming |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics/rwmon:network/rwmon:incoming |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics.Network.Incoming |
| Python Proto-GI Type | RwmonYang.NfviMetrics_Network_Incoming |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics__Network__Incoming |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics_Network_Incoming Rwmon_data_NfviMetrics_Network_Incoming Rwmon_NfviMetrics_Network_Incoming |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics_Network_Incoming |
Fields
| Name | Type | Description |
|---|---|---|
| label | STRING | Label to show in UI |
| bytes | UINT64 | The cumulative number of incoming bytes. |
| packets | UINT64 | The cumulative number of incoming packets. |
| byte-rate | DECIMAL64 | The current incoming byte-rate (bytes per second). |
| packet-rate | DECIMAL64 | The current incoming packet (packets per second). |
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 |
| RW Keyspec XPath Path | C,/rwmon:nfvi-metrics/rwmon:network/rwmon:outgoing |
| RW Keyspec XPath Keyed Path | C,/rwmon:nfvi-metrics/rwmon:network/rwmon:outgoing |
| Protobuf Type | .rwmon.YangData.Rwmon.NfviMetrics.Network.Outgoing |
| Python Proto-GI Type | RwmonYang.NfviMetrics_Network_Outgoing |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__NfviMetrics__Network__Outgoing |
| C RWPB Identifiers | Rwmon_Rwmon_data_NfviMetrics_Network_Outgoing Rwmon_data_NfviMetrics_Network_Outgoing Rwmon_NfviMetrics_Network_Outgoing |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_NfviMetrics_Network_Outgoing |
Fields
| Name | Type | Description |
|---|---|---|
| label | STRING | Label to show in UI |
| bytes | UINT64 | The cumulative number of outgoing bytes. |
| packets | UINT64 | The cumulative number of outgoing packets. |
| byte-rate | DECIMAL64 | The current outgoing byte-rate (bytes per second). |
| packet-rate | DECIMAL64 | The current outgoing packet (packets per second). |
rwmon:alarm
Key Identifiers:| XPath Path | /rwmon:alarm |
| XPath Keyed Path | /rwmon:alarm |
| RW.REST URI Path | /rwmon:alarm |
| RW Keyspec XPath Path | C,/rwmon:alarm |
| RW Keyspec XPath Keyed Path | C,/rwmon:alarm |
| Protobuf Type | .rwmon.YangData.Rwmon.Alarm |
| Python Proto-GI Type | RwmonYang.Alarm |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__Alarm |
| C RWPB Identifiers | Rwmon_Rwmon_data_Alarm Rwmon_data_Alarm Rwmon_Alarm |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_Alarm |
Fields
| Name | Type | Description |
|---|---|---|
| alarm-id | STRING | This field is reserved for the identifier assigned by the VIM provider |
| name | STRING | A human readable string to identify the alarm |
| description | STRING | A description of this alarm |
| vdur-id | STRING | The identifier of the VDUR that the alarm is associated with |
| actions | CONTAINER | |
| repeat | BOOLEAN | This flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed. |
| enabled | BOOLEAN | This flag indicates whether the alarm has been enabled or disabled. |
| severity | ENUM | A measure of the importance or urgency of the alarm |
| metric | ENUM | The metric to be tracked by this alarm. |
| statistic | ENUM | The type of metric statistic that is tracked by this alarm |
| operation | ENUM | The 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. |
| value | DECIMAL64 | This value defines the threshold that, if crossed, will trigger the alarm. |
| period | UINT32 | The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic. |
| evaluations | UINT32 | Defines the length of time (seconds) in which metric data are collected in order to evaluate the chosen statistic. |
rwmon:actions
Key Identifiers:| XPath Path | /rwmon:alarm/rwmon:actions |
| XPath Keyed Path | /rwmon:alarm/rwmon:actions |
| RW.REST URI Path | /rwmon:alarm/actions |
| RW Keyspec XPath Path | C,/rwmon:alarm/rwmon:actions |
| RW Keyspec XPath Keyed Path | C,/rwmon:alarm/rwmon:actions |
| Protobuf Type | .rwmon.YangData.Rwmon.Alarm.Actions |
| Python Proto-GI Type | RwmonYang.Alarm_Actions |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__Alarm__Actions |
| C RWPB Identifiers | Rwmon_Rwmon_data_Alarm_Actions Rwmon_data_Alarm_Actions Rwmon_Alarm_Actions |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_Alarm_Actions |
Fields
| Name | Type | Description |
|---|---|---|
| ok | LIST | |
| insufficient-data | LIST | |
| alarm | LIST |
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 |
| RW Keyspec XPath Path | C,/rwmon:alarm/rwmon:actions/rwmon:ok |
| RW Keyspec XPath Keyed Path | C,/rwmon:alarm/rwmon:actions/rwmon:ok[rwmon:url='STRING'] |
| Protobuf Type | .rwmon.YangData.Rwmon.Alarm.Actions.Ok |
| Python Proto-GI Type | RwmonYang.Alarm_Actions_Ok |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__Alarm__Actions__Ok |
| C RWPB Identifiers | Rwmon_Rwmon_data_Alarm_Actions_Ok Rwmon_data_Alarm_Actions_Ok Rwmon_Alarm_Actions_Ok |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_Alarm_Actions_Ok |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
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 |
| RW Keyspec XPath Path | C,/rwmon:alarm/rwmon:actions/rwmon:insufficient-data |
| RW Keyspec XPath Keyed Path | C,/rwmon:alarm/rwmon:actions/rwmon:insufficient-data[rwmon:url='STRING'] |
| Protobuf Type | .rwmon.YangData.Rwmon.Alarm.Actions.InsufficientData |
| Python Proto-GI Type | RwmonYang.Alarm_Actions_InsufficientData |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__Alarm__Actions__InsufficientData |
| C RWPB Identifiers | Rwmon_Rwmon_data_Alarm_Actions_InsufficientData Rwmon_data_Alarm_Actions_InsufficientData Rwmon_Alarm_Actions_InsufficientData |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_Alarm_Actions_InsufficientData |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
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 |
| RW Keyspec XPath Path | C,/rwmon:alarm/rwmon:actions/rwmon:alarm |
| RW Keyspec XPath Keyed Path | C,/rwmon:alarm/rwmon:actions/rwmon:alarm[rwmon:url='STRING'] |
| Protobuf Type | .rwmon.YangData.Rwmon.Alarm.Actions.Alarm |
| Python Proto-GI Type | RwmonYang.Alarm_Actions_Alarm |
| C Protobuf-C Struct Type | Rwmon__YangData__Rwmon__Alarm__Actions__Alarm |
| C RWPB Identifiers | Rwmon_Rwmon_data_Alarm_Actions_Alarm Rwmon_data_Alarm_Actions_Alarm Rwmon_Alarm_Actions_Alarm |
| YPBC Base Identifier | rw_ypbc_Rwmon_Rwmon_data_Alarm_Actions_Alarm |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |