FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
dns.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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 name resolution
19 
20  @param client_index - opaque cookie to identify the sender
21  @param context - sender context, to match reply w/ request
22  @param is_enable - 1 = enable, 0 = disable
23 */
24 autoreply manual_print define dns_enable_disable {
28  option vat_help = "[enable][disable]";
29 };
30 
31 /** \brief add or delete an upstream name server
32 
33  @param client_index - opaque cookie to identify the sender
34  @param context - sender context, to match reply w/ request
35  @param is_ip6 - an ip6 name server
36  @param is_add - add = 1, delete = 0
37  @param server_address - server ip address
38 */
39 autoreply manual_print define dns_name_server_add_del {
44  u8 server_address[16];
45  option vat_help = "<ip-address> [del]";
46 };
47 
48 /** \brief DNS name resolution request
49 
50  @param client_index - opaque cookie to identify the sender
51  @param context - sender context, to match reply w/ request
52  @param name - the name to resolve
53 */
54 manual_print define dns_resolve_name {
57  u8 name[256];
58  option vat_help = "<hostname>";
59  };
60 
61 /** \brief DNS name resolution reply
62 
63  @param client_index - opaque cookie to identify the sender
64  @param context - sender context, to match reply w/ request
65  @param retval - return value, 0 => success
66  @param ip4_set - indicates that the ip4 address is valid
67  @param ip6_set - indicates that the ip6 address is valid
68  @param ip4_address - the ip4 name resolution reply
69  @param ip6_address - the ip6 name resolution reply
70 */
71 define dns_resolve_name_reply {
78 };
79 
80 /** \brief DNS IP -> name resolution request
81 
82  @param client_index - opaque cookie to identify the sender
83  @param context - sender context, to match reply w/ request
84  @param is_ip6 - set if the reverse-DNS request is an ip6 address
85  @param address - the address to map to a name
86 */
87 manual_print define dns_resolve_ip {
91  u8 address[16];
92  option vat_help = "<ip4|ip6>";
93  };
94 
95 /** \brief DNS ip->name resolution reply
96 
97  @param client_index - opaque cookie to identify the sender
98  @param context - sender context, to match reply w/ request
99  @param retval - return value, 0 => success
100  @param name - canonical name for the indicated IP address
101 */
102 define dns_resolve_ip_reply {
105  u8 name[256];
106 };
manual_print typedef u8 ip4_address[4]
Definition: ip_types.api:18
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
string name[64]
Definition: ip.api:44
signed int i32
Definition: types.h:77
manual_print typedef address
Definition: ip_types.api:84
manual_print typedef u8 ip6_address[16]
Definition: ip_types.api:19
option version
Definition: dns.api:16
static int dns_enable_disable(dns_main_t *dm, int is_enable)
Definition: dns.c:71