used to control the ACL plugin
*/
-option version = "1.0.1";
+option version = "2.0.0";
+
+import "plugins/acl/acl_types.api";
+import "vnet/interface_types.api";
/** \brief Get the plugin version
@param client_index - opaque cookie to identify the sender
u64 conn_table_max_entries;
};
-/** \brief Access List Rule entry
- @param is_permit - deny (0), permit (1), or permit+reflect(2) action on this rule.
- @param is_ipv6 - IP addresses in this rule are IPv6 (1) or IPv4 (0)
- @param src_ip_addr - Source prefix value
- @param src_ip_prefix_len - Source prefix length
- @param dst_ip_addr - Destination prefix value
- @param dst_ip_prefix_len - Destination prefix length
- @param proto - L4 protocol (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)
- @param srcport_or_icmptype_first - beginning of source port or ICMP4/6 type range
- @param srcport_or_icmptype_last - end of source port or ICMP4/6 type range
- @param dstport_or_icmpcode_first - beginning of destination port or ICMP4/6 code range
- @param dstport_or_icmpcode_last - end of destination port or ICMP4/6 code range
- @param tcp_flags_mask - if proto==6, match masked TCP flags with this value
- @param tcp_flags_value - if proto==6, mask to AND the TCP flags in the packet with
-*/
-
-typeonly manual_print define acl_rule
-{
- u8 is_permit;
- u8 is_ipv6;
- u8 src_ip_addr[16];
- u8 src_ip_prefix_len;
- u8 dst_ip_addr[16];
- u8 dst_ip_prefix_len;
-/*
- * L4 protocol. IANA number. 1 = ICMP, 58 = ICMPv6, 6 = TCP, 17 = UDP.
- * 0 => ignore L4 and ignore the ports/tcpflags when matching.
- */
- u8 proto;
-/*
- * If the L4 protocol is TCP or UDP, the below
- * hold ranges of ports, else if the L4 is ICMP/ICMPv6
- * they hold ranges of ICMP(v6) types/codes.
- *
- * Ranges are inclusive, i.e. to match "any" TCP/UDP port,
- * use first=0,last=65535. For ICMP(v6),
- * use first=0,last=255.
- */
- u16 srcport_or_icmptype_first;
- u16 srcport_or_icmptype_last;
- u16 dstport_or_icmpcode_first;
- u16 dstport_or_icmpcode_last;
-/*
- * for proto = 6, this matches if the
- * TCP flags in the packet, ANDed with tcp_flags_mask,
- * is equal to tcp_flags_value.
- */
- u8 tcp_flags_mask;
- u8 tcp_flags_value;
-};
-
-/** \brief MACIP Access List Rule entry
- @param is_permit - deny (0), permit (1) action on this rule.
- @param is_ipv6 - IP addresses in this rule are IPv6 (1) or IPv4 (0)
- @param src_mac - match masked source MAC address against this value
- @param src_mac_mask - AND source MAC address with this value before matching
- @param src_ip_addr - Source prefix value
- @param src_ip_prefix_len - Source prefix length
-*/
-
-typeonly manual_print define macip_acl_rule
-{
- u8 is_permit;
- u8 is_ipv6;
-/*
- * The source mac of the packet ANDed with src_mac_mask.
- * The source ip[46] address in the packet is matched
- * against src_ip_addr, with src_ip_prefix_len set to 0.
- *
- * For better performance, minimize the number of
- * (src_mac_mask, src_ip_prefix_len) combinations
- * in a MACIP ACL.
- */
- u8 src_mac[6];
- u8 src_mac_mask[6];
- u8 src_ip_addr[16];
- u8 src_ip_prefix_len;
-};
-
/** \brief Replace an existing ACL in-place or create a new ACL
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@r - Rules for this access-list
*/
-manual_print manual_endian define acl_add_replace
+ define acl_add_replace
{
u32 client_index;
u32 context;
u32 acl_index; /* ~0 to add, existing ACL# to replace */
- u8 tag[64]; /* What gets in here gets out in the corresponding tag field when dumping the ACLs. */
+ string tag[64]; /* What gets in here gets out in the corresponding tag field when dumping the ACLs. */
u32 count;
vl_api_acl_rule_t r[count];
+ option vat_help = "<acl-idx> <permit|permit+reflect|deny|action N> [src IP/plen] [dst IP/plen] [sport X-Y] [dport X-Y] [proto P] [tcpflags FL MASK], ... , ...";
};
/** \brief Reply to add/replace ACL
@param acl_index - ACL index to delete
*/
-autoreply manual_print define acl_del
+autoreply define acl_del
{
u32 client_index;
u32 context;
u32 acl_index;
+ option vat_help = "<acl-idx>";
};
/* acl_interface_add_del(_reply) to be deprecated in lieu of acl_interface_set_acl_list */
@param acl_index - index of ACL for the operation
*/
-autoreply manual_print define acl_interface_add_del
+autoreply define acl_interface_add_del
{
u32 client_index;
u32 context;
- u8 is_add;
+ bool is_add [default=true];
/*
* is_input = 0 => ACL applied on interface egress
* is_input = 1 => ACL applied on interface ingress
*/
- u8 is_input;
- u32 sw_if_index;
+ bool is_input;
+ vl_api_interface_index_t sw_if_index;
u32 acl_index;
+ option vat_help = "<intfc> | sw_if_index <if-idx> [add|del] [input|output] acl <acl-idx>";
};
/** \brief Set the vector of input/output ACLs checked for an interface
@param acls - vector of ACL indices
*/
-autoreply manual_print define acl_interface_set_acl_list
+autoreply define acl_interface_set_acl_list
{
u32 client_index;
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
u8 count;
u8 n_input; /* First n_input ACLs are set as a list of input ACLs, the rest are applied as output */
u32 acls[count];
+ option vat_help = "<intfc> | sw_if_index <if-idx> input [acl-idx list] output [acl-idx list]";
};
/** \brief Reply to set the ACL list on an interface
u32 client_index;
u32 context;
u32 acl_index; /* ~0 for all ACLs */
+ option vat_help = "[<acl-idx>]";
};
/** \brief Details about a single ACL contents
@param r - Array of rules within this ACL
*/
-manual_endian manual_print define acl_details
+define acl_details
{
u32 context;
u32 acl_index;
- u8 tag[64]; /* Same blob that was supplied to us when creating the ACL, one hopes. */
+ string tag[64]; /* Same blob that was supplied to us when creating the ACL, one hopes. */
u32 count;
vl_api_acl_rule_t r[count];
};
/** \brief Dump the list(s) of ACL applied to specific or all interfaces
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param sw_if_index - interface to dump the ACL list for
+ @param sw_if_index - interface for which to dump the ACL list. Default: 0xffffffff (All interfaces)
*/
define acl_interface_list_dump
{
u32 client_index;
u32 context;
- u32 sw_if_index; /* ~0 for all interfaces */
+ vl_api_interface_index_t sw_if_index [default=0xffffffff];
+ option vat_help = "[<intfc> | sw_if_index <if-idx>]";
};
/** \brief Details about a single ACL contents
define acl_interface_list_details
{
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
u8 count;
u8 n_input;
u32 acls[count];
@param r - vector of MACIP ACL rules
*/
-manual_endian manual_print define macip_acl_add
+define macip_acl_add
{
u32 client_index;
u32 context;
- u8 tag[64];
+ string tag[64];
u32 count;
vl_api_macip_acl_rule_t r[count];
+ option vat_help = "...";
};
/** \brief Reply to add MACIP ACL
/** \brief Add/Replace a MACIP ACL
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param acl_index - an existing MACIP ACL entry (0..0xfffffffe) to replace, or 0xffffffff to make new MACIP ACL
+ @param acl_index - an existing MACIP ACL entry (0..0xfffffffe) to replace, or 0xffffffff to make new MACIP ACL Default: 0xffffffff
@param tag - descriptive value for this MACIP ACL
@param count - number of rules in this MACIP ACL
@param r - vector of MACIP ACL rules
*/
-manual_endian manual_print define macip_acl_add_replace
+define macip_acl_add_replace
{
u32 client_index;
u32 context;
- u32 acl_index; /* ~0 to add, existing MACIP ACL# to replace */
- u8 tag[64];
+ u32 acl_index [default=0xffffffff]; /* ~0 to add, existing MACIP ACL# to replace */
+ string tag[64];
u32 count;
vl_api_macip_acl_rule_t r[count];
+ option vat_help = "<acl-idx> <permit|deny|action N> [count <count>] [src] ip <ipaddress/[plen]> mac <mac> mask <mac_mask>, ... , ...";
};
/** \brief Reply to add/replace MACIP ACL
@param acl_index - MACIP ACL index to delete
*/
-autoreply manual_print define macip_acl_del
+autoreply define macip_acl_del
{
u32 client_index;
u32 context;
u32 acl_index;
+ option vat_help = "<acl-idx>";
};
/** \brief Add or delete a MACIP ACL to/from interface
@param acl_index - MACIP ACL index
*/
-autoreply manual_print define macip_acl_interface_add_del
+autoreply define macip_acl_interface_add_del
{
u32 client_index;
u32 context;
- u8 is_add;
+ bool is_add [default=true];
/* MACIP ACLs are always input */
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
u32 acl_index;
+ option vat_help = "<intfc> | sw_if_index <if-idx> [add|del] acl <acl-idx>";
};
/** \brief Dump one or all defined MACIP ACLs
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param acl_index - MACIP ACL index or ~0 to dump all MACIP ACLs
+ @param acl_index - MACIP ACL index or ~0 to dump all MACIP ACLs Default: 0xffffffff
*/
define macip_acl_dump
{
u32 client_index;
u32 context;
- u32 acl_index; /* ~0 for all ACLs */
+ u32 acl_index [default=0xffffffff]; /* ~0 for all ACLs */
+ option vat_help = "[<acl-idx>]";
};
/** \brief Details about one MACIP ACL
@param r - rules comprising this MACIP ACL
*/
-manual_endian manual_print define macip_acl_details
+ define macip_acl_details
{
u32 context;
u32 acl_index;
- u8 tag[64];
+ string tag[64];
u32 count;
vl_api_macip_acl_rule_t r[count];
};
{
u32 client_index;
u32 context;
- u32 sw_if_index; /* ~0 for all interfaces */
+ vl_api_interface_index_t sw_if_index; /* ~0 for all interfaces */
};
/** \brief Details about a single MACIP ACL contents
define macip_acl_interface_list_details
{
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
u8 count;
u32 acls[count];
};
@param whitelist - vector of whitelisted ethertypes
*/
-autoreply manual_print define acl_interface_set_etype_whitelist
+autoreply define acl_interface_set_etype_whitelist
{
u32 client_index;
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
u8 count; /* Total number of ethertypes in the whitelist */
u8 n_input; /* first n_input ethertypes are input, the rest - output */
u16 whitelist[count];
+ option vat_help = "<intfc> | sw_if_index <if-idx> input [ethertype list] output [ethertype list]";
};
/** \brief Dump the list(s) of Ethertype whitelists applied to specific or all interfaces
{
u32 client_index;
u32 context;
- u32 sw_if_index; /* ~0 for all interfaces */
+ vl_api_interface_index_t sw_if_index; /* ~0 for all interfaces */
+ option vat_help = "[<intfc> | sw_if_index <if-idx>]";
};
/** \brief Details about ethertype whitelist on a single interface
define acl_interface_etype_whitelist_details
{
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
u8 count;
u8 n_input; /* first n_input ethertypes are input, the rest - output */
u16 whitelist[count];
u32 client_index;
u32 context;
bool enable;
+ option vat_help = "[disable]";
};