acl_types.proto¶
Messages¶
AclKey¶
An ACL key is the combination of its name and ACL type.
EosSdk reference: eos::acl_key_t
| Name | Value | Description |
|---|---|---|
| acl_name | string | |
| acl_type | AclType |
AclPortSpec¶
A UDP or TCP port specifier.
EosSdk reference: eos::acl_port_spec_t
| Name | Value | Description |
|---|---|---|
| oneof oper_present.oper | AclRangeOperator | Default value is ACL_RANGE_ANY. |
| ports | repeated uint32 | Must be in range 0 to 65535. |
AclRuleBase¶
Contains common fields for ACL rules.
EosSdk reference: eos::acl_rule_base_t
| Name | Value | Description |
|---|---|---|
| oneof action_present.action | AclAction | Default value is ACL_PERMIT. |
| log | bool |
AclRuleEth¶
An Ethernet ACL rule which can be applied to Ethernet, Vlan and MLAG interfaces.
EosSdk reference: eos::acl_rule_eth_t
| Name | Value | Description |
|---|---|---|
| base_fields | AclRuleBase | |
| vlan | uint32 | Must be in range 0 to 65535. |
| oneof vlan_mask_present.vlan_mask | uint32 | Must be in range 0 to 65535. Default value is 0xFFF. |
| inner_vlan | uint32 | Must be in range 0 to 65535. |
| oneof inner_vlan_mask_present.inner_vlan_mask | uint32 | Must be in range 0 to 65535. Default value is 0xFFF. |
| source_addr | bytes | |
| destination_addr | bytes | |
| source_mask | bytes | |
| destination_mask | bytes | |
| oneof eth_protocol_present.eth_protocol | uint32 | Default value is 0xFFFFFFFF. |
AclRuleIp¶
An individual ACL rule for IPv4 or IPv6 ACLs.
EosSdk reference: eos::acl_rule_ip_t
| Name | Value | Description |
|---|---|---|
| base_fields | AclRuleBase | |
| vlan | uint32 | Must be in range 0 to 65535. |
| oneof vlan_mask_present.vlan_mask | uint32 | Must be in range 0 to 65535. Default value is 0xFFF. |
| inner_vlan | uint32 | Must be in range 0 to 65535. |
| oneof inner_vlan_mask_present.inner_vlan_mask | uint32 | Must be in range 0 to 65535. Default value is 0xFFF. |
| ip_protocol | uint32 | Must be in range 0 to 255. |
| ttl | AclTtlSpec | |
| source_addr | IpAddrMask | |
| destination_addr | IpAddrMask | |
| source_port | AclPortSpec | |
| destination_port | AclPortSpec | |
| nexthop_group | string | |
| tcp_flags | uint32 | Bitmask of TCP flags. Bits should match the desired flag values defined in the enum AclTcpFlag. Must be in range 0 to 65535. |
| oneof ip_type_present.ip_type | AclIpType | Default value is ACL_IP_TYPE_ANY. |
| established | bool | |
| oneof icmp_type_present.icmp_type | uint32 | Default value is 65535. |
| oneof icmp_code_present.icmp_code | uint32 | Must be in range 0 to 65535. Default value is 65535. |
| priority_value | uint32 | Must be in range 0 to 255. |
| priority_mask | uint32 | Must be in range 0 to 255. |
| match_fragments | bool | |
| match_ip_priority | bool |
AclTtlSpec¶
A TTL specifier, used in an IP ACL rule to define TTLs to match.
EosSdk reference: eos::acl_ttl_spec_t
| Name | Value | Description |
|---|---|---|
| oneof oper_present.oper | AclRangeOperator | Default value is ACL_RANGE_ANY. |
| ttl | uint32 | Must be in range 0 to 255. |
Enums¶
AclAction¶
The action to take for an individual ACL rule.
EosSdk reference: eos::acl_action_t
| Name | Value | Description |
|---|---|---|
| ACL_ACTION_NULL | 0 | |
| ACL_PERMIT | 1 | |
| ACL_DENY | 2 |
AclDirection¶
The direction in which an ACL is applied. Can apply to both directions by specifying them in two separate calls.
EosSdk reference: eos::acl_direction_t
| Name | Value | Description |
|---|---|---|
| ACL_DIRECTION_NULL | 0 | |
| ACL_IN | 1 | |
| ACL_OUT | 2 |
AclIpType¶
IP traffic type to be matched.
EosSdk reference: eos::acl_ip_type_t
| Name | Value | Description |
|---|---|---|
| ACL_IP_TYPE_NOT_SET | 0 | |
| ACL_IP_TYPE_ANY | 1 | |
| ACL_IP_TYPE_IP | 2 | |
| ACL_IP_TYPE_MPLS | 3 |
AclRangeOperator¶
The type of range operator for TTL and port specifications.
EosSdk reference: eos::acl_range_operator_t
| Name | Value | Description |
|---|---|---|
| ACL_RANGE_NULL | 0 | |
| ACL_RANGE_ANY | 1 | |
| ACL_RANGE_EQ | 2 | |
| ACL_RANGE_GT | 3 | |
| ACL_RANGE_LT | 4 | |
| ACL_RANGE_NEQ | 5 | |
| ACL_RANGE_BETWEEN | 6 |
AclTcpFlag¶
TCP flags used in IP rules to specify which TCP flags to match. Shows which bits correspond to which flags.
EosSdk reference: eos::acl_tcp_flag_t
| Name | Value | Description |
|---|---|---|
| ACL_TCP_NULL | 0 | |
| ACL_TCP_FIN | 1 | |
| ACL_TCP_SYN | 2 | |
| ACL_TCP_RST | 4 | |
| ACL_TCP_PSH | 8 | |
| ACL_TCP_ACK | 16 | |
| ACL_TCP_URG | 32 | |
| ACL_TCP_ECE | 64 | |
| ACL_TCP_CWR | 128 |
AclType¶
The ACL type.
EosSdk reference: eos::acl_type_t
| Name | Value | Description |
|---|---|---|
| ACL_TYPE_NULL | 0 | |
| ACL_TYPE_IPV4 | 1 | |
| ACL_TYPE_IPV6 | 2 | |
| ACL_TYPE_ETH | 3 | |
| ACL_TYPE_MPLS | 4 |