Interface VpnRpcService

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.RpcService
    All Known Implementing Classes:
    VpnRpcServiceImpl

    public interface VpnRpcService
    extends org.opendaylight.yangtools.yang.binding.RpcService
    Interface for implementing the following YANG RPCs defined in module vpn-rpc
     rpc add-static-route {
       input input {
         leaf vpnInstanceName {
           type string;
         }
         leaf destination {
           type string;
         }
         leaf nexthop {
           type string;
         }
         leaf label {
           type uint32;
         }
       }
       output output {
         leaf label {
           type uint32;
         }
       }
     }
     rpc remove-static-route {
       input input {
         leaf vpnInstanceName {
           type string;
         }
         leaf destination {
           type string;
         }
         leaf nexthop {
           type string;
         }
       }
     }
     rpc generate-vpn-label {
       input input {
         leaf vpn-name {
           type string;
         }
         leaf ip-prefix {
           type string;
         }
       }
       output output {
         leaf label {
           type uint32;
         }
       }
     }
     rpc remove-vpn-label {
       input input {
         leaf vpn-name {
           type string;
         }
         leaf ip-prefix {
           type string;
         }
       }
     }
     rpc apply-arp-config {
       input input {
         leaf enable-arp-learning {
           type boolean;
         }
       }
       output output {
         leaf enable-arp-learning {
           type boolean;
         }
       }
     }
     
    • Method Detail

      • addStaticRoute

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddStaticRouteOutput>> addStaticRoute​(AddStaticRouteInput input)
        Creates a static route in a VPN, creating a new label if needed
      • removeStaticRoute

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveStaticRouteOutput>> removeStaticRoute​(RemoveStaticRouteInput input)
        Removes a static route in a VPN, identified by this vpn name, destination and nexthop. Nextop is optional. If specified, the RPC will just remove one of the nexthops in the route (ECMP feature). If not specified, the whole route will be removed
      • generateVpnLabel

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GenerateVpnLabelOutput>> generateVpnLabel​(GenerateVpnLabelInput input)
        to generate label for the given ip prefix from the associated VPN
      • removeVpnLabel

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveVpnLabelOutput>> removeVpnLabel​(RemoveVpnLabelInput input)
        to remove label for the given ip prefix from the associated VPN
      • applyArpConfig

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<ApplyArpConfigOutput>> applyArpConfig​(ApplyArpConfigInput input)
        To apply ARP/GARP related configuration per PL