itm/itm-impl/src/main/java/org/opendaylight/genius/itm/cli/TepCommandHelper.java

   1 /*
   2  * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.genius.itm.cli;
   9
  10 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
  11
  12 import com.google.common.base.Optional;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.MoreExecutors;
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.Collections;
  18 import java.util.HashMap;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Map.Entry;
  22 import java.util.Objects;
  23 import java.util.concurrent.ExecutionException;
  24 import java.util.concurrent.atomic.AtomicInteger;
  25 import javax.annotation.PostConstruct;
  26 import javax.annotation.PreDestroy;
  27 import javax.inject.Inject;
  28 import javax.inject.Singleton;
  29 import org.apache.commons.lang3.StringUtils;
  30 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  31 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  32 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  33 import org.opendaylight.genius.infra.Datastore;
  34 import org.opendaylight.genius.infra.RetryingManagedNewTransactionRunner;
  35 import org.opendaylight.genius.itm.cache.UnprocessedTunnelsStateCache;
  36 import org.opendaylight.genius.itm.globals.ITMConstants;
  37 import org.opendaylight.genius.itm.impl.ItmUtils;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBase;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBfd;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeLldp;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeLogicalGroup;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.ItmConfig;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorInterval;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorIntervalBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorParams;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorParamsBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TepTypeInternal;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelOperStatus;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelList;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZones;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZonesBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneKey;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.Vteps;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.VtepsBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.VtepsKey;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
  65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  66 import org.opendaylight.yangtools.yang.binding.DataObject;
  67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  68 import org.opendaylight.yangtools.yang.common.Uint64;
  69 import org.slf4j.Logger;
  70 import org.slf4j.LoggerFactory;
  71
  72 @Singleton
  73 @SuppressWarnings("checkstyle:RegexpSingleLineJava")
  74 public class TepCommandHelper {
  75
  76     private static final Logger LOG = LoggerFactory.getLogger(TepCommandHelper.class);
  77
  78     private static final AtomicInteger CHECK = new AtomicInteger();
  79
  80     private final DataBroker dataBroker;
  81     private final RetryingManagedNewTransactionRunner txRunner;
  82     private final ItmConfig itmConfig;
  83     private final UnprocessedTunnelsStateCache unprocessedTunnelsStateCache;
  84
  85     /*
  86      * boolean flag add_or_delete --- can be set to true if the last called tep
  87      * command is Tep-add else set to false when Tep-delete is called
  88      * tepCommandHelper object is created only once in session initiated
  89      */
  90     private final Map<String, List<Vteps>> transportZonesHashMap = new HashMap<>();
  91     private List<TransportZone> transportZoneArrayList = new ArrayList<>();
  92     private final List<Vteps> vtepDelCommitList = new ArrayList<>();
  93
  94     @Inject
  95     public TepCommandHelper(final DataBroker dataBroker, final ItmConfig itmConfig,
  96                             final UnprocessedTunnelsStateCache unprocessedTunnelsStateCache) {
  97         this.dataBroker = dataBroker;
  98         this.txRunner = new RetryingManagedNewTransactionRunner(dataBroker);
  99         this.itmConfig = itmConfig;
 100         this.unprocessedTunnelsStateCache = unprocessedTunnelsStateCache;
 101     }
 102
 103     @PostConstruct
 104     public void start() throws ExecutionException, InterruptedException {
 105         LOG.info("TepCommandHelper Started");
 106     }
 107
 108     @PreDestroy
 109     public void close() {
 110         LOG.info("TepCommandHelper Closed");
 111     }
 112
 113     @SuppressWarnings("checkstyle:IllegalCatch")
 114     public void createLocalCache(Uint64 dpnId, String ipAddress,
 115                                  String transportZone) throws TepException {
 116
 117         CHECK.incrementAndGet();
 118         IpAddress ipAddressObj;
 119
 120         final VtepsKey vtepkey = new VtepsKey(dpnId);
 121
 122         ipAddressObj = IpAddressBuilder.getDefaultInstance(ipAddress);
 123
 124         if (checkTepPerTzPerDpn(transportZone, dpnId)) {
 125             handleError("Only one end point per transport Zone per Dpn is allowed");
 126             return;
 127         }
 128
 129         Vteps vtepCli = new VtepsBuilder().setDpnId(dpnId).setIpAddress(ipAddressObj).withKey(vtepkey)
 130                 .build();
 131
 132         if (transportZonesHashMap.containsKey(transportZone)) {
 133             List<Vteps> vtepListTemp = transportZonesHashMap.get(transportZone);
 134             if (!vtepListTemp.contains(vtepCli)) {
 135                 vtepListTemp.add(vtepCli);
 136             }
 137         } else {
 138             List<Vteps> vtepListTemp = new ArrayList<>();
 139             vtepListTemp.add(vtepCli);
 140             transportZonesHashMap.put(transportZone, vtepListTemp);
 141         }
 142     }
 143
 144     /**
 145      * Gets the transport zone.
 146      *
 147      * @param transportZoneName
 148      *            the tzone
 149      * @return the transport zone
 150      */
 151     public TransportZone getTransportZone(String transportZoneName) {
 152         InstanceIdentifier<TransportZone> tzonePath = InstanceIdentifier.builder(TransportZones.class)
 153                 .child(TransportZone.class, new TransportZoneKey(transportZoneName)).build();
 154         return ItmUtils.read(LogicalDatastoreType.CONFIGURATION, tzonePath, dataBroker).orNull();
 155     }
 156
 157     /**
 158      * Gets all transport zones.
 159      *
 160      * @return all transport zones
 161      */
 162     public TransportZones getAllTransportZones() {
 163         InstanceIdentifier<TransportZones> path = InstanceIdentifier.builder(TransportZones.class).build();
 164         return ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path, dataBroker).orNull();
 165     }
 166
 167
 168     public boolean checkTepPerTzPerDpn(String tzone, Uint64 dpnId) {
 169         // check in local cache
 170         if (transportZonesHashMap.containsKey(tzone)) {
 171             List<Vteps> vtepList = transportZonesHashMap.get(tzone);
 172             for (Vteps vtep : vtepList) {
 173                 if (Objects.equals(vtep.getDpnId(), dpnId)) {
 174                     return true;
 175                 }
 176             }
 177         }
 178
 179         // check in DS
 180         InstanceIdentifier<TransportZone> tzonePath =
 181                 InstanceIdentifier.builder(TransportZones.class)
 182                         .child(TransportZone.class, new TransportZoneKey(tzone)).build();
 183         Optional<TransportZone> transportZoneOptional =
 184                 ItmUtils.read(LogicalDatastoreType.CONFIGURATION, tzonePath, dataBroker);
 185         if (transportZoneOptional.isPresent()) {
 186             TransportZone tz = transportZoneOptional.get();
 187             for (Vteps vtep : tz.getVteps()) {
 188                 if (Objects.equals(vtep.getDpnId(), dpnId)) {
 189                     return true;
 190                 }
 191             }
 192         }
 193         return false;
 194     }
 195
 196     @SuppressWarnings("checkstyle:IllegalCatch")
 197     public void buildTeps() {
 198         TransportZone transportZone = null;
 199         try {
 200             LOG.debug("no of teps added {}", CHECK);
 201             if (transportZonesHashMap != null && !transportZonesHashMap.isEmpty()) {
 202                 transportZoneArrayList = new ArrayList<>();
 203                 for (Entry<String, List<Vteps>> mapEntry : transportZonesHashMap.entrySet()) {
 204                     String tz = mapEntry.getKey();
 205                     LOG.debug("transportZonesHashMap {}", tz);
 206                     List<Vteps> vtepListTemp = mapEntry.getValue();
 207                     InstanceIdentifier<TransportZone> transportZonePath =
 208                             InstanceIdentifier.builder(TransportZones.class)
 209                                     .child(TransportZone.class, new TransportZoneKey(tz)).build();
 210                     Optional<TransportZone> transportZoneOptional =
 211                             ItmUtils.read(LogicalDatastoreType.CONFIGURATION, transportZonePath, dataBroker);
 212                     LOG.debug("read container from DS");
 213                     if (transportZoneOptional.isPresent()) {
 214                         TransportZone tzoneFromDs = transportZoneOptional.get();
 215                         LOG.debug("read tzone container {}", tzoneFromDs);
 216                         if (tzoneFromDs.getTunnelType() == null
 217                                 || tzoneFromDs.getTunnelType().equals(TunnelTypeVxlan.class)) {
 218                             transportZone =
 219                                     new TransportZoneBuilder().withKey(new TransportZoneKey(tz))
 220                                             .setTunnelType(TunnelTypeVxlan.class)
 221                                             .setZoneName(tz).setVteps(vtepListTemp).build();
 222                         } else if (tzoneFromDs.getTunnelType().equals(TunnelTypeGre.class)) {
 223                             transportZone =
 224                                     new TransportZoneBuilder().withKey(new TransportZoneKey(tz))
 225                                             .setTunnelType(TunnelTypeGre.class).setVteps(vtepListTemp)
 226                                             .setZoneName(tz).build();
 227                         }
 228                     } else {
 229                         transportZone =
 230                                 new TransportZoneBuilder().withKey(new TransportZoneKey(tz))
 231                                         .setTunnelType(TunnelTypeVxlan.class).setZoneName(tz).setVteps(vtepListTemp)
 232                                         .build();
 233                     }
 234                     LOG.debug("tzone object {}", transportZone);
 235                     transportZoneArrayList.add(transportZone);
 236                 }
 237                 TransportZones transportZones =
 238                         new TransportZonesBuilder().setTransportZone(transportZoneArrayList).build();
 239                 InstanceIdentifier<TransportZones> path = InstanceIdentifier.builder(TransportZones.class).build();
 240                 LOG.debug("InstanceIdentifier {}", path);
 241                 Futures.addCallback(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION,
 242                     tx -> tx.merge(path, transportZones, true)), ItmUtils.DEFAULT_WRITE_CALLBACK,
 243                     MoreExecutors.directExecutor());
 244                 LOG.debug("wrote to Config DS {}", transportZones);
 245                 transportZonesHashMap.clear();
 246                 transportZoneArrayList.clear();
 247                 LOG.debug("Everything cleared");
 248             } else {
 249                 LOG.debug("NO vteps were configured");
 250             }
 251         } catch (RuntimeException e) {
 252             LOG.error("Error building TEPs", e);
 253         }
 254     }
 255
 256     public List<String> showTeps(boolean monitorEnabled, int monitorInterval) throws TepException {
 257         boolean flag = false;
 258         InstanceIdentifier<TransportZones> path = InstanceIdentifier.builder(TransportZones.class).build();
 259         Optional<TransportZones> transportZonesOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION,
 260                 path, dataBroker);
 261         if (transportZonesOptional.isPresent()) {
 262             List<String> result = new ArrayList<>();
 263             TransportZones transportZones = transportZonesOptional.get();
 264             if (transportZones.getTransportZone() == null || transportZones.getTransportZone().isEmpty()) {
 265                 handleError("No teps configured");
 266                 return result;
 267             }
 268             result.add(String.format("Tunnel Monitoring (for VXLAN tunnels): %s", monitorEnabled ? "On" : "Off"));
 269             result.add(String.format("Tunnel Monitoring Interval (for VXLAN tunnels): %d", monitorInterval));
 270             result.add(System.lineSeparator());
 271             result.add(String.format("%-16s  %-16s  %-16s  %-12s  %-12s %-12s %-16s %-12s", "TransportZone",
 272                     "TunnelType", "SubnetMask", "GatewayIP", "VlanID", "DpnID", "IPAddress", "PortName"));
 273             result.add("---------------------------------------------------------------------------------------------"
 274                     + "---------------------------------");
 275             for (TransportZone tz : transportZones.getTransportZone()) {
 276                 if (tz.getVteps() == null || tz.getVteps().isEmpty()) {
 277                     continue;
 278                 }
 279                 for (Vteps vtep : tz.getVteps()) {
 280                     flag = true;
 281                     String strTunnelType ;
 282                     if (TunnelTypeGre.class.equals(tz.getTunnelType())) {
 283                         strTunnelType = ITMConstants.TUNNEL_TYPE_GRE;
 284                     } else {
 285                         strTunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
 286                     }
 287                     result.add(String.format("%-16s  %-16s  %-12s %-16s",
 288                             tz.getZoneName(), strTunnelType,
 289                             vtep.getDpnId().toString(), vtep.getIpAddress().stringValue()));
 290                 }
 291             }
 292             if (flag) {
 293                 return result;
 294             } else {
 295                 return Collections.singletonList("No teps to display");
 296             }
 297         } else {
 298             return Collections.singletonList("No teps configured");
 299         }
 300     }
 301
 302     @SuppressWarnings("checkstyle:RegexpSinglelineJava")
 303     public void showCache(String cacheName) {
 304         final Collection<String> cacheContent;
 305         switch (cacheName) {
 306             case ITMConstants.INTERNAL_TUNNEL_CACHE_NAME:
 307                 cacheContent = ItmUtils.ITM_CACHE.getAllInternalInterfaces();
 308                 break;
 309             case ITMConstants.EXTERNAL_TUNNEL_CACHE_NAME:
 310                 cacheContent = ItmUtils.ITM_CACHE.getAllExternalInterfaces();
 311                 break;
 312             case ITMConstants.UNPROCESSED_TUNNELS_CACHE_NAME:
 313                 cacheContent = unprocessedTunnelsStateCache.getAllUnprocessedTunnels();
 314                 break;
 315             default:
 316                 System.out.println(" " + cacheName + " is not a valid Cache Name ");
 317                 return;
 318         }
 319         System.out.println("Dumping the data in cache for " + cacheName);
 320         System.out.println("Number of data in cache " + cacheContent.size());
 321         if (!cacheContent.isEmpty()) {
 322             for (String key : cacheContent) {
 323                 System.out.println(key + " ");
 324             }
 325         } else {
 326             System.out.println("No data in cache for " + cacheName);
 327         }
 328     }
 329
 330     @SuppressWarnings("checkstyle:IllegalCatch")
 331     public void deleteVtep(Uint64 dpnId, String ipAddress,
 332                            String transportZone) throws TepException {
 333
 334         final VtepsKey vtepkey = new VtepsKey(dpnId);
 335
 336         IpAddress ipAddressObj = IpAddressBuilder.getDefaultInstance(ipAddress);
 337
 338         Vteps vtepCli;
 339
 340         InstanceIdentifier<Vteps> vpath = InstanceIdentifier.builder(TransportZones.class)
 341                 .child(TransportZone.class, new TransportZoneKey(transportZone))
 342                 .child(Vteps.class, vtepkey).build();
 343
 344         // check if present in tzones and delete from cache
 345         boolean existsInCache = isInCache(dpnId, ipAddress, transportZone);
 346         if (!existsInCache) {
 347             Optional<Vteps> vtepOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, vpath, dataBroker);
 348             if (vtepOptional.isPresent()) {
 349                 vtepCli = vtepOptional.get();
 350                 if (Objects.equals(vtepCli.getIpAddress(), ipAddressObj)) {
 351                     vtepDelCommitList.add(vtepCli);
 352                 }
 353             } else {
 354                 handleError("Vtep Doesnt exist");
 355             }
 356         }
 357     }
 358
 359     @SuppressWarnings("checkstyle:IllegalCatch")
 360     public <T extends DataObject> void deleteOnCommit() {
 361         List<InstanceIdentifier<T>> vtepPaths = new ArrayList<>();
 362         List<InstanceIdentifier<T>> subnetPaths = new ArrayList<>();
 363         List<Vteps> vtepDelList = new ArrayList<>();
 364         List<InstanceIdentifier<T>> allPaths = new ArrayList<>();
 365         try {
 366             if (vtepDelCommitList != null && !vtepDelCommitList.isEmpty()) {
 367                 InstanceIdentifier<TransportZones> path = InstanceIdentifier.builder(TransportZones.class).build();
 368                 Optional<TransportZones> transportZonesOptional =
 369                         ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path, dataBroker);
 370                 if (transportZonesOptional.isPresent()) {
 371                     List<TransportZone> transportZones = transportZonesOptional.get().nonnullTransportZone();
 372                     for (TransportZone tz : transportZones) {
 373                         if (tz.getVteps() == null || tz.getVteps().isEmpty()) {
 374                             continue;
 375                         }
 376                         vtepDelList.addAll(vtepDelCommitList);
 377                         for (Vteps vtep : vtepDelList) {
 378                             InstanceIdentifier<T> vpath =
 379                                     (InstanceIdentifier<T>) InstanceIdentifier
 380                                             .builder(TransportZones.class)
 381                                             .child(TransportZone.class, tz.key())
 382                                             .child(Vteps.class, vtep.key()).build();
 383                             vtepPaths.add(vpath);
 384                         }
 385                     }
 386
 387                     allPaths.addAll(vtepPaths);
 388                     allPaths.addAll(subnetPaths);
 389                     Futures.addCallback(txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
 390                         tx -> allPaths.forEach(tx::delete)), ItmUtils.DEFAULT_WRITE_CALLBACK,
 391                         MoreExecutors.directExecutor());
 392                 }
 393                 vtepPaths.clear();
 394                 subnetPaths.clear();
 395                 allPaths.clear();
 396                 vtepDelCommitList.clear();
 397             }
 398         } catch (RuntimeException e) {
 399             LOG.error("Unexpected error", e);
 400         }
 401     }
 402
 403     @SuppressWarnings("checkstyle:RegexpSinglelineJava")
 404     public void showState(Collection<StateTunnelList> tunnelLists, boolean tunnelMonitorEnabled) throws TepException {
 405         if (tunnelLists == null || tunnelLists.isEmpty()) {
 406             handleError("No Internal Tunnels Exist");
 407             return;
 408         }
 409         if (!tunnelMonitorEnabled) {
 410             System.out.println("Tunnel Monitoring is Off");
 411         }
 412         String displayFormat = "%-16s  %-16s  %-16s  %-16s  %-16s  %-10s  %-10s";
 413         System.out.println(String.format(displayFormat, "Tunnel Name", "Source-DPN",
 414                 "Destination-DPN", "Source-IP", "Destination-IP", "Trunk-State", "Transport Type"));
 415         System.out.println("-----------------------------------------------------------------------------------------"
 416                 + "--------------------------------------------");
 417
 418         for (StateTunnelList tunnelInst : tunnelLists) {
 419             // Display only the internal tunnels
 420             if (TepTypeInternal.class.equals(tunnelInst.getDstInfo().getTepDeviceType())) {
 421                 String tunnelInterfaceName = tunnelInst.getTunnelInterfaceName();
 422                 LOG.trace("tunnelInterfaceName::: {}", tunnelInterfaceName);
 423                 String tunnelState = ITMConstants.TUNNEL_STATE_UNKNOWN;
 424                 if (tunnelInst.getOperState() == TunnelOperStatus.Up) {
 425                     tunnelState = ITMConstants.TUNNEL_STATE_UP;
 426                 } else if (tunnelInst.getOperState() == TunnelOperStatus.Down) {
 427                     tunnelState = ITMConstants.TUNNEL_STATE_DOWN;
 428                 }
 429                 Class<? extends TunnelTypeBase> tunType = tunnelInst.getTransportType();
 430                 String tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
 431                 if (TunnelTypeVxlan.class.equals(tunType)) {
 432                     tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
 433                 } else if (tunType.equals(TunnelTypeGre.class)) {
 434                     tunnelType = ITMConstants.TUNNEL_TYPE_GRE;
 435                 } else if (tunType.equals(TunnelTypeMplsOverGre.class)) {
 436                     tunnelType = ITMConstants.TUNNEL_TYPE_MPLSoGRE;
 437                 } else if (tunType.equals(TunnelTypeLogicalGroup.class)) {
 438                     tunnelType = ITMConstants.TUNNEL_TYPE_LOGICAL_GROUP_VXLAN;
 439                 }
 440                 System.out.println(String.format(displayFormat, tunnelInst.getTunnelInterfaceName(),
 441                         tunnelInst.getSrcInfo().getTepDeviceId(), tunnelInst.getDstInfo().getTepDeviceId(),
 442                         tunnelInst.getSrcInfo().getTepIp().stringValue(),
 443                         tunnelInst.getDstInfo().getTepIp().stringValue(), tunnelState, tunnelType));
 444             }
 445         }
 446     }
 447
 448     // Show DPN-ID and Bridge mapping
 449     public void showBridges(Map<Uint64, OvsdbBridgeRef> dpnIdBridgeRefMap) {
 450         System.out.println(String.format("%-16s  %-16s  %-36s%n", "DPN-ID", "Bridge-Name", "Bridge-UUID")
 451                 + "------------------------------------------------------------------------");
 452         dpnIdBridgeRefMap.forEach((dpnId, ovsdbBridgeRef) -> {
 453             String szBridgeId = ovsdbBridgeRef.getValue().firstKeyOf(Node.class).getNodeId().getValue();
 454             String bridgeUUID = szBridgeId.substring(13, 49);
 455             String bridgeName = szBridgeId.substring(57);
 456             System.out.println(String.format("%-16s  %-16s  %-36s", dpnId, bridgeName, bridgeUUID));
 457         });
 458     }
 459
 460     // deletes from ADD-cache if it exists.
 461     public boolean isInCache(Uint64 dpnId, String ipAddress,
 462                              String transportZone) throws TepException {
 463         boolean exists = false;
 464         final VtepsKey vtepkey = new VtepsKey(dpnId);
 465         IpAddress ipAddressObj = IpAddressBuilder.getDefaultInstance(ipAddress);
 466
 467         Vteps vtepCli = new VtepsBuilder().setDpnId(dpnId).setIpAddress(ipAddressObj).withKey(vtepkey).build();
 468
 469         if (transportZonesHashMap.containsKey(transportZone)) {
 470             List<Vteps> vtepListTemp = transportZonesHashMap.get(transportZone);
 471             if (vtepListTemp.contains(vtepCli)) {
 472                 exists = true; // return true if tzones has vtep
 473                 vtepListTemp.remove(vtepCli);
 474                 if (vtepListTemp.size() == 0) {
 475                     transportZonesHashMap.remove(transportZone);
 476                 }
 477             } else {
 478                 handleError("Vtep has not been configured");
 479             }
 480         }
 481         return exists;
 482     }
 483
 484     public void configureTunnelType(String transportZoneName, String tunnelType) throws ExecutionException,
 485             InterruptedException {
 486         LOG.debug("configureTunnelType {} for transportZone {}", tunnelType, transportZoneName);
 487
 488         TransportZone transportZoneFromConfigDS = ItmUtils.getTransportZoneFromConfigDS(transportZoneName, dataBroker);
 489         Class<? extends TunnelTypeBase> tunType;
 490
 491         if (transportZoneFromConfigDS != null) {
 492             if (!transportZoneName.equals(ITMConstants.DEFAULT_TRANSPORT_ZONE)) {
 493                 LOG.debug("Transport zone {} with tunnel type {} already exists. No action required.",
 494                         transportZoneName, tunnelType);
 495                 return;
 496             } else {
 497                 tunnelType = StringUtils.upperCase(tunnelType);
 498                 tunType = ItmUtils.TUNNEL_TYPE_MAP.get(tunnelType);
 499                 if (Objects.equals(transportZoneFromConfigDS.getTunnelType(), tunType)) {
 500                     // default-TZ already exists and tunnel-type is not changed during
 501                     // controller restart, then nothing to do now. Just return.
 502                     return;
 503                 }
 504             }
 505         }
 506
 507         // get tunnel-type
 508         tunnelType = StringUtils.upperCase(tunnelType);
 509         tunType = ItmUtils.TUNNEL_TYPE_MAP.get(tunnelType);
 510
 511
 512         InstanceIdentifier<TransportZones> path = InstanceIdentifier.builder(TransportZones.class).build();
 513         Optional<TransportZones> tzones = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path, dataBroker);
 514
 515         TransportZone tzone = new TransportZoneBuilder().withKey(new TransportZoneKey(transportZoneName))
 516                 .setTunnelType(tunType).build();
 517         List<TransportZone> tzList = new ArrayList<>();
 518         if (tzones.isPresent()) {
 519             final List<TransportZone> lst = tzones.get().getTransportZone();
 520             if (lst != null) {
 521                 tzList.addAll(lst);
 522             }
 523         }
 524         tzList.add(tzone);
 525         TransportZones transportZones = new TransportZonesBuilder().setTransportZone(tzList).build();
 526         txRunner.callWithNewWriteOnlyTransactionAndSubmit(tx -> tx.put(LogicalDatastoreType.CONFIGURATION,
 527                 path, transportZones, WriteTransaction.CREATE_MISSING_PARENTS)).get();
 528
 529     }
 530
 531     public void configureTunnelMonitorParams(boolean monitorEnabled, String monitorProtocol) {
 532         InstanceIdentifier<TunnelMonitorParams> path = InstanceIdentifier.builder(TunnelMonitorParams.class).build();
 533         Optional<TunnelMonitorParams> storedTunnelMonitor = ItmUtils.read(LogicalDatastoreType.CONFIGURATION,
 534                 path, dataBroker);
 535         Class<? extends TunnelMonitoringTypeBase> monitorType ;
 536         if (storedTunnelMonitor.isPresent() && storedTunnelMonitor.get().getMonitorProtocol() != null) {
 537             monitorType = storedTunnelMonitor.get().getMonitorProtocol();
 538         } else {
 539             if (monitorProtocol != null && monitorProtocol.equalsIgnoreCase(ITMConstants.MONITOR_TYPE_LLDP)) {
 540                 monitorType = TunnelMonitoringTypeLldp.class;
 541             } else {
 542                 monitorType = TunnelMonitoringTypeBfd.class;
 543             }
 544         }
 545         if (!storedTunnelMonitor.isPresent() || storedTunnelMonitor.get().isEnabled() != monitorEnabled) {
 546             TunnelMonitorParams tunnelMonitor = new TunnelMonitorParamsBuilder().setEnabled(monitorEnabled)
 547                     .setMonitorProtocol(monitorType).build();
 548             Futures.addCallback(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION,
 549                 tx -> tx.merge(path, tunnelMonitor, true)), ItmUtils.DEFAULT_WRITE_CALLBACK,
 550                 MoreExecutors.directExecutor());
 551         }
 552     }
 553
 554     public void configureTunnelMonitorInterval(int interval) {
 555         InstanceIdentifier<TunnelMonitorInterval> path =
 556                 InstanceIdentifier.builder(TunnelMonitorInterval.class).build();
 557         Optional<TunnelMonitorInterval> storedTunnelMonitor = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path,
 558                 dataBroker);
 559         if (!storedTunnelMonitor.isPresent() || storedTunnelMonitor.get().getInterval().toJava() != interval) {
 560             TunnelMonitorInterval tunnelMonitor = new TunnelMonitorIntervalBuilder().setInterval(interval).build();
 561             Futures.addCallback(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION,
 562                 tx -> tx.merge(path, tunnelMonitor, true)), ItmUtils.DEFAULT_WRITE_CALLBACK,
 563                 MoreExecutors.directExecutor());
 564         }
 565     }
 566
 567     public void handleError(String errorMessage) throws TepException {
 568         throw new TepException(errorMessage);
 569     }
 570 }