All Superinterfaces:: org.opendaylight.yangtools.yang.binding.DataRoot

@Generated("mdsal-binding-generator")
public interface AlivenessMonitorData
extends org.opendaylight.yangtools.yang.binding.DataRoot

This class represents the following YANG schema fragment defined in module aliveness-monitor

 module aliveness-monitor {
   namespace urn:opendaylight:genius:alivenessmonitor;
   prefix alivenessmon;
   import ietf-inet-types {
     prefix inet;
     revision-date 2013-07-15;
   }
   import ietf-yang-types {
     prefix yang;
     revision-date 2013-07-15;
   }
   revision 2016-04-11 {
   }
   typedef monitor-protocol-type {
     type enumeration {
       enum arp;
       enum lldp;
       enum bfd;
       enum ipv6-nd;
     }
   }
   typedef monitoring-mode {
     type enumeration {
       enum one-one;
     }
   }
   grouping endpoint {
     choice endpoint-type {
       case ip-address {
         leaf ip-address {
           type inet:ip-address;
         }
       }
       case interface {
         leaf mac-address {
           type yang:phys-address;
         }
         leaf interface-ip {
           type inet:ip-address;
         }
         leaf interface-name {
           type string;
         }
       }
       case host-name {
         leaf host-name {
           type string;
         }
       }
     }
   }
   grouping monitor-profile-params {
     leaf monitor-interval {
       type uint32;
     }
     leaf monitor-window {
       type uint32;
     }
     leaf failure-threshold {
       type uint32;
     }
     leaf protocol-type {
       type monitor-protocol-type;
     }
     uses bfd-params;
   }
   grouping bfd-params {
     leaf min-rx {
       type uint32;
     }
     leaf min-tx {
       type uint32;
     }
     leaf decay_min_rx {
       type uint32;
     }
     leaf forwarding_if_rx {
       type string;
     }
     leaf cpath_down {
       type string;
     }
     leaf check_tnl_key {
       type string;
     }
   }
   grouping monitor-params {
     leaf mode {
       type monitoring-mode;
     }
     container source {
       uses endpoint;
     }
     container destination {
       uses endpoint;
     }
     leaf profile-id {
       type uint32;
     }
   }
   rpc monitor-profile-create {
     input input {
       container profile {
         uses monitor-profile-params;
       }
     }
     output output {
       leaf profile-id {
         type uint32;
       }
     }
   }
   rpc monitor-profile-get {
     input input {
       container profile {
         uses monitor-profile-params;
       }
     }
     output output {
       leaf profile-id {
         type uint32;
       }
     }
   }
   rpc monitor-start {
     input input {
       container config {
         uses monitor-params;
       }
     }
     output output {
       leaf monitor-id {
         type uint32;
       }
     }
   }
   rpc monitor-pause {
     input input {
       leaf monitor-id {
         type uint32;
       }
     }
   }
   rpc monitor-unpause {
     input input {
       leaf monitor-id {
         type uint32;
       }
     }
   }
   rpc monitor-stop {
     input input {
       leaf monitor-id {
         type uint32;
       }
     }
   }
   rpc monitor-profile-delete {
     input input {
       leaf profile-id {
         type uint32;
       }
     }
   }
   typedef liveness-state {
     type enumeration {
       enum up;
       enum down;
       enum unknown;
     }
   }
   grouping liveness-event-state {
     leaf monitor-id {
       type uint32;
     }
     leaf monitor-state {
       type liveness-state;
     }
   }
   notification monitor-event {
     container event-data {
       uses liveness-event-state;
     }
   }
   container monitor-profiles {
     config false;
     list monitor-profile {
       key id;
       leaf id {
         type uint32;
       }
       uses monitor-profile-params;
     }
   }
   container monitor-configs {
     config false;
     list monitoring-info {
       key id;
       leaf id {
         type uint32;
       }
       uses monitor-params;
     }
   }
   typedef monitor-status {
     type enumeration {
       enum started;
       enum paused;
       enum stopped;
     }
   }
   container monitoring-states {
     config false;
     list monitoring-state {
       key monitor-key;
       leaf monitor-key {
         type string;
       }
       leaf monitor-id {
         type uint32;
       }
       leaf response-pending-count {
         type uint32;
       }
       leaf request-count {
         type uint32;
       }
       leaf state {
         type liveness-state;
       }
       leaf status {
         type monitor-status;
       }
     }
   }
   container monitorid-key-map {
     config false;
     list monitorid-key-entry {
       key monitor-id;
       leaf monitor-id {
         type uint32;
       }
       leaf monitor-key {
         type string;
       }
     }
   }
   container interface-monitor-map {
     config false;
     list interface-monitor-entry {
       key interface-name;
       leaf interface-name {
         type string;
       }
       leaf-list monitor-ids {
         type uint32;
       }
     }
   }
 }

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`InterfaceMonitorMap`	`getInterfaceMonitorMap()`	Return interfaceMonitorMap, or `null` if it is not present.
`MonitorConfigs`	`getMonitorConfigs()`	Return monitorConfigs, or `null` if it is not present.
`MonitoridKeyMap`	`getMonitoridKeyMap()`	Return monitoridKeyMap, or `null` if it is not present.
`MonitoringStates`	`getMonitoringStates()`	Return monitoringStates, or `null` if it is not present.
`MonitorProfiles`	`getMonitorProfiles()`	Return monitorProfiles, or `null` if it is not present.

- Method Detail
  - getMonitorProfiles
```
MonitorProfiles getMonitorProfiles()
```
    Return monitorProfiles, or null if it is not present.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.MonitorProfiles monitorProfiles, or null if it is not present.
  - getMonitorConfigs
```
MonitorConfigs getMonitorConfigs()
```
    Return monitorConfigs, or null if it is not present.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.MonitorConfigs monitorConfigs, or null if it is not present.
  - getMonitoringStates
```
MonitoringStates getMonitoringStates()
```
    Return monitoringStates, or null if it is not present.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.MonitoringStates monitoringStates, or null if it is not present.
  - getMonitoridKeyMap
```
MonitoridKeyMap getMonitoridKeyMap()
```
    Return monitoridKeyMap, or null if it is not present.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.MonitoridKeyMap monitoridKeyMap, or null if it is not present.
  - getInterfaceMonitorMap
```
InterfaceMonitorMap getInterfaceMonitorMap()
```
    Return interfaceMonitorMap, or null if it is not present.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.InterfaceMonitorMap interfaceMonitorMap, or null if it is not present.

Interface AlivenessMonitorData

Method Summary

Method Detail

getMonitorProfiles

getMonitorConfigs

getMonitoringStates

getMonitoridKeyMap

getInterfaceMonitorMap