FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
syslog.api
Go to the documentation of this file.
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 import "vnet/ip/ip_types.api";
18 
20 {
29 };
30 
31 /** \brief Set syslog sender configuration
32  @param client_index - opaque cookie to identify the sender
33  @param context - sender context, to match reply w/ request
34  @param src_address - IPv4 address of syslog sender (source)
35  @param collector_address - IPv4 address of syslog collector (destination)
36  @param collector_port - UDP port of syslog collector (destination) Default: 514
37  @param vrf_id - VRF/FIB table ID
38  @param max_msg_size - maximum message length. Default: 480
39 */
40 autoreply define syslog_set_sender
41 {
44  vl_api_ip4_address_t src_address;
45  vl_api_ip4_address_t collector_address;
46  u16 collector_port [default=514];
48  u32 max_msg_size [default=480];
49 };
50 
51 /** \brief Get syslog sender configuration
52  @param client_index - opaque cookie to identify the sender
53  @param context - sender context, to match reply w/ request
54 */
55 define syslog_get_sender
56 {
59 };
60 
61 /** \brief Get syslog sender configuration reply
62  @param context - sender context, to match reply w/ request
63  @param retval - return code for the request
64  @param src_address - IPv4 address of syslog sender (source)
65  @param collector_address - IPv4 address of syslog collector (destination)
66  @param collector_port - UDP port of syslog collector (destination)
67  @param vrf_id - VRF/FIB table ID
68  @param max_msg_size - maximum message length
69 */
70 define syslog_get_sender_reply
71 {
74  vl_api_ip4_address_t src_address;
75  vl_api_ip4_address_t collector_address;
79 };
80 
81 /** \brief Set syslog filter
82  @param client_index - opaque cookie to identify the sender
83  @param context - sender context, to match reply w/ request
84  @param severity - severity filter (specified severity and greater match)
85 */
86 autoreply define syslog_set_filter
87 {
90  vl_api_syslog_severity_t severity;
91  };
92 
93 /** \brief Get syslog filter
94  @param client_index - opaque cookie to identify the sender
95  @param context - sender context, to match reply w/ request
96 */
97 define syslog_get_filter
98 {
101 };
102 
103 /** \brief Get syslog filter reply
104  @param context - sender context, to match reply w/ request
105  @param retval - return code for the request
106  @param severity - severity filter (specified severity and greater match)
107 */
108 define syslog_get_filter_reply
109 {
112  vl_api_syslog_severity_t severity;
113 };
114 
115 /*
116  * Local Variables:
117  * eval: (c-set-style "gnu")
118  * End:
119  */
vl_api_syslog_get_sender_reply_t::max_msg_size
u32 max_msg_size
Definition: syslog.api:78
vl_api_syslog_set_filter_t::client_index
u32 client_index
Definition: syslog.api:88
SYSLOG_API_SEVERITY_CRIT
@ SYSLOG_API_SEVERITY_CRIT
Definition: syslog.api:23
vl_api_syslog_set_sender_t::context
u32 context
Definition: syslog.api:43
vl_api_syslog_set_sender_t::collector_port
u16 collector_port[default=514]
Definition: syslog.api:46
SYSLOG_API_SEVERITY_DBG
@ SYSLOG_API_SEVERITY_DBG
Definition: syslog.api:28
vl_api_syslog_get_sender_reply_t
Get syslog sender configuration reply.
Definition: syslog.api:70
u16
unsigned short u16
Definition: types.h:57
SYSLOG_API_SEVERITY_NOTICE
@ SYSLOG_API_SEVERITY_NOTICE
Definition: syslog.api:26
vl_api_syslog_get_filter_reply_t::retval
i32 retval
Definition: syslog.api:111
SYSLOG_API_SEVERITY_EMERG
@ SYSLOG_API_SEVERITY_EMERG
Definition: syslog.api:21
vl_api_syslog_get_sender_reply_t::src_address
vl_api_ip4_address_t src_address
Definition: syslog.api:74
i32
signed int i32
Definition: types.h:77
vl_api_syslog_get_filter_t
Get syslog filter.
Definition: syslog.api:97
vl_api_syslog_get_sender_t::client_index
u32 client_index
Definition: syslog.api:57
vl_api_syslog_set_sender_t::collector_address
vl_api_ip4_address_t collector_address
Definition: syslog.api:45
vl_api_syslog_get_filter_t::client_index
u32 client_index
Definition: syslog.api:99
vl_api_syslog_get_sender_reply_t::collector_address
vl_api_ip4_address_t collector_address
Definition: syslog.api:75
SYSLOG_API_SEVERITY_ERR
@ SYSLOG_API_SEVERITY_ERR
Definition: syslog.api:24
vl_api_syslog_get_sender_reply_t::collector_port
u16 collector_port
Definition: syslog.api:76
vl_api_syslog_get_filter_t::context
u32 context
Definition: syslog.api:100
vl_api_syslog_set_filter_t
Set syslog filter.
Definition: syslog.api:86
SYSLOG_API_SEVERITY_WARN
@ SYSLOG_API_SEVERITY_WARN
Definition: syslog.api:25
vl_api_syslog_set_sender_t
Set syslog sender configuration.
Definition: syslog.api:40
vl_api_syslog_get_filter_reply_t
Get syslog filter reply.
Definition: syslog.api:108
vl_api_syslog_set_sender_t::src_address
vl_api_ip4_address_t src_address
Definition: syslog.api:44
syslog_severity
syslog_severity
Definition: syslog.api:19
vl_api_syslog_get_sender_reply_t::vrf_id
u32 vrf_id
Definition: syslog.api:77
vl_api_syslog_get_sender_reply_t::retval
i32 retval
Definition: syslog.api:73
vl_api_syslog_set_sender_t::client_index
u32 client_index
Definition: syslog.api:42
u32
unsigned int u32
Definition: types.h:88
vl_api_syslog_get_sender_reply_t::context
u32 context
Definition: syslog.api:72
vl_api_syslog_set_sender_t::vrf_id
u32 vrf_id
Definition: syslog.api:47
vl_api_syslog_set_sender_t::max_msg_size
u32 max_msg_size[default=480]
Definition: syslog.api:48
SYSLOG_API_SEVERITY_ALERT
@ SYSLOG_API_SEVERITY_ALERT
Definition: syslog.api:22
vl_api_syslog_get_filter_reply_t::severity
vl_api_syslog_severity_t severity
Definition: syslog.api:112
SYSLOG_API_SEVERITY_INFO
@ SYSLOG_API_SEVERITY_INFO
Definition: syslog.api:27
vl_api_syslog_get_sender_t
Get syslog sender configuration.
Definition: syslog.api:55
vl_api_syslog_get_filter_reply_t::context
u32 context
Definition: syslog.api:110
vl_api_syslog_set_filter_t::severity
vl_api_syslog_severity_t severity
Definition: syslog.api:90
version
option version
Definition: syslog.api:16
vl_api_syslog_set_filter_t::context
u32 context
Definition: syslog.api:89
vl_api_syslog_get_sender_t::context
u32 context
Definition: syslog.api:58