Class DatastoreId


  • public class DatastoreId
    extends org.onlab.util.Identifier<java.lang.String>
    Identifier object to specify datastore.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static DatastoreId CANDIDATE
      A configuration datastore that can be manipulated without impacting the device's current configuration and that can be committed to the running configuration datastore.
      static DatastoreId RUNNING
      A configuration datastore holding the complete configuration currently active on the device.
      static DatastoreId STARTUP
      The configuration datastore holding the configuration loaded by the device when it boots.
      • Fields inherited from class org.onlab.util.Identifier

        identifier
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String asXml()
      Returns datastore name as XML tag.
      static DatastoreId datastore​(java.lang.String name)
      Returns datastore identifier object.
      java.lang.String toString()  
      • Methods inherited from class org.onlab.util.Identifier

        equals, hashCode, id
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • RUNNING

        public static final DatastoreId RUNNING
        A configuration datastore holding the complete configuration currently active on the device. The running configuration datastore always exists.
      • CANDIDATE

        public static final DatastoreId CANDIDATE
        A configuration datastore that can be manipulated without impacting the device's current configuration and that can be committed to the running configuration datastore. Not all devices support a candidate configuration datastore.
      • STARTUP

        public static final DatastoreId STARTUP
        The configuration datastore holding the configuration loaded by the device when it boots. Only present on devices that separate the startup configuration datastore from the running configuration datastore.
    • Method Detail

      • datastore

        public static DatastoreId datastore​(java.lang.String name)
        Returns datastore identifier object.
        Parameters:
        name - of the datastore
        Returns:
        identifier
      • asXml

        public java.lang.String asXml()
        Returns datastore name as XML tag.
        Returns:
        xml tag
      • toString

        public final java.lang.String toString()
        Overrides:
        toString in class org.onlab.util.Identifier<java.lang.String>