X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fdhcp%2Fdhcp.api;h=6db9033a7f477c8554a11c5988ff41f9e7026ca7;hb=038e1dfbd;hp=82c03fc33c831f380855b6771da2a2146b580ee4;hpb=81119e86bdf47f41f06218f91e52024bc4d00e7c;p=vpp.git diff --git a/src/vnet/dhcp/dhcp.api b/src/vnet/dhcp/dhcp.api index 82c03fc33c8..6db9033a7f4 100644 --- a/src/vnet/dhcp/dhcp.api +++ b/src/vnet/dhcp/dhcp.api @@ -15,6 +15,8 @@ option version = "2.0.1"; +import "vnet/ip/ip_types.api"; + /** \brief DHCP Proxy config add / del request @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -70,6 +72,7 @@ autoreply define dhcp_proxy_set_vss via dhcp_compl_event API message if non-zero @param set_broadcast_flag - in the DHCP Discover to control how the resulting OFFER is addressed. + @param dscp - DSCP value set in IP packets sent by the client @param pid - sender's pid */ typeonly define dhcp_client @@ -79,6 +82,7 @@ typeonly define dhcp_client u8 id[64]; u8 want_dhcp_event; u8 set_broadcast_flag; + vl_api_ip_dscp_t dscp; u32 pid; }; @@ -96,6 +100,14 @@ autoreply define dhcp_client_config vl_api_dhcp_client_t client; }; +/** \brief Struct representing domain server + @param address - IP address +*/ +typeonly manual_print manual_endian define domain_server +{ + u8 address[16]; +}; + /** \brief Data learned by the client during the DHCP process @param sw_if_index - the interface on which the client is configured @param state - the state of the lease (see dhcp_client_state_t) @@ -115,6 +127,8 @@ typeonly define dhcp_lease u8 host_address[16]; u8 router_address[16]; u8 host_mac[6]; + u8 count; + vl_api_domain_server_t domain_server[count]; }; /** \brief Tell client about a DHCP completion event @@ -186,6 +200,18 @@ manual_endian manual_print define dhcp_proxy_details vl_api_dhcp_server_t servers[count]; }; +/** \brief Set DHCPv6 DUID-LL + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param duid_ll - DUID-LL binary string +*/ +autoreply define dhcp6_duid_ll_set +{ + u32 client_index; + u32 context; + u8 duid_ll[10]; +}; + /** \brief Enable/disable listening on DHCPv6 client port @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -197,6 +223,18 @@ autoreply define dhcp6_clients_enable_disable u8 enable; }; +/** \brief Struct representing DHCPv6 address + @param address - address + @param valid_time - valid lifetime + @param preferred_time - preferred lifetime +*/ +typeonly define dhcp6_address_info +{ + u8 address[16]; + u32 valid_time; + u32 preferred_time; +}; + /** \brief Struct representing DHCPv6 PD prefix @param prefix - prefix @param prefix_length - prefix length @@ -211,6 +249,45 @@ typeonly define dhcp6_pd_prefix_info u32 preferred_time; }; +/** \brief Send DHCPv6 client message of specified type + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param sw_if_index - index of TX interface, also identifies IAID + @param server_index - used to dentify DHCPv6 server, + unique for each DHCPv6 server on the link, + value obrtained from dhcp6_reply_event API message, + use ~0 to send message to all DHCPv6 servers + @param irt - initial retransmission time + @param mrt - maximum retransmission time + @param mrc - maximum retransmission count + @param mrd - maximum retransmission duration + for sending the message + @param stop - if non-zero then stop resending the message, + otherwise start sending the message + @param msg_type - message type + @param T1 - value of T1 in IA_NA option + @param T2 - value of T2 in IA_NA option + @param n_addresses - number of addresses in IA_NA option + @param addresses - list of addresses in IA_NA option +*/ +autoreply define dhcp6_send_client_message +{ + u32 client_index; + u32 context; + u32 sw_if_index; + u32 server_index; + u32 irt; + u32 mrt; + u32 mrc; + u32 mrd; + u8 stop; + u8 msg_type; + u32 T1; + u32 T2; + u32 n_addresses; + vl_api_dhcp6_address_info_t addresses[n_addresses]; +}; + /** \brief Send DHCPv6 PD client message of specified type @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -250,11 +327,30 @@ autoreply define dhcp6_pd_send_client_message vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes]; }; +service { + rpc want_dhcp6_reply_events returns want_dhcp6_reply_events_reply + events dhcp6_reply_event; +}; + service { rpc want_dhcp6_pd_reply_events returns want_dhcp6_pd_reply_events_reply events dhcp6_pd_reply_event; }; +/** \brief Register for DHCPv6 reply events + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param enable_disable - 1 => register for events, 0 => cancel registration + @param pid - sender's pid +*/ +autoreply define want_dhcp6_reply_events +{ + u32 client_index; + u32 context; + u8 enable_disable; + u32 pid; +}; + /** \brief Register for DHCPv6 PD reply events @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -269,6 +365,37 @@ autoreply define want_dhcp6_pd_reply_events u32 pid; }; +/** \brief Tell client about a DHCPv6 server reply event + @param client_index - opaque cookie to identify the sender + @param pid - client pid registered to receive notification + @param sw_if_index - index of RX interface, also identifies IAID + @param server_index - used to dentify DHCPv6 server, + unique for each DHCPv6 server on the link + @param msg_type - message type + @param T1 - value of T1 in IA_NA option + @param T2 - value of T2 in IA_NA option + @param inner_status_code - value of status code inside IA_NA option + @param status_code - value of status code + @param preference - value of preference option in reply message + @param n_addresses - number of addresses in IA_NA option + @param addresses - list of addresses in IA_NA option +*/ +define dhcp6_reply_event +{ + u32 client_index; + u32 pid; + u32 sw_if_index; + u32 server_index; + u8 msg_type; + u32 T1; + u32 T2; + u16 inner_status_code; + u16 status_code; + u8 preference; + u32 n_addresses; + vl_api_dhcp6_address_info_t addresses[n_addresses]; +}; + /** \brief Tell client about a DHCPv6 PD server reply event @param client_index - opaque cookie to identify the sender @param pid - client pid registered to receive notification