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

Interface OdlInterfaceRpcService

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.RpcService
    All Known Implementing Classes:
    InterfaceManagerRpcService
    @Generated("mdsal-binding-generator")
public interface OdlInterfaceRpcService
extends org.opendaylight.yangtools.yang.binding.RpcService
    Interface for implementing the following YANG RPCs defined in module odl-interface-rpc 
     rpc get-dpid-from-interface {
   input input {
     leaf intf-name {
       type string;
     }
   }
   output output {
     leaf dpid {
       type uint64;
     }
   }
 }
 rpc get-port-from-interface {
   input input {
     leaf intf-name {
       type string;
     }
   }
   output output {
     leaf dpid {
       type uint64;
     }
     leaf portno {
       type uint32;
     }
     leaf portname {
       type string;
     }
     leaf phy-address {
       type string;
     }
   }
 }
 rpc get-egress-actions-for-interface {
   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-egress-instructions-for-interface {
   input input {
     leaf intf-name {
       type string;
     }
     leaf tunnel-key {
       type uint32;
       mandatory false;
     }
   }
   output output {
     uses offlow:instruction-list;
   }
 }
 rpc get-endpoint-ip-for-dpn {
   input input {
     leaf dpid {
       type uint64;
     }
   }
   output output {
     leaf-list local-ips {
       type inet:ip-address;
     }
   }
 }
 rpc get-interface-type {
   input input {
     leaf intf-name {
       type string;
     }
   }
   output output {
     leaf interface-type {
       type identityref {
         base interface-type;
       }
     }
   }
 }
 rpc get-tunnel-type {
   input input {
     leaf intf-name {
       type string;
     }
   }
   output output {
     leaf tunnel-type {
       type identityref {
         base tunnel-type-base;
       }
     }
   }
 }
 rpc get-nodeconnector-id-from-interface {
   input input {
     leaf intf-name {
       type string;
     }
   }
   output output {
     leaf nodeconnector-id {
       type inv:node-connector-id;
     }
   }
 }
 rpc get-interface-from-if-index {
   input input {
     leaf if-index {
       type int32;
     }
   }
   output output {
     leaf interface-name {
       type string;
     }
   }
 }
 rpc get-dpn-interface-list {
   input input {
     leaf dpid {
       type uint64;
     }
   }
   output output {
     list interfaces {
       leaf interface-name {
         type string;
       }
       leaf interface-type {
         type identityref {
           base interface-type;
         }
       }
     }
   }
 }

    • Method Detail

      • getDpidFromInterface

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetDpidFromInterfaceOutput>> getDpidFromInterface​(GetDpidFromInterfaceInput input)
        Invoke get-dpid-from-interface RPC. 
             
         used to retrieve dpid from interface name
        Parameters:
        input - of get-dpid-from-interface
        Returns:
        output of get-dpid-from-interface

      • getPortFromInterface

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetPortFromInterfaceOutput>> getPortFromInterface​(GetPortFromInterfaceInput input)
        Invoke get-port-from-interface RPC. 
             
         used to retrieve dpid from interface name
        Parameters:
        input - of get-port-from-interface
        Returns:
        output of get-port-from-interface

      • getEgressActionsForInterface

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

      • getEgressInstructionsForInterface

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetEgressInstructionsForInterfaceOutput>> getEgressInstructionsForInterface​(GetEgressInstructionsForInterfaceInput input)
        Invoke get-egress-instructions-for-interface RPC. 
             
         used to retrieve flow instructions to use from interface name
        Parameters:
        input - of get-egress-instructions-for-interface
        Returns:
        output of get-egress-instructions-for-interface

      • getEndpointIpForDpn

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetEndpointIpForDpnOutput>> getEndpointIpForDpn​(GetEndpointIpForDpnInput input)
        Invoke get-endpoint-ip-for-dpn RPC. 
             
         to get the local ip of the tunnel/trunk interface
        Parameters:
        input - of get-endpoint-ip-for-dpn
        Returns:
        output of get-endpoint-ip-for-dpn

      • getInterfaceType

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetInterfaceTypeOutput>> getInterfaceType​(GetInterfaceTypeInput input)
        Invoke get-interface-type RPC. 
             
         to get the type of the interface(vlan, vxlan, vxlan-gpe or gre)
        Parameters:
        input - of get-interface-type
        Returns:
        output of get-interface-type

      • 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

      • getNodeconnectorIdFromInterface

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetNodeconnectorIdFromInterfaceOutput>> getNodeconnectorIdFromInterface​(GetNodeconnectorIdFromInterfaceInput input)
        Invoke get-nodeconnector-id-from-interface RPC. 
             
         to get nodeconnector id associated with an interface
        Parameters:
        input - of get-nodeconnector-id-from-interface
        Returns:
        output of get-nodeconnector-id-from-interface

      • getInterfaceFromIfIndex

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetInterfaceFromIfIndexOutput>> getInterfaceFromIfIndex​(GetInterfaceFromIfIndexInput input)
        Invoke get-interface-from-if-index RPC. 
             
         to get interface associated with an if-index
        Parameters:
        input - of get-interface-from-if-index
        Returns:
        output of get-interface-from-if-index

      • getDpnInterfaceList

        @CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetDpnInterfaceListOutput>> getDpnInterfaceList​(GetDpnInterfaceListInput input)
        Invoke get-dpn-interface-list RPC. 
             
         used to retrieve interface list for a given Dpn
        Parameters:
        input - of get-dpn-interface-list
        Returns:
        output of get-dpn-interface-list