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