summaryrefslogtreecommitdiffstats
path: root/src/vnet/syslog/syslog.api
blob: 556de61015d7f82538d97396966f0bf7e0eefea9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/*
 * Copyright (c) 2018 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

option version = "1.0.0";
import "vnet/ip/ip_types.api";

enum syslog_severity
{
  SYSLOG_API_SEVERITY_EMERG = 0,
  SYSLOG_API_SEVERITY_ALERT = 1,
  SYSLOG_API_SEVERITY_CRIT = 2,
  SYSLOG_API_SEVERITY_ERR = 3,
  SYSLOG_API_SEVERITY_WARN = 4,
  SYSLOG_API_SEVERITY_NOTICE = 5,
  SYSLOG_API_SEVERITY_INFO = 6,
  SYSLOG_API_SEVERITY_DBG = 7,
};

/** \brief Set syslog sender configuration
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param src_address - IPv4 address of syslog sender (source)
    @param collector_address - IPv4 address of syslog collector (destination)
    @param collector_port - UDP port of syslog collector (destination) Default: 514
    @param vrf_id - VRF/FIB table ID
    @param max_msg_size - maximum message length. Default: 480
*/
autoreply define syslog_set_sender
{
  u32 client_index;
  u32 context;
  vl_api_ip4_address_t src_address;
  vl_api_ip4_address_t collector_address;
  u16 collector_port [default=514];
  u32 vrf_id;
  u32 max_msg_size [default=480];
};

/** \brief Get syslog sender configuration
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
*/
define syslog_get_sender
{
  u32 client_index;
  u32 context;
};

/** \brief Get syslog sender configuration reply
    @param context - sender context, to match reply w/ request
    @param retval - return code for the request
    @param src_address - IPv4 address of syslog sender (source)
    @param collector_address - IPv4 address of syslog collector (destination)
    @param collector_port - UDP port of syslog collector (destination)
    @param vrf_id - VRF/FIB table ID
    @param max_msg_size - maximum message length
*/
define syslog_get_sender_reply
{
  u32 context;
  i32 retval;
  vl_api_ip4_address_t src_address;
  vl_api_ip4_address_t collector_address;
  u16 collector_port;
  u32 vrf_id;
  u32 max_msg_size;
};

/** \brief Set syslog filter
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param severity - severity filter (specified severity and greater match)
*/
autoreply define syslog_set_filter
{
  u32 client_index;
  u32 context;
  vl_api_syslog_severity_t severity;
 };

/** \brief Get syslog filter
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
*/
define syslog_get_filter
{
  u32 client_index;
  u32 context;
};

/** \brief Get syslog filter reply
    @param context - sender context, to match reply w/ request
    @param retval - return code for the request
    @param severity - severity filter (specified severity and greater match)
*/
define syslog_get_filter_reply
{
  u32 context;
  i32 retval;
  vl_api_syslog_severity_t severity;
};

/*
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
p46_address_initializer; ip46_address_t nh = ip46_address_initializer; u32 sw_if_index, nh_table_id; clib_error_t *error = NULL; int rv; sw_if_index = ~0; nh_table_id = 0; /* Get a line of input. */ if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "%U", unformat_vnet_sw_interface, vnet_get_main (), &sw_if_index)) ; else if (unformat (line_input, "peer %U", unformat_ip46_address, &peer)) ; else if (unformat (line_input, "nh %U", unformat_ip46_address, &nh)) ; else if (unformat (line_input, "nh-table-id %d", &nh_table_id)) ; else { error = clib_error_return (0, "unknown input `%U'", format_unformat_error, line_input); goto done; } } if (~0 == sw_if_index) { error = clib_error_return (0, "interface required'", format_unformat_error, line_input); goto done; } if (ip46_address_is_zero (&peer)) { error = clib_error_return (0, "peer required'", format_unformat_error, line_input); goto done; } if (ip46_address_is_zero (&nh)) { error = clib_error_return (0, "next-hop required'", format_unformat_error, line_input); goto done; } rv = teib_entry_add (sw_if_index, &peer, nh_table_id, &nh); if (rv) { error = clib_error_return_code (NULL, rv, 0, "NRHP error", format_unformat_error, line_input); } done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (teib_create_command, static) = { .path = "create teib", .short_help = "create teib <interface> peer <addr> nh <addr> [nh-table-id <ID>]", .function = teib_add, }; /* *INDENT-ON* */ static clib_error_t * teib_del (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { unformat_input_t _line_input, *line_input = &_line_input; ip46_address_t peer = ip46_address_initializer; clib_error_t *error = NULL; u32 sw_if_index; int rv; sw_if_index = ~0; /* Get a line of input. */ if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "%U", unformat_vnet_sw_interface, vnet_get_main (), &sw_if_index)) ; else if (unformat (line_input, "peer %U", unformat_ip46_address, &peer)) ; else { error = clib_error_return (0, "unknown input `%U'", format_unformat_error, line_input); goto done; } } if (~0 == sw_if_index) { error = clib_error_return (0, "interface required'", format_unformat_error, line_input); } if (ip46_address_is_zero (&peer)) { error = clib_error_return (0, "peer required'", format_unformat_error, line_input); goto done; } rv = teib_entry_del (sw_if_index, &peer); if (rv) { error = clib_error_return_code (NULL, rv, 0, "NRHP error", format_unformat_error, line_input); } done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (teib_delete_command, static) = { .path = "delete teib", .short_help = "delete teib <interface> peer <addr>", .function = teib_del, }; /* *INDENT-ON* */ static walk_rc_t teib_show_one (index_t nei, void *ctx) { vlib_cli_output (ctx, "%U", format_teib_entry, nei); return (WALK_CONTINUE); } static clib_error_t * teib_show (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { teib_walk (teib_show_one, vm); return (NULL); } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (teib_show_command, static) = { .path = "show teib", .short_help = "show teib", .function = teib_show, }; /* *INDENT-ON* */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */