src/vnet/dhcp/dhcp.api

   1 /*
   2  * Copyright (c) 2015-2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 vl_api_version 1.0.0
  17
  18 /** \brief DHCP Proxy config add / del request
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param rx_vrf_id - Rx/interface vrf id
  22     @param server_vrf_id - server vrf id
  23     @param if_ipv6 - ipv6 if non-zero, else ipv4
  24     @param is_add - add the config if non-zero, else delete
  25     @param insert_circuit_id - option82 suboption 1 fib number
  26     @param dhcp_server[] - server address
  27     @param dhcp_src_address[] - <fix this, need details>
  28 */
  29 autoreply define dhcp_proxy_config
  30 {
  31   u32 client_index;
  32   u32 context;
  33   u32 rx_vrf_id;
  34   u32 server_vrf_id;
  35   u8 is_ipv6;
  36   u8 is_add;
  37   u8 dhcp_server[16];
  38   u8 dhcp_src_address[16];
  39 };
  40
  41 /** \brief DHCP Proxy set / unset vss request
  42     @param client_index - opaque cookie to identify the sender
  43     @param context - sender context, to match reply w/ request
  44     @param tbl_id - table id
  45     @param oui - first part of vpn id
  46     @param fib_id - second part of vpn id
  47     @param is_ipv6 - ip6 if non-zero, else ip4
  48     @param is_add - set vss if non-zero, else delete
  49 */
  50 autoreply define dhcp_proxy_set_vss
  51 {
  52   u32 client_index;
  53   u32 context;
  54   u32 tbl_id;
  55   u32 oui;
  56   u32 fib_id;
  57   u8 is_ipv6;
  58   u8 is_add;
  59 };
  60
  61 /** \brief DHCP Client config add / del request
  62     @param client_index - opaque cookie to identify the sender
  63     @param context - sender context, to match reply w/ request
  64     @param sw_if_index - index of the interface for DHCP client
  65     @param hostname - hostname
  66     @param client_id - Client ID - option 61
  67     @param is_add - add the config if non-zero, else delete
  68     @param want_dhcp_event - DHCP event sent to the sender
  69            via dhcp_compl_event API message if non-zero
  70     @param pid - sender's pid
  71 */
  72 autoreply define dhcp_client_config
  73 {
  74   u32 client_index;
  75   u32 context;
  76   u32 sw_if_index;
  77   u8 hostname[64];
  78   u8 client_id[64];
  79   u8 is_add;
  80   u8 want_dhcp_event;
  81   u32 pid;
  82 };
  83
  84 /** \brief Tell client about a DHCP completion event
  85     @param client_index - opaque cookie to identify the sender
  86     @param pid - client pid registered to receive notification
  87     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
  88     @param mask_width - The length of the subnet mask assigned
  89     @param host_address - Host IP address
  90     @param router_address - Router IP address
  91     @param host_mac - Host MAC address
  92 */
  93 define dhcp_compl_event
  94 {
  95   u32 client_index;
  96   u32 pid;
  97   u8 hostname[64];
  98   u8 is_ipv6;
  99   u8 mask_width;
 100   u8 host_address[16];
 101   u8 router_address[16];
 102   u8 host_mac[6];
 103 };
 104
 105 /** \brief Dump DHCP proxy table
 106     @param client_index - opaque cookie to identify the sender
 107     @param True for IPv6 proxy table
 108 */
 109 define dhcp_proxy_dump
 110 {
 111   u32 client_index;
 112   u32 context;
 113   u8  is_ip6;
 114 };
 115
 116 typeonly manual_print manual_endian define dhcp_server
 117 {
 118   u32 server_vrf_id;
 119   u8 dhcp_server[16];
 120 };
 121
 122 /** \brief Tell client about a DHCP completion event
 123     @param client_index - opaque cookie to identify the sender
 124 */
 125 manual_endian manual_print define dhcp_proxy_details
 126 {
 127   u32 context;
 128   u32 rx_vrf_id;
 129   u32 vss_oui;
 130   u32 vss_fib_id;
 131   u8 is_ipv6;
 132   u8 dhcp_src_address[16];
 133   u8 count;
 134   vl_api_dhcp_server_t servers[count];
 135 };
 136
 137 /*
 138  * Local Variables:
 139  * eval: (c-set-style "gnu")
 140  * End:
 141  */