src/plugins/dhcp/dhcp6_pd_client_cp.api

   1 /*
   2  * Copyright (c) 2018 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 option version = "2.0.0";
  17
  18 import "vnet/interface_types.api";
  19 import "vnet/ip/ip_types.api";
  20
  21 /** \brief Enable/disable DHCPv6 PD client on interface
  22     @param client_index - opaque cookie to identify the sender
  23     @param context - sender context, to match reply w/ request
  24     @param sw_if_index - interface to enable/disable client on
  25     @param prefix_group - name of prefix group (relevant when 'enable' is 1)
  26     @param enable - 1 to enable, 0 to disable
  27 */
  28 autoreply define dhcp6_pd_client_enable_disable
  29 {
  30   u32 client_index;
  31   u32 context;
  32   vl_api_interface_index_t sw_if_index;
  33   string prefix_group[64];
  34   bool enable;
  35 };
  36
  37 /** \brief Add/delete IPv6 address optionally using available prefix
  38     @param client_index - opaque cookie to identify the sender
  39     @param context - sender context, to match reply w/ request
  40     @param sw_if_index - software interface index of interface
  41                          to add/delete address to/from
  42     @param prefix_group - name of prefix group,
  43                           prefix_group[0] == '\0' means no prefix should be used
  44     @param address - address or suffix to be used with a prefix
  45                      from selected group
  46     @param prefix_length - subnet prefix for the address
  47     @param is_add - 1 for add, 0 for remove
  48 */
  49 autoreply define ip6_add_del_address_using_prefix
  50 {
  51   u32 client_index;
  52   u32 context;
  53   vl_api_interface_index_t sw_if_index;
  54   string prefix_group[64];
  55   vl_api_ip6_address_with_prefix_t address_with_prefix;
  56   bool is_add;
  57 };
  58
  59 /*
  60  * Local Variables:
  61  * eval: (c-set-style "gnu")
  62  * End:
  63  */