Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406

Interface IdManagerData

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.DataRoot
    @Generated("mdsal-binding-generator")
public interface IdManagerData
extends org.opendaylight.yangtools.yang.binding.DataRoot

    This class represents the following YANG schema fragment defined in module id-manager 

     module id-manager {
   namespace urn:opendaylight:genius:idmanager;
   prefix idmgr;
   revision 2016-04-06 {
   }
   container id-pools {
     list id-pool {
       key pool-name;
       leaf pool-name {
         type string;
       }
       leaf block-size {
         type uint16;
       }
       leaf parent-pool-name {
         type string;
       }
       list child-pools {
         key child-pool-name;
         leaf child-pool-name {
           type string;
         }
         leaf last-access-time {
           type uint32;
         }
       }
       list id-entries {
         key id-key;
         leaf id-key {
           type string;
         }
         leaf-list id-value {
           type uint32;
         }
       }
       container available-ids-holder {
         uses available-ids;
       }
       container released-ids-holder {
         uses released-ids;
       }
     }
   }
   grouping available-ids {
     leaf start {
       type uint32;
     }
     leaf end {
       type uint32;
     }
     leaf cursor {
       type int64;
     }
   }
   grouping released-ids {
     leaf available-id-count {
       type uint32;
     }
     leaf delayed-time-sec {
       type uint32;
     }
     list delayed-id-entries {
       uses delayed-id-entry;
     }
   }
   grouping delayed-id-entry {
     leaf id {
       type uint32;
     }
     leaf ready-time-sec {
       type uint32;
     }
   }
   rpc createIdPool {
     input input {
       leaf pool-name {
         type string;
       }
       leaf low {
         type uint32;
       }
       leaf high {
         type uint32;
       }
     }
   }
   rpc deleteIdPool {
     input input {
       leaf pool-name {
         type string;
       }
     }
   }
   rpc allocateId {
     input input {
       leaf pool-name {
         type string;
       }
       leaf id-key {
         type string;
       }
     }
     output output {
       leaf id-value {
         type uint32;
       }
     }
   }
   rpc releaseId {
     input input {
       leaf pool-name {
         type string;
       }
       leaf id-key {
         type string;
       }
     }
     output output {
       leaf-list id-values {
         type uint32;
         ordered-by user;
       }
     }
   }
   rpc allocateIdRange {
     input input {
       leaf pool-name {
         type string;
       }
       leaf id-key {
         type string;
       }
       leaf size {
         type uint32;
       }
     }
     output output {
       leaf-list id-values {
         type uint32;
         ordered-by user;
       }
     }
   }
 }

    • Method Detail

      • getIdPools

        IdPools getIdPools()
        Return idPools, or null if it is not present. 
             
         Parent Id Pool is responsible allocating block (or) set of Ids to child Id
         Pools. The number of child pools are determined using some algorthimic approach
         inside IdManager. For example, spawning child pools based on Id allocation
         request rate for the given Pool, one child pool per blade in the cluster etc
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools idPools, or null if it is not present.