Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406

Interface ItmRpcService

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.RpcService
    All Known Implementing Classes:
    ItmManagerRpcService, ItmRpcTestImpl
    @Generated("mdsal-binding-generator")
public interface ItmRpcService
extends org.opendaylight.yangtools.yang.binding.RpcService
    Interface for implementing the following YANG RPCs defined in module itm-rpc 
     rpc get-tunnel-interface-name {
   input input {
     leaf source-dpid {
       type uint64;
     }
     leaf destination-dpid {
       type uint64;
     }
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
   output output {
     leaf interface-name {
       type string;
     }
   }
 }
 rpc get-internal-or-external-interface-name {
   input input {
     leaf source-dpid {
       type uint64;
     }
     leaf destination-ip {
       type inet:ip-address;
     }
     leaf destination-dpid {
       type uint64;
     }
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
   output output {
     leaf interface-name {
       type string;
     }
   }
 }
 rpc get-external-tunnel-interface-name {
   input input {
     leaf source-node {
       type string;
     }
     leaf destination-node {
       type string;
     }
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
   output output {
     leaf interface-name {
       type string;
     }
   }
 }
 rpc build-external-tunnel-from-dpns {
   input input {
     leaf-list dpn-id {
       type uint64;
     }
     leaf destination-ip {
       type inet:ip-address;
     }
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
 }
 rpc add-external-tunnel-endpoint {
   input input {
     leaf destination-ip {
       type inet:ip-address;
     }
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
 }
 rpc remove-external-tunnel-from-dpns {
   input input {
     leaf-list dpn-id {
       type uint64;
     }
     leaf destination-ip {
       type inet:ip-address;
     }
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
 }
 rpc remove-external-tunnel-endpoint {
   input input {
     leaf destination-ip {
       type inet:ip-address;
     }
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
 }
 rpc create-terminating-service-actions {
   input input {
     leaf dpn-id {
       type uint64;
     }
     leaf service-id {
       type uint16;
     }
     uses offlow:instruction-list;
   }
 }
 rpc remove-terminating-service-actions {
   input input {
     leaf dpn-id {
       type uint64;
     }
     leaf service-id {
       type uint16;
     }
   }
 }
 rpc add-l2-gw-device {
   input input {
     leaf topology-id {
       type string;
     }
     leaf node-id {
       type string;
     }
     leaf ip-address {
       type inet:ip-address;
     }
   }
 }
 rpc add-l2-gw-mlag-device {
   input input {
     leaf topology-id {
       type string;
     }
     leaf-list node-id {
       type string;
     }
     leaf ip-address {
       type inet:ip-address;
     }
   }
 }
 rpc delete-l2-gw-device {
   input input {
     leaf topology-id {
       type string;
     }
     leaf node-id {
       type string;
     }
     leaf ip-address {
       type inet:ip-address;
     }
   }
 }
 rpc delete-l2-gw-mlag-device {
   input input {
     leaf topology-id {
       type string;
     }
     leaf-list node-id {
       type string;
     }
     leaf ip-address {
       type inet:ip-address;
     }
   }
 }
 rpc is-tunnel-internal-or-external {
   input input {
     leaf tunnel-interface-name {
       type string;
     }
   }
   output output {
     leaf tunnel-type {
       type uint32;
     }
   }
 }
 rpc is-dcgw-present {
   input input {
     leaf dcgw-ip {
       type string;
     }
   }
   output output {
     leaf retVal {
       type uint32;
     }
   }
 }
 rpc get-dpn-endpoint-ips {
   input input {
     leaf source-dpid {
       type uint64;
     }
   }
   output output {
     leaf-list nexthopip-list {
       type inet:ip-address;
     }
   }
 }
 rpc get-egress-actions-for-tunnel {
   input input {
     leaf intf-name {
       type string;
     }
     leaf tunnel-key {
       type uint32;
       mandatory false;
     }
     leaf action-key {
       type int32;
       mandatory false;
     }
   }
   output output {
     uses action:action-list;
   }
 }
 rpc get-tunnel-type {
   input input {
     leaf intf-name {
       type string;
     }
   }
   output output {
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
 }
 rpc set-bfd-param-on-tunnel {
   input input {
     leaf source-node {
       type string;
     }
     leaf destination-node {
       type string;
     }
     leaf monitoring-enabled {
       type boolean;
     }
     leaf monitoring-interval {
       type uint16 {
         range 1000..30000;
       }
     }
   }
 }
 rpc get-dpn-info {
   input input {
     leaf-list compute-names {
       type string;
     }
   }
   output output {
     list computes {
       key compute-name;
       leaf compute-name {
         type string;
       }
       leaf zone-name {
         type string;
       }
       leaf prefix {
         type inet:ip-prefix;
       }
       leaf dpn-id {
         type uint64;
       }
       leaf-list tep-ip {
         type inet:ip-address;
       }
       leaf port-name {
         type string;
       }
       leaf node-id {
         type string;
       }
     }
   }
 }
 rpc get-watch-port-for-tunnel {
   input input {
     leaf source-node {
       type string;
     }
     leaf destination-node {
       type string;
     }
   }
   output output {
     leaf port-no {
       type uint32;
     }
     leaf portname {
       type string;
     }
   }
 }
 rpc get-tep-ip {
   input input {
     leaf dpn-id {
       type uint64;
     }
   }
   output output {
     leaf tep-ip {
       type inet:ip-address;
     }
   }
 }

    • Method Detail

      • getTunnelInterfaceName

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetTunnelInterfaceNameOutput>> getTunnelInterfaceName​(GetTunnelInterfaceNameInput input)
        Invoke get-tunnel-interface-name RPC. 
             
         used to retrieve tunnel interface id between Dpns
        Parameters:
        input - of get-tunnel-interface-name
        Returns:
        output of get-tunnel-interface-name

      • getInternalOrExternalInterfaceName

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetInternalOrExternalInterfaceNameOutput>> getInternalOrExternalInterfaceName​(GetInternalOrExternalInterfaceNameInput input)
        Invoke get-internal-or-external-interface-name RPC. 
             
         used to retrieve tunnel interface id with src Dpn and destination ip/dpn
        Parameters:
        input - of get-internal-or-external-interface-name
        Returns:
        output of get-internal-or-external-interface-name

      • getExternalTunnelInterfaceName

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetExternalTunnelInterfaceNameOutput>> getExternalTunnelInterfaceName​(GetExternalTunnelInterfaceNameInput input)
        Invoke get-external-tunnel-interface-name RPC. 
             
         used to retrieve external tunnel interface id between Dpns/TORs
        Parameters:
        input - of get-external-tunnel-interface-name
        Returns:
        output of get-external-tunnel-interface-name

      • buildExternalTunnelFromDpns

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<BuildExternalTunnelFromDpnsOutput>> buildExternalTunnelFromDpns​(BuildExternalTunnelFromDpnsInput input)
        Invoke build-external-tunnel-from-dpns RPC. 
             
         used for building tunnels between a Dpn and external node
        Parameters:
        input - of build-external-tunnel-from-dpns
        Returns:
        output of build-external-tunnel-from-dpns

      • addExternalTunnelEndpoint

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddExternalTunnelEndpointOutput>> addExternalTunnelEndpoint​(AddExternalTunnelEndpointInput input)
        Invoke add-external-tunnel-endpoint RPC. 
             
         used for building tunnels between teps on all Dpns and external node
        Parameters:
        input - of add-external-tunnel-endpoint
        Returns:
        output of add-external-tunnel-endpoint

      • removeExternalTunnelFromDpns

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveExternalTunnelFromDpnsOutput>> removeExternalTunnelFromDpns​(RemoveExternalTunnelFromDpnsInput input)
        Invoke remove-external-tunnel-from-dpns RPC. 
             
         used for building tunnels between a Dpn and external node
        Parameters:
        input - of remove-external-tunnel-from-dpns
        Returns:
        output of remove-external-tunnel-from-dpns

      • removeExternalTunnelEndpoint

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveExternalTunnelEndpointOutput>> removeExternalTunnelEndpoint​(RemoveExternalTunnelEndpointInput input)
        Invoke remove-external-tunnel-endpoint RPC. 
             
         used for building tunnels between teps on all Dpns and external node
        Parameters:
        input - of remove-external-tunnel-endpoint
        Returns:
        output of remove-external-tunnel-endpoint

      • createTerminatingServiceActions

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<CreateTerminatingServiceActionsOutput>> createTerminatingServiceActions​(CreateTerminatingServiceActionsInput input)
        Invoke create-terminating-service-actions RPC. 
             
         used for programming the terminating service actions
        Parameters:
        input - of create-terminating-service-actions
        Returns:
        output of create-terminating-service-actions

      • removeTerminatingServiceActions

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveTerminatingServiceActionsOutput>> removeTerminatingServiceActions​(RemoveTerminatingServiceActionsInput input)
        Invoke remove-terminating-service-actions RPC. 
             
         used for removing the terminating service actions
        Parameters:
        input - of remove-terminating-service-actions
        Returns:
        output of remove-terminating-service-actions

      • addL2GwDevice

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddL2GwDeviceOutput>> addL2GwDevice​(AddL2GwDeviceInput input)
        Invoke add-l2-gw-device RPC. 
             
         used for building tunnels between teps on all Dpns and hwVtep
        Parameters:
        input - of add-l2-gw-device
        Returns:
        output of add-l2-gw-device

      • addL2GwMlagDevice

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddL2GwMlagDeviceOutput>> addL2GwMlagDevice​(AddL2GwMlagDeviceInput input)
        Invoke add-l2-gw-mlag-device RPC. 
             
         used for building tunnels between teps on all Dpns and hwVtep
        Parameters:
        input - of add-l2-gw-mlag-device
        Returns:
        output of add-l2-gw-mlag-device

      • deleteL2GwDevice

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<DeleteL2GwDeviceOutput>> deleteL2GwDevice​(DeleteL2GwDeviceInput input)
        Invoke delete-l2-gw-device RPC. 
             
         used for deleting tunnels between teps on all Dpns and hwVtep
        Parameters:
        input - of delete-l2-gw-device
        Returns:
        output of delete-l2-gw-device

      • deleteL2GwMlagDevice

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<DeleteL2GwMlagDeviceOutput>> deleteL2GwMlagDevice​(DeleteL2GwMlagDeviceInput input)
        Invoke delete-l2-gw-mlag-device RPC. 
             
         used for deleting tunnels between teps on all Dpns and hwVtep
        Parameters:
        input - of delete-l2-gw-mlag-device
        Returns:
        output of delete-l2-gw-mlag-device

      • isTunnelInternalOrExternal

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<IsTunnelInternalOrExternalOutput>> isTunnelInternalOrExternal​(IsTunnelInternalOrExternalInput input)
        Invoke is-tunnel-internal-or-external RPC. 
             
         Used for determining whether tunnel is an internal or an external tunnel
        Parameters:
        input - of is-tunnel-internal-or-external
        Returns:
        output of is-tunnel-internal-or-external

      • isDcgwPresent

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<IsDcgwPresentOutput>> isDcgwPresent​(IsDcgwPresentInput input)
        Invoke is-dcgw-present RPC. 
             
         Used for determining whether tunnel is an internal or an external tunnel
        Parameters:
        input - of is-dcgw-present
        Returns:
        output of is-dcgw-present

      • getDpnEndpointIps

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetDpnEndpointIpsOutput>> getDpnEndpointIps​(GetDpnEndpointIpsInput input)
        Invoke get-dpn-endpoint-ips RPC. 
             
         used to retrieve tunnel end point IPs of a Dpn
        Parameters:
        input - of get-dpn-endpoint-ips
        Returns:
        output of get-dpn-endpoint-ips

      • getEgressActionsForTunnel

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetEgressActionsForTunnelOutput>> getEgressActionsForTunnel​(GetEgressActionsForTunnelInput input)
        Invoke get-egress-actions-for-tunnel RPC. 
             
         used to retrieve group actions to use from interface name
        Parameters:
        input - of get-egress-actions-for-tunnel
        Returns:
        output of get-egress-actions-for-tunnel

      • getTunnelType

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetTunnelTypeOutput>> getTunnelType​(GetTunnelTypeInput input)
        Invoke get-tunnel-type RPC. 
             
         to get the type of the tunnel interface(vxlan, vxlan-gpe, gre, etc.)
        Parameters:
        input - of get-tunnel-type
        Returns:
        output of get-tunnel-type

      • setBfdParamOnTunnel

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<SetBfdParamOnTunnelOutput>> setBfdParamOnTunnel​(SetBfdParamOnTunnelInput input)
        Invoke set-bfd-param-on-tunnel RPC. 
             
         used for turning ON/OFF to monitor individual tunnels
        Parameters:
        input - of set-bfd-param-on-tunnel
        Returns:
        output of set-bfd-param-on-tunnel

      • getDpnInfo

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetDpnInfoOutput>> getDpnInfo​(GetDpnInfoInput input)
        Invoke get-dpn-info RPC. 
             
         Gets the dpn id and tep ip information of compute nodes
        Parameters:
        input - of get-dpn-info
        Returns:
        output of get-dpn-info

      • getWatchPortForTunnel

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetWatchPortForTunnelOutput>> getWatchPortForTunnel​(GetWatchPortForTunnelInput input)
        Invoke get-watch-port-for-tunnel RPC. 
             
         retrieve the watch port for the BFD enabled point to point tunnel
        Parameters:
        input - of get-watch-port-for-tunnel
        Returns:
        output of get-watch-port-for-tunnel

      • getTepIp

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetTepIpOutput>> getTepIp​(GetTepIpInput input)
        Invoke get-tep-ip RPC. 
             
         used to retrieve local tep ip to use from DPNID
        Parameters:
        input - of get-tep-ip
        Returns:
        output of get-tep-ip