Programmer's API documentation for yang module rwmon.yang



Schema Globals                                                               1

module rwmon                                                                 2
  rwmon data                                                               2.1
    container rwmon:nfvi-metrics                                         2.1.1
      container rwmon:vcpu                                             2.1.1.1
      container rwmon:memory                                           2.1.1.2
      container rwmon:storage                                          2.1.1.3
      container rwmon:external-ports                                   2.1.1.4
      container rwmon:internal-ports                                   2.1.1.5
      container rwmon:network                                          2.1.1.6
        container rwmon:incoming                                     2.1.1.6.1
        container rwmon:outgoing                                     2.1.1.6.2
    container rwmon:alarm                                                2.1.2
      container rwmon:actions                                          2.1.2.1
        list rwmon:ok                                                2.1.2.1.1
        list rwmon:insufficient-data                                 2.1.2.1.2
        list rwmon:alarm                                             2.1.2.1.3


1  Schema Globals
  Global Schema Type
    rw_ypbc_Rwmon_t_schema
  Global Schema Pointer
    rw_ypbc_Rwmon_g_schema
2  module rwmon

2.1  rwmon data

2.1.1  container rwmon:nfvi-metrics
  Leaves
    name: timestamp, type: DECIMAL64, description: 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.
  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

2.1.1.1  container rwmon:vcpu
  Leaves
    name: label, type: STRING, description: Label to show in UI
    name: total, type: UINT64, description: The total number of VCPUs available.
    name: utilization, type: DECIMAL64, description: The VCPU utilization (percentage).
  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

2.1.1.2  container rwmon:memory
  Leaves
    name: label, type: STRING, description: Label to show in UI
    name: used, type: UINT64, description: The amount of memory (bytes) currently in use.
    name: total, type: UINT64, description: The amount of memory (bytes) available.
    name: utilization, type: DECIMAL64, description: The memory utilization (percentage).
  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

2.1.1.3  container rwmon:storage
  Leaves
    name: label, type: STRING, description: Label to show in UI
    name: used, type: UINT64, description: The amount of storage (bytes) currently in use.
    name: total, type: UINT64, description: The amount of storage (bytes) available.
    name: utilization, type: DECIMAL64, description: The storage utilization (percentage).
  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

2.1.1.4  container rwmon:external-ports
  Leaves
    name: label, type: STRING, description: Label to show in UI
    name: total, type: UINT64, description: The total number of external ports.
  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

2.1.1.5  container rwmon:internal-ports
  Leaves
    name: label, type: STRING, description: Label to show in UI
    name: total, type: UINT64, description: The total number of internal ports.
  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

2.1.1.6  container rwmon:network
  Leaves
    name: label, type: STRING, description: Label to show in UI
  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

2.1.1.6.1  container rwmon:incoming
  Leaves
    name: label, type: STRING, description: Label to show in UI
    name: bytes, type: UINT64, description: The cumulative number of incoming bytes.
    name: packets, type: UINT64, description: The cumulative number of incoming packets.
    name: byte-rate, type: DECIMAL64, description: The current incoming byte-rate (bytes per second).
    name: packet-rate, type: DECIMAL64, description: The current incoming packet (packets per second).
  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

2.1.1.6.2  container rwmon:outgoing
  Leaves
    name: label, type: STRING, description: Label to show in UI
    name: bytes, type: UINT64, description: The cumulative number of outgoing bytes.
    name: packets, type: UINT64, description: The cumulative number of outgoing packets.
    name: byte-rate, type: DECIMAL64, description: The current outgoing byte-rate (bytes per second).
    name: packet-rate, type: DECIMAL64, description: The current outgoing packet (packets per second).
  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

2.1.2  container rwmon:alarm
  Leaves
    name: alarm-id, type: STRING, description: This field is reserved for the identifier assigned by the VIM provider
    name: name, type: STRING, description: A human readable string to identify the alarm
    name: description, type: STRING, description: A description of this alarm
    name: vdur-id, type: STRING, description: The identifier of the VDUR that the alarm is associated with
    name: repeat, type: BOOLEAN, description: This flag indicates whether the alarm should be repeatedly emitted
    while the associated threshold has been crossed.
    name: enabled, type: BOOLEAN, description: This flag indicates whether the alarm has been enabled or
    disabled.
    name: severity, type: ENUM, description: A measure of the importance or urgency of the alarm
    name: metric, type: ENUM, description: The metric to be tracked by this alarm.
    name: statistic, type: ENUM, description: The type of metric statistic that is tracked by this alarm
    name: operation, type: ENUM, description: 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.
    name: value, type: DECIMAL64, description: This value defines the threshold that, if crossed, will trigger
    the alarm.
    name: period, type: UINT32, description: The period defines the length of time (seconds) that the metric
    data are collected over in oreder to evaluate the chosen
    statistic.
    name: evaluations, type: UINT32, description: Defines the length of time (seconds) in which metric data are
    collected in order to evaluate the chosen statistic.
  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

2.1.2.1  container rwmon:actions
  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

2.1.2.1.1  list rwmon:ok
  Leaves
    name: url, type: STRING
  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

2.1.2.1.2  list rwmon:insufficient-data
  Leaves
    name: url, type: STRING
  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

2.1.2.1.3  list rwmon:alarm
  Leaves
    name: url, type: STRING
  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

