Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | OPEN_ACL_ASSIGNED_INTF_LIST_t |
ACL interface list. More... | |
struct | OPEN_ACL_ASSIGNED_VLAN_LIST_t |
ACL VLAN list. More... | |
struct | OPEN_ACL_INTF_DIR_LIST_t |
Interface ACL list. More... | |
struct | OPEN_ACL_INTF_LIST_INFO_t |
Interface ACL entry information. More... | |
struct | OPEN_ACL_VLAN_DIR_LIST_t |
VLAN ACL list. More... | |
struct | OPEN_ACL_VLAN_LIST_INFO_t |
VLAN ACL entry information. More... | |
Macros | |
#define | OPENAPI_ACL_IP_DSCP_AF11 10 |
Match packets with AF11 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF12 12 |
Match packets with AF12 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF13 14 |
Match packets with AF13 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF21 18 |
Match packets with AF21 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF22 20 |
Match packets with AF22 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF23 22 |
Match packets with AF23 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF31 26 |
Match packets with AF31 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF32 28 |
Match packets with AF32 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF33 30 |
Match packets with AF33 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF41 34 |
Match packets with AF41 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF42 36 |
Match packets with AF42 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_AF43 38 |
Match packets with AF43 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_BE 0 |
Match packets with BE DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_CS0 0 |
Match packets with CS0 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_CS1 8 |
Match packets with CS1 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_CS2 16 |
Match packets with CS2 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_CS3 24 |
Match packets with CS3 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_CS4 32 |
Match packets with CS4 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_CS5 40 |
Match packets with CS5 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_CS6 48 |
Match packets with CS6 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_CS7 56 |
Match packets with CS7 DSCP. | |
#define | OPENAPI_ACL_IP_DSCP_EF 46 |
Match packets with EF DSCP. | |
#define | OPENAPI_ACL_L4PORT_BGP 179 |
Border Gateway Protocol. | |
#define | OPENAPI_ACL_L4PORT_DOMAIN 53 |
Domain Name System. | |
#define | OPENAPI_ACL_L4PORT_ECHO 7 |
Echo Protocol. | |
#define | OPENAPI_ACL_L4PORT_FTP 21 |
File Transfer Control. | |
#define | OPENAPI_ACL_L4PORT_FTPDATA 20 |
File Transfer Data. | |
#define | OPENAPI_ACL_L4PORT_HTTP 80 |
Hypertext Transfer Protocol. | |
#define | OPENAPI_ACL_L4PORT_NTP 123 |
Network Time Protocol. | |
#define | OPENAPI_ACL_L4PORT_POP2 109 |
Post Office Protocol v2. | |
#define | OPENAPI_ACL_L4PORT_POP3 110 |
Post Office Protocol v3. | |
#define | OPENAPI_ACL_L4PORT_RIP 520 |
Routing Information Protocol. | |
#define | OPENAPI_ACL_L4PORT_SMTP 25 |
Simple Mail Transfer Protocol. | |
#define | OPENAPI_ACL_L4PORT_SNMP 161 |
Simple Network Management Protocol. | |
#define | OPENAPI_ACL_L4PORT_TELNET 23 |
Telnet Protocol. | |
#define | OPENAPI_ACL_L4PORT_TFTP 69 |
Trivial File Transfer Protocol. | |
#define | OPENAPI_ACL_L4PORT_TIME 37 |
TIME Protocol. | |
#define | OPENAPI_ACL_L4PORT_WHO 513 |
Who Protocol. | |
#define | OPENAPI_ACL_PROTOCOL_EIGRP 88 |
Enhanced Interior Gateway keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_GRE 47 |
Generic Routing Encapsulation keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_ICMP 1 |
Internet Control Message keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_ICMPV6 58 |
IPv6 Internet Control Message keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_IGMP 2 |
Internet Group Management keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_IP 255 |
Use reserved value. | |
#define | OPENAPI_ACL_PROTOCOL_IPINIP 94 |
IP Tunneling keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_OSPF 89 |
Open Shortest Path First keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_PIM 103 |
Protocol Independent Multicast keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_TCP 6 |
Transmission Control keyword value. | |
#define | OPENAPI_ACL_PROTOCOL_UDP 17 |
User Datagram keyword value. | |
#define | OPENAPI_ACL_TCP_FLAG_ACK 4 |
Acknowledge flag. | |
#define | OPENAPI_ACL_TCP_FLAG_FIN 0 |
Finish flag. | |
#define | OPENAPI_ACL_TCP_FLAG_PSH 3 |
Push flag. | |
#define | OPENAPI_ACL_TCP_FLAG_RST 2 |
Reset flag. | |
#define | OPENAPI_ACL_TCP_FLAG_SYN 1 |
Synchronize flag. | |
#define | OPENAPI_ACL_TCP_FLAG_URG 5 |
Urgent flag. | |
#define | OPENAPI_ETYPE_ID_APPLETALK 0x809B |
Appletalk Protocol. | |
#define | OPENAPI_ETYPE_ID_ARP 0x0806 |
Address Resolution Protocol. | |
#define | OPENAPI_ETYPE_ID_IBMSNA 0x80D5 |
IBM SNA Service over Ethernet. | |
#define | OPENAPI_ETYPE_ID_IPV4 0x0800 |
Internet Protocol version 4. | |
#define | OPENAPI_ETYPE_ID_IPV6 0x86DD |
Internet Protocol version 4. | |
#define | OPENAPI_ETYPE_ID_IPX 0x8037 |
Novell IPX. | |
#define | OPENAPI_ETYPE_ID_MPLSMCAST 0x8848 |
MPLS multicast. | |
#define | OPENAPI_ETYPE_ID_MPLSUCAST 0x8847 |
MPLS unicast. | |
#define | OPENAPI_ETYPE_ID_NETBIOS 0x8191 |
NetBIOS/NetBEUI. | |
#define | OPENAPI_ETYPE_ID_NOVELL_ID1 0x8137 |
Novell Netware 1st ID. | |
#define | OPENAPI_ETYPE_ID_NOVELL_ID2 0x8138 |
Novell Netware 2nd ID. | |
#define | OPENAPI_ETYPE_ID_PPPOE_ID1 0x8863 |
Novell Netware 1st ID. | |
#define | OPENAPI_ETYPE_ID_PPPOE_ID2 0x8864 |
Novell Netware 2nd ID. | |
#define | OPENAPI_ETYPE_ID_RARP 0x8035 |
Reverse Address Resolution Protocol. | |
Functions | |
open_error_t | openapiAclAssignedIntfDirListGet (openapiClientHandle_t *client_handle, uint32_t aclId, OPEN_ACL_DIRECTION_t dir, OPEN_ACL_ASSIGNED_INTF_LIST_t *intfList) |
Get the list of interfaces currently assigned to the specified ACL and direction. More... | |
open_error_t | openapiAclAssignedVlanDirListGet (openapiClientHandle_t *client_handle, uint32_t aclId, OPEN_ACL_DIRECTION_t dir, OPEN_ACL_ASSIGNED_VLAN_LIST_t *vlanList) |
Get the list of VLANs currently assigned to the specified ACL and direction. More... | |
open_error_t | openapiAclCountersAdminModeSet (openapiClientHandle_t *client_handle, uint32_t adminMode) |
Configures ACL counters admin mode. More... | |
open_error_t | openapiAclCountGet (openapiClientHandle_t *client_handle, uint32_t *aclCount) |
Get the current (total) number of configured ACLs. More... | |
open_error_t | openapiAclCreate (openapiClientHandle_t *client_handle, OPEN_ACL_TYPE_t aclType, open_buffdesc *aclName, uint32_t *aclId) |
Create a new Access List. More... | |
open_error_t | openapiAclDelete (openapiClientHandle_t *client_handle, uint32_t aclId) |
Delete an Access List. More... | |
open_error_t | openapiAclDeleteByName (openapiClientHandle_t *client_handle, OPEN_ACL_TYPE_t aclType, open_buffdesc *aclName) |
Delete an Access List by its name. More... | |
open_error_t | openapiAclGet (openapiClientHandle_t *client_handle, OPEN_ACL_TYPE_t aclType, open_buffdesc *aclName, uint32_t *aclId) |
Get the Access List identifier for the given ACL name. More... | |
open_error_t | openapiAclGetFirst (openapiClientHandle_t *client_handle, OPEN_ACL_TYPE_t aclType, uint32_t *aclId) |
Get the first named access list identifier created in the system. More... | |
open_error_t | openapiAclGetNext (openapiClientHandle_t *client_handle, OPEN_ACL_TYPE_t aclType, uint32_t aclId, uint32_t *nextAclId) |
Get the next named access list identifier created in the system. More... | |
open_error_t | openapiAclGlobalDelete (openapiClientHandle_t *client_handle, uint32_t asic, uint32_t aclId) |
Remove ACL from all interfaces. More... | |
open_error_t | openapiAclIntfDirAdd (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_ACL_DIRECTION_t dir, uint32_t aclId, uint32_t seqNum) |
Add an access list to the specified interface and direction. More... | |
open_error_t | openapiAclIntfDirDelete (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_ACL_DIRECTION_t dir, uint32_t aclId) |
Remove an access list from the specified interface and direction. More... | |
open_error_t | openapiAclIntfDirGetNext (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_ACL_DIRECTION_t dir, uint32_t *nextIntf, OPEN_ACL_DIRECTION_t *nextDir) |
Get next sequential interface and direction that is valid for use with an ACL. More... | |
open_error_t | openapiAclIntfDirListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_ACL_DIRECTION_t dir, OPEN_ACL_INTF_DIR_LIST_t *listInfo) |
Get the list of ACLs currently assigned to the specified interface and direction. More... | |
open_error_t | openapiAclIsDaclGet (openapiClientHandle_t *client_handle, OPEN_ACL_TYPE_t aclType, uint32_t aclId, OPEN_BOOL_t *isDacl) |
Get whether ACL is downloadable or not. More... | |
open_error_t | openapiAclIsIntfInUse (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_ACL_DIRECTION_t dir, OPEN_CONTROL_t *inUse) |
Check if an interface and direction is in use by any access list. More... | |
open_error_t | openapiAclIsVlanInUse (openapiClientHandle_t *client_handle, uint32_t vlan, OPEN_ACL_DIRECTION_t dir, OPEN_CONTROL_t *inUse) |
Check if a VLAN and direction is in use by any access list. More... | |
open_error_t | openapiAclMacCountGet (openapiClientHandle_t *client_handle, uint32_t *aclCount) |
Get the current number of configured MAC ACLs. More... | |
open_error_t | openapiAclMaxAclIntfCountGet (openapiClientHandle_t *client_handle, uint32_t *maxIntf) |
Get the maximum number of ACL Interfaces on this platform. More... | |
open_error_t | openapiAclMaxAclVlanCountGet (openapiClientHandle_t *client_handle, uint32_t *maxVlan) |
Get the maximum number of ACL VLANs on this platform. More... | |
open_error_t | openapiAclMaxAssignQueueGet (openapiClientHandle_t *client_handle, uint32_t *maxQueue) |
Get the maximum queue id value for a match criteria. More... | |
open_error_t | openapiAclMaxCountGet (openapiClientHandle_t *client_handle, uint32_t *maxACL) |
Get the maximum number of ACLs that can be configured. More... | |
open_error_t | openapiAclMaxIntfAclCountGet (openapiClientHandle_t *client_handle, uint32_t *maxACL) |
Get the maximum number of ACLs per interface on this platform. More... | |
open_error_t | openapiAclMaxMirrorIntfCountGet (openapiClientHandle_t *client_handle, uint32_t *maxIntf) |
Get the maximum mirror interface count for a match criteria. More... | |
open_error_t | openapiAclMaxRedirectIntfCountGet (openapiClientHandle_t *client_handle, uint32_t *maxIntf) |
Get the maximum redirect interface count for a match criteria. More... | |
open_error_t | openapiAclMaxVlanAclCountGet (openapiClientHandle_t *client_handle, uint32_t *maxACL) |
Get the maximum number of ACLs per VLAN on this platform. More... | |
open_error_t | openapiAclNameGet (openapiClientHandle_t *client_handle, uint32_t aclId, open_buffdesc *aclName) |
Get the Access List name for the given ACL. More... | |
open_error_t | openapiAclRename (openapiClientHandle_t *client_handle, uint32_t aclId, open_buffdesc *aclName) |
Change the Access List name. More... | |
open_error_t | openapiAclRouteFilter (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t routePrefix, uint32_t routeMask, OPEN_ACL_ACTION_t *aclAction) |
Apply an ACL as a route filter. More... | |
open_error_t | openapiAclRuleActionAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t *aclRule, OPEN_ACL_ACTION_t aclAction) |
Add a new rule and its associated action to the given ACL. More... | |
open_error_t | openapiAclRuleActionGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_ACTION_t *aclAction) |
Get the action for a rule. More... | |
open_error_t | openapiAclRuleCountersClear (openapiClientHandle_t *client_handle, uint32_t asic, uint32_t aclId, uint32_t ruleNum) |
Clear ACL rule counters. More... | |
open_error_t | openapiAclRuleCountGet (openapiClientHandle_t *client_handle, uint32_t asic, uint32_t aclId, uint32_t ruleNum, uint32_t ruleAction, uint64_t *hitPktCount) |
Get ACL rule hit count. More... | |
open_error_t | openapiAclRuleDelete (openapiClientHandle_t *client_handle, uint32_t asic, uint32_t aclId, uint32_t ruleId) |
Delete a specific rule from the given ACL. More... | |
open_error_t | openapiAclRuleDeleteLast (openapiClientHandle_t *client_handle, uint32_t aclId) |
Delete the last rule for the given ACL. More... | |
open_error_t | openapiAclRuleGetFirst (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t *aclRule) |
Get the rule for the given ACL. More... | |
open_error_t | openapiAclRuleGetNext (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *nextAclRule) |
Get the next rule for the given ACL. More... | |
open_error_t | openapiAclRuleGlobalApply (openapiClientHandle_t *client_handle, uint32_t asic, uint32_t aclId, uint32_t seqNum) |
Apply ACL rule to all interfaces. More... | |
open_error_t | openapiAclRuleMatchAssignQueueAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t queueId) |
Set the assigned queue id for an access list rule. More... | |
open_error_t | openapiAclRuleMatchAssignQueueGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *queueId) |
Gets the assigned queue id for an access list rule. More... | |
open_error_t | openapiAclRuleMatchDscpAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t dscp) |
Set the DSCP value for an access list rule. More... | |
open_error_t | openapiAclRuleMatchDscpGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *dscp) |
Gets the DSCP value for an access list rule. More... | |
open_error_t | openapiAclRuleMatchEveryAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool aclMatch) |
Set the match condition whereby all packets match for the ACL rule. More... | |
open_error_t | openapiAclRuleMatchEveryGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool *aclMatch) |
Gets the match-all (every) status for a rule. More... | |
open_error_t | openapiAclRuleMatchFlowLabelAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t label) |
Set the flow label for an access list rule. More... | |
open_error_t | openapiAclRuleMatchFlowLabelGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *label) |
Gets the flow label for an access list rule. More... | |
open_error_t | openapiAclRuleMatchFragmentsAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool fragments) |
Set the match condition to match on non-initial fragmented packets. More... | |
open_error_t | openapiAclRuleMatchFragmentsGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool *fragments) |
Get the match condition for non-initial fragmented packets. More... | |
open_error_t | openapiAclRuleMatchIcmpTypeCodeAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool addCode, uint32_t type, uint32_t code) |
Add a match condition for ICMP parameters to an existing access list rule. More... | |
open_error_t | openapiAclRuleMatchIcmpTypeCodeGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool getCode, uint32_t *type, uint32_t *code) |
Get the ICMP match condition parameters for an existing access list rule. More... | |
open_error_t | openapiAclRuleMatchIgmpTypeAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t type) |
Add a match condition for IGMP parameters to an existing access list rule. More... | |
open_error_t | openapiAclRuleMatchIgmpTypeGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *type) |
Get the IGMP match condition parameters for an existing access list rule. More... | |
open_error_t | openapiAclRuleMatchIpDstMaskAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_inet_addr_t addr, open_inet_addr_t mask) |
Add the destination IPv4 address and net mask. More... | |
open_error_t | openapiAclRuleMatchIpDstMaskGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_inet_addr_t *addr, open_inet_addr_t *mask) |
Gets the destination IPv4 address and net mask. More... | |
open_error_t | openapiAclRuleMatchIpSrcMaskAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_inet_addr_t addr, open_inet_addr_t mask) |
Add the source IPv4 address and net mask. More... | |
open_error_t | openapiAclRuleMatchIpSrcMaskGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_inet_addr_t *addr, open_inet_addr_t *mask) |
Gets the source IPv4 address and net mask. More... | |
open_error_t | openapiAclRuleMatchIpv6DstPfxAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_inet_addr_t addr, uint32_t pfxLen) |
Add the destination IPV6 address and prefix length. More... | |
open_error_t | openapiAclRuleMatchIpv6DstPfxGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_inet_addr_t *addr, uint32_t *pfxLen) |
Gets the destination IPV6 address and prefix length. More... | |
open_error_t | openapiAclRuleMatchIpv6SrcPfxAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_inet_addr_t addr, uint32_t pfxLen) |
Add the source IPV6 address and prefix length. More... | |
open_error_t | openapiAclRuleMatchIpv6SrcPfxGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_inet_addr_t *addr, uint32_t *pfxLen) |
Gets the source IPV6 address and prefix length. More... | |
open_error_t | openapiAclRuleMatchL4DstPortAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_L4_PORT_OPERATOR_t oper, uint32_t startPort, uint32_t endPort) |
Add a Layer 4 destination port match condition. More... | |
open_error_t | openapiAclRuleMatchL4DstPortGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_L4_PORT_OPERATOR_t *oper, uint32_t *startPort, uint32_t *endPort) |
Get a Layer 4 destination port match condition. More... | |
open_error_t | openapiAclRuleMatchL4SrcPortAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_L4_PORT_OPERATOR_t oper, uint32_t startPort, uint32_t endPort) |
Add a Layer 4 source port match condition. More... | |
open_error_t | openapiAclRuleMatchL4SrcPortGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_L4_PORT_OPERATOR_t *oper, uint32_t *startPort, uint32_t *endPort) |
Get a Layer 4 source port match condition. More... | |
open_error_t | openapiAclRuleMatchLoggingAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool aclLogging) |
Set the logging flag for an access list rule. More... | |
open_error_t | openapiAclRuleMatchLoggingGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool *aclLogging) |
Gets the logging flag from an existing access list rule entry. More... | |
open_error_t | openapiAclRuleMatchMacCos2Add (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t cos) |
Add a Secondary Class Of Server (COS) match condition. More... | |
open_error_t | openapiAclRuleMatchMacCos2Get (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *cos) |
Get the Secondary Class Of Server (COS) match condition. More... | |
open_error_t | openapiAclRuleMatchMacCosAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t cos) |
Add a Class Of Server (COS) match condition. More... | |
open_error_t | openapiAclRuleMatchMacCosGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *cos) |
Get the Class Of Server (COS) match condition. More... | |
open_error_t | openapiAclRuleMatchMacDstMacAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_buffdesc *mac, open_buffdesc *mask) |
Add the destination MAC address and mask. More... | |
open_error_t | openapiAclRuleMatchMacDstMacGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_buffdesc *mac, open_buffdesc *mask) |
Get the destination MAC address and mask. More... | |
open_error_t | openapiAclRuleMatchMacEtherTypeAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t type) |
Add a MAC Ethertype match condition. More... | |
open_error_t | openapiAclRuleMatchMacEtherTypeGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *type) |
Get the MAC Ethertype match condition. More... | |
open_error_t | openapiAclRuleMatchMacSecondaryVlanAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_VLAN_OPERATOR_t oper, uint32_t startId, uint32_t endId) |
Add a Secondary VLAN match condition. More... | |
open_error_t | openapiAclRuleMatchMacSecondaryVlanGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_VLAN_OPERATOR_t *oper, uint32_t *startId, uint32_t *endId) |
Get the Secondary VLAN match condition. More... | |
open_error_t | openapiAclRuleMatchMacSrcMacAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_buffdesc *mac, open_buffdesc *mask) |
Add the source MAC address and mask. More... | |
open_error_t | openapiAclRuleMatchMacSrcMacGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_buffdesc *mac, open_buffdesc *mask) |
Get the source MAC address and mask. More... | |
open_error_t | openapiAclRuleMatchMacVlanAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_VLAN_OPERATOR_t oper, uint32_t startId, uint32_t endId) |
Add a VLAN match condition. More... | |
open_error_t | openapiAclRuleMatchMacVlanGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_VLAN_OPERATOR_t *oper, uint32_t *startId, uint32_t *endId) |
Get the VLAN match condition. More... | |
open_error_t | openapiAclRuleMatchMirrorAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t intf) |
Set the mirror interface for an access list rule. More... | |
open_error_t | openapiAclRuleMatchMirrorAgentAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t agent) |
Add the mirror external agent id for an access list rule. More... | |
open_error_t | openapiAclRuleMatchMirrorAgentGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *agent) |
Get the mirror external agent id from an access list rule. More... | |
open_error_t | openapiAclRuleMatchMirrorGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *intf) |
Get the mirror interface from an existing access list rule entry. More... | |
open_error_t | openapiAclRuleMatchPrecedenceAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t precedence) |
Set the match condition precedence value. More... | |
open_error_t | openapiAclRuleMatchPrecedenceGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *precedence) |
Get the match condition for precedence value. More... | |
open_error_t | openapiAclRuleMatchProtocolAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t aclProtocol) |
Add a protocol to an existing access list rule. More... | |
open_error_t | openapiAclRuleMatchProtocolGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *aclProtocol) |
Gets the protocol from an existing access list rule entry. More... | |
open_error_t | openapiAclRuleMatchRateLimitAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t dataRate, uint32_t burstSize) |
Set the rate limit parameters for an access list rule. More... | |
open_error_t | openapiAclRuleMatchRateLimitGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *dataRate, uint32_t *burstSize) |
Get the rate limit parameters from an existing access list rule entry. More... | |
open_error_t | openapiAclRuleMatchRedirectAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t intf) |
Add the redirect interface for an access list rule. More... | |
open_error_t | openapiAclRuleMatchRedirectAgentAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t agent) |
Add the redirect external agent id for an access list rule. More... | |
open_error_t | openapiAclRuleMatchRedirectAgentGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *agent) |
Get the redirect agent Id from an access list rule. More... | |
open_error_t | openapiAclRuleMatchRedirectGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *intf) |
Get the redirect interface from an existing access list rule entry. More... | |
open_error_t | openapiAclRuleMatchRoutingAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool flag) |
Set the routing flag for an access list rule. More... | |
open_error_t | openapiAclRuleMatchRoutingGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool *flag) |
Get the routing flag for an access list rule. More... | |
open_error_t | openapiAclRuleMatchSflowSamplingAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool aclSflowSampling) |
Set the sFlow sampling flag for an access list rule. More... | |
open_error_t | openapiAclRuleMatchSflowSamplingGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, bool *aclSflowSampling) |
Gets the sFlow sampling flag from an existing access list rule entry. More... | |
open_error_t | openapiAclRuleMatchTcpFlagsAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t tcpVal, uint32_t tcpMask) |
Add a match condition using a TCP Control Flag and Mask. More... | |
open_error_t | openapiAclRuleMatchTcpFlagsGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, uint32_t *tcpVal, uint32_t *tcpMask) |
Get a match condition using a TCP Control Flag and Mask. More... | |
open_error_t | openapiAclRuleMatchTimeRangeAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_buffdesc *name) |
Add the time range name for an access list rule. More... | |
open_error_t | openapiAclRuleMatchTimeRangeGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_buffdesc *name) |
Get the time range name assigned to access list rule. More... | |
open_error_t | openapiAclRuleMatchTimeRangeStatusGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, OPEN_ACL_RULE_STATUS_t *status) |
Get the rule status of an access list rule entry. More... | |
open_error_t | openapiAclRuleMatchTosAdd (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_buffdesc *tos, open_buffdesc *tosMask) |
Add a match condition based on the value of the IP ToS field. More... | |
open_error_t | openapiAclRuleMatchTosGet (openapiClientHandle_t *client_handle, uint32_t aclId, uint32_t aclRule, open_buffdesc *tos, open_buffdesc *tosMask) |
Get the match condition for IP ToS field. More... | |
open_error_t | openapiAclVlanDirAdd (openapiClientHandle_t *client_handle, uint32_t vlan, OPEN_ACL_DIRECTION_t dir, uint32_t aclId, uint32_t seqNum) |
Add an access list to the specified VLAN and direction. More... | |
open_error_t | openapiAclVlanDirDelete (openapiClientHandle_t *client_handle, uint32_t vlan, OPEN_ACL_DIRECTION_t dir, uint32_t aclId) |
Remove an access list from the specified VLAN and direction. More... | |
open_error_t | openapiAclVlanDirListGet (openapiClientHandle_t *client_handle, uint32_t vlan, OPEN_ACL_DIRECTION_t dir, OPEN_ACL_VLAN_DIR_LIST_t *listInfo) |
Get the list of ACLs currently assigned to the specified VLAN and direction. More... | |
enum OPEN_ACL_ACTION_t |
Supported Action Types.
Enumerator | |
---|---|
OPEN_ACL_PERMIT |
Permit. |
OPEN_ACL_DENY |
Deny. |
Definition at line 133 of file openapi_acl.h.
enum OPEN_ACL_DIRECTION_t |
Callers to ACL API functions use these values for interface direction.
Enumerator | |
---|---|
OPEN_ACL_INBOUND_ACL |
Inbound. |
OPEN_ACL_OUTBOUND_ACL |
Outbound. |
OPEN_ACL_DIRECTION_TOTAL |
Total number of ACL directions defined. |
Definition at line 165 of file openapi_acl.h.
Layer 4 Port Operator Flags.
Definition at line 148 of file openapi_acl.h.
Time Range Status.
Enumerator | |
---|---|
OPEN_ACL_RULE_STATUS_NONE |
No State. |
OPEN_ACL_RULE_STATUS_INACTIVE |
Inactive. |
OPEN_ACL_RULE_STATUS_ACTIVE |
Active. |
Definition at line 140 of file openapi_acl.h.
enum OPEN_ACL_TYPE_t |
Supported Access List types.
Enumerator | |
---|---|
OPEN_ACL_TYPE_NONE |
Undefined. |
OPEN_ACL_TYPE_IP |
Named IP ACL. |
OPEN_ACL_TYPE_MAC |
Named MAC ACL. |
OPEN_ACL_TYPE_IPV6 |
Named IPv6 ACL. |
Definition at line 124 of file openapi_acl.h.
MAC VLAN Operator Flags.
Enumerator | |
---|---|
OPEN_ACL_VLAN_OPERATOR_EQUAL_TO |
Id equal. |
OPEN_ACL_VLAN_OPERATOR_RANGE |
Id range specified (start and end VLAN id) |
Definition at line 158 of file openapi_acl.h.
open_error_t openapiAclAssignedIntfDirListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
OPEN_ACL_ASSIGNED_INTF_LIST_t * | intfList | ||
) |
Get the list of interfaces currently assigned to the specified ACL and direction.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | dir | interface direction |
[out] | intfList | list of assigned interfaces |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. No more valid ACLs |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FULL | If the intfList->intf array is not large enough to hold the maximum number interfaces. |
OpEN API Version: 1.2
open_error_t openapiAclAssignedVlanDirListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
OPEN_ACL_ASSIGNED_VLAN_LIST_t * | vlanList | ||
) |
Get the list of VLANs currently assigned to the specified ACL and direction.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | dir | interface direction |
[out] | vlanList | list of VLANS ids |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. No more valid ACLs |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FULL | If the vlanList->vlan array is not large enough to hold the maximum number interfaces. |
OpEN API Version: 1.2
open_error_t openapiAclCountersAdminModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | adminMode | ||
) |
Configures ACL counters admin mode.
[in] | client_handle | client handle from registration API |
[in] | adminMode | admin mode |
OPEN_E_NONE | Delete successful. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_INTERNAL | if hardware update failed. |
OPEN_E_FAIL | Delete failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.14
open_error_t openapiAclCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | aclCount | ||
) |
Get the current (total) number of configured ACLs.
[in] | client_handle | client handle from registration API |
[out] | aclCount | Number of ACLs |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclCreate | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACL_TYPE_t | aclType, | ||
open_buffdesc * | aclName, | ||
uint32_t * | aclId | ||
) |
Create a new Access List.
[in] | client_handle | client handle from registration API |
[in] | aclType | ACL type |
[in] | aclName | ACL name |
- | Minimum value OPENAPI_ACL_NAME_LEN_MIN | |
- | Maximum value OPENAPI_ACL_NAME_LEN_MAX | |
[out] | aclId | Newly created ACL identifier |
OPEN_E_NONE | Create is successful |
OPEN_E_EXISTS | ACL name already exists |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | Another application has denied approval of this configuration change |
OPEN_E_FULL | If the maximum number of ACLs or rule nodes already created |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId | ||
) |
Delete an Access List.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
OPEN_E_NONE | Delete is successful. |
OPEN_E_FAIL | Delete failed |
OPEN_E_NOT_FOUND | ACL not found |
OPEN_E_ERROR | Another application has denied approval of this configuration change |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclDeleteByName | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACL_TYPE_t | aclType, | ||
open_buffdesc * | aclName | ||
) |
Delete an Access List by its name.
[in] | client_handle | client handle from registration API |
[in] | aclType | ACL type |
[in] | aclName | ACL name |
- | Minimum value OPENAPI_ACL_NAME_LEN_MIN | |
- | Maximum value OPENAPI_ACL_NAME_LEN_MAX |
OPEN_E_NONE | Delete is successful. |
OPEN_E_FAIL | Delete failed |
OPEN_E_NOT_FOUND | ACL not found |
OPEN_E_ERROR | Another application has denied approval of this configuration change |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACL_TYPE_t | aclType, | ||
open_buffdesc * | aclName, | ||
uint32_t * | aclId | ||
) |
Get the Access List identifier for the given ACL name.
[in] | client_handle | client handle from registration API |
[in] | aclType | ACL type |
[in] | aclName | ACL name |
- | Minimum value OPENAPI_ACL_NAME_LEN_MIN | |
- | Maximum value OPENAPI_ACL_NAME_LEN_MAX | |
[out] | aclId | ACL identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_NOT_FOUND | ACL name not found |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclGetFirst | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACL_TYPE_t | aclType, | ||
uint32_t * | aclId | ||
) |
Get the first named access list identifier created in the system.
[in] | client_handle | client handle from registration API |
[in] | aclType | ACL type |
[out] | aclId | ACL identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | No named ACLs exist in the system. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclGetNext | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACL_TYPE_t | aclType, | ||
uint32_t | aclId, | ||
uint32_t * | nextAclId | ||
) |
Get the next named access list identifier created in the system.
[in] | client_handle | client handle from registration API |
[in] | aclType | ACL type |
[in] | aclId | Last ACL identifier |
[out] | nextAclId | ACL identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | No more named ACLs |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclGlobalDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | asic, | ||
uint32_t | aclId | ||
) |
Remove ACL from all interfaces.
[in] | client_handle | client handle from registration API |
[in] | asic | unit |
[in] | aclId | ACL identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.14
open_error_t openapiAclIntfDirAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
uint32_t | aclId, | ||
uint32_t | seqNum | ||
) |
Add an access list to the specified interface and direction.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | dir | interface direction |
[in] | aclId | ACL identifier |
[in] | seqNum | the ACL evaluation order sequence number |
- | Minimum value OPENAPI_ACL_INTF_SEQ_NUM_MIN | |
- | Maximum value OPENAPI_ACL_INTF_SEQ_NUM_MAX |
OPEN_E_NONE | ACL successfully added intf and dir |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_EXISTS | intf and dir is already assigned an ACL |
OPEN_E_FAIL | Add failed or intf and dir is not ACL compatible. |
OPEN_E_FULL | ACL assignment is at capacity for intf and dir |
OPEN_E_INTERNAL | If hardware update failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
FD_CNFGR_NIM_MIN_CPU_INTF_NUM
OpEN API Version: 1.2
open_error_t openapiAclIntfDirDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
uint32_t | aclId | ||
) |
Remove an access list from the specified interface and direction.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | dir | interface direction |
[in] | aclId | ACL identifier |
OPEN_E_NONE | ACL successfully added intf and dir |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_FAIL | Add failed or intf and dir is not ACL compatible. |
OPEN_E_INTERNAL | If hardware update failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclIntfDirGetNext | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
uint32_t * | nextIntf, | ||
OPEN_ACL_DIRECTION_t * | nextDir | ||
) |
Get next sequential interface and direction that is valid for use with an ACL.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | dir | interface direction |
[out] | nextIntf | next internal interface number |
[out] | nextDir | next interface direction |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. No more valid interfaces for ACL |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclIntfDirListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
OPEN_ACL_INTF_DIR_LIST_t * | listInfo | ||
) |
Get the list of ACLs currently assigned to the specified interface and direction.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | dir | interface direction |
[out] | listInfo | list of assigned ACLs |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. No more valid ACLs |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FULL | If the listInfo->listEntry array is not large enough to hold the maximum ACL entries. |
OpEN API Version: 1.2
open_error_t openapiAclIsDaclGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_ACL_TYPE_t | aclType, | ||
uint32_t | aclId, | ||
OPEN_BOOL_t * | isDacl | ||
) |
Get whether ACL is downloadable or not.
[in] | client_handle | client handle from registration API |
[in] | aclType | ACL type |
[in] | aclId | ACL identifier |
[out] | isDacl | get whether ACL is downloadable or not |
OPEN_E_NONE | Getting Status successful |
OPEN_E_FAIL | Filed to get the dynamic ACL status |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.15
open_error_t openapiAclIsIntfInUse | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
OPEN_CONTROL_t * | inUse | ||
) |
Check if an interface and direction is in use by any access list.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | dir | interface direction |
[out] | inUse | true if at least one ACL is attached. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. No more valid interfaces for ACL |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclIsVlanInUse | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlan, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
OPEN_CONTROL_t * | inUse | ||
) |
Check if a VLAN and direction is in use by any access list.
[in] | client_handle | client handle from registration API |
[in] | vlan | VLAN id |
- | Minimum value OPENAPI_ACL_VLAN_ID_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_ID_MAX | |
[in] | dir | interface direction |
[out] | inUse | true if at least one ACL is attached. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. No more valid interfaces for ACL |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMacCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | aclCount | ||
) |
Get the current number of configured MAC ACLs.
[in] | client_handle | client handle from registration API |
[out] | aclCount | Number of ACLs |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMaxAclIntfCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxIntf | ||
) |
Get the maximum number of ACL Interfaces on this platform.
[in] | client_handle | client handle from registration API |
[out] | maxIntf | maximum number of interfaces. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMaxAclVlanCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxVlan | ||
) |
Get the maximum number of ACL VLANs on this platform.
[in] | client_handle | client handle from registration API |
[out] | maxVlan | maximum number of VLANs |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMaxAssignQueueGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxQueue | ||
) |
Get the maximum queue id value for a match criteria.
[in] | client_handle | client handle from registration API |
[out] | maxQueue | maximum queue id value supported |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMaxCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxACL | ||
) |
Get the maximum number of ACLs that can be configured.
[in] | client_handle | client handle from registration API |
[out] | maxACL | maximum number of ACLs |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMaxIntfAclCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxACL | ||
) |
Get the maximum number of ACLs per interface on this platform.
[in] | client_handle | client handle from registration API |
[out] | maxACL | maximum number of ACLs |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMaxMirrorIntfCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxIntf | ||
) |
Get the maximum mirror interface count for a match criteria.
[in] | client_handle | client handle from registration API |
[out] | maxIntf | maximum number of interfaces. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMaxRedirectIntfCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxIntf | ||
) |
Get the maximum redirect interface count for a match criteria.
[in] | client_handle | client handle from registration API |
[out] | maxIntf | maximum number of interfaces. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclMaxVlanAclCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxACL | ||
) |
Get the maximum number of ACLs per VLAN on this platform.
[in] | client_handle | client handle from registration API |
[out] | maxACL | maximum number of ACLs |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclNameGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
open_buffdesc * | aclName | ||
) |
Get the Access List name for the given ACL.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[out] | aclName | ACL name |
- | Minimum value OPENAPI_ACL_NAME_LEN_MIN | |
- | Maximum value OPENAPI_ACL_NAME_LEN_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRename | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
open_buffdesc * | aclName | ||
) |
Change the Access List name.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclName | New ACL name |
- | Minimum value OPENAPI_ACL_NAME_LEN_MIN | |
- | Maximum value OPENAPI_ACL_NAME_LEN_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_EXISTS | Set failed, ACL name already exists. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRouteFilter | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | routePrefix, | ||
uint32_t | routeMask, | ||
OPEN_ACL_ACTION_t * | aclAction | ||
) |
Apply an ACL as a route filter.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | routePrefix | Destination prefix of route |
[in] | routeMask | Destination mask of route |
[out] | aclAction | on action type (permit/deny) |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.3
open_error_t openapiAclRuleActionAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t * | aclRule, | ||
OPEN_ACL_ACTION_t | aclAction | ||
) |
Add a new rule and its associated action to the given ACL.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in,out] | aclRule | ACL rule |
[in] | aclAction | ACL action |
OPEN_E_NONE | Set successful. |
OPEN_E_ERROR | Another application has denied approval of this configuration change |
OPEN_E_INTERNAL | If hardware update failed. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleActionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_ACTION_t * | aclAction | ||
) |
Get the action for a rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | aclAction | on action type (permit/deny) |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclRuleCountersClear | ( | openapiClientHandle_t * | client_handle, |
uint32_t | asic, | ||
uint32_t | aclId, | ||
uint32_t | ruleNum | ||
) |
Clear ACL rule counters.
[in] | client_handle | client handle from registration API |
[in] | asic | unit |
[in] | aclId | ACL identifier |
[in] | ruleNum | ACL rule |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.14
open_error_t openapiAclRuleCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | asic, | ||
uint32_t | aclId, | ||
uint32_t | ruleNum, | ||
uint32_t | ruleAction, | ||
uint64_t * | hitPktCount | ||
) |
Get ACL rule hit count.
[in] | client_handle | client handle from registration API |
[in] | asic | unit |
[in] | aclId | ACL identifier |
[in] | ruleNum | ACL rule |
[in] | ruleAction | ACL rule action. |
[out] | hitPktCount | ACL rule hit count. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.14
open_error_t openapiAclRuleDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | asic, | ||
uint32_t | aclId, | ||
uint32_t | ruleId | ||
) |
Delete a specific rule from the given ACL.
[in] | client_handle | client handle from registration API |
[in] | asic | unit |
[in] | aclId | ACL identifier |
[in] | ruleId | Rule identifier |
OPEN_E_NONE | Delete successful. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_INTERNAL | if hardware update failed. |
OPEN_E_FAIL | Delete failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.14
open_error_t openapiAclRuleDeleteLast | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId | ||
) |
Delete the last rule for the given ACL.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
OPEN_E_NONE | Delete successful. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_INTERNAL | if hardware update failed. |
OPEN_E_FAIL | Delete failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleGetFirst | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t * | aclRule | ||
) |
Get the rule for the given ACL.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[out] | aclRule | ACL rule |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclRuleGetNext | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | nextAclRule | ||
) |
Get the next rule for the given ACL.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | nextAclRule | next ACL rule |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiAclRuleGlobalApply | ( | openapiClientHandle_t * | client_handle, |
uint32_t | asic, | ||
uint32_t | aclId, | ||
uint32_t | seqNum | ||
) |
Apply ACL rule to all interfaces.
[in] | client_handle | client handle from registration API |
[in] | asic | unit |
[in] | aclId | ACL identifier |
[in] | seqNum | ACL sequence number |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.14
open_error_t openapiAclRuleMatchAssignQueueAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | queueId | ||
) |
Set the assigned queue id for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | queueId | queue identifier |
- | Minimum value OPENAPI_ACL_ASSIGN_QUEUE_MIN | |
- | Maximum value openapiAclMaxAssignQueueGet() |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchAssignQueueGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | queueId | ||
) |
Gets the assigned queue id for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | queueId | queue identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchDscpAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | dscp | ||
) |
Set the DSCP value for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | dscp | DSCP value |
- | Minimum value OPENAPI_ACL_DSCP_MIN | |
- | Maximum value OPENAPI_ACL_DSCP_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchDscpGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | dscp | ||
) |
Gets the DSCP value for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | dscp | DSCP value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchEveryAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool | aclMatch | ||
) |
Set the match condition whereby all packets match for the ACL rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | aclMatch | match condition (true/false) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchEveryGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool * | aclMatch | ||
) |
Gets the match-all (every) status for a rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | aclMatch | match every packet |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchFlowLabelAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | label | ||
) |
Set the flow label for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | label | flow label value |
- | Minimum value OPENAPI_ACL_FLOW_LABEL_MIN | |
- | Maximum value OPENAPI_ACL_FLOW_LABEL_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchFlowLabelGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | label | ||
) |
Gets the flow label for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | label | flow label value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchFragmentsAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool | fragments | ||
) |
Set the match condition to match on non-initial fragmented packets.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | fragments | match (true/false) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchFragmentsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool * | fragments | ||
) |
Get the match condition for non-initial fragmented packets.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | fragments | match (true/false) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIcmpTypeCodeAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool | addCode, | ||
uint32_t | type, | ||
uint32_t | code | ||
) |
Add a match condition for ICMP parameters to an existing access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | addCode | Set to true if API should set the ICMP code |
[in] | type | ICMP type |
- | Minimum value OPENAPI_ACL_ICMP_TYPE_MIN | |
- | Maximum value OPENAPI_ACL_ICMP_TYPE_MAX | |
[in] | code | ICMP code (if applicable) |
- | Minimum value OPENAPI_ACL_ICMP_CODE_MIN | |
- | Maximum value OPENAPI_ACL_ICMP_CODE_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIcmpTypeCodeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool | getCode, | ||
uint32_t * | type, | ||
uint32_t * | code | ||
) |
Get the ICMP match condition parameters for an existing access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | getCode | Set to true if API should return the ICMP code |
[out] | type | ICMP type |
[out] | code | ICMP code (if applicable) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIgmpTypeAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | type | ||
) |
Add a match condition for IGMP parameters to an existing access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | type | IGMP type |
- | Minimum value OPENAPI_ACL_IGMP_TYPE_MIN | |
- | Maximum value OPENAPI_ACL_IGMP_TYPE_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIgmpTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | type | ||
) |
Get the IGMP match condition parameters for an existing access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | type | IGMP type |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIpDstMaskAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_inet_addr_t | addr, | ||
open_inet_addr_t | mask | ||
) |
Add the destination IPv4 address and net mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | ip | ip address |
[in] | mask | ip address mask. A bit value of '0' represents don't care. E.g., to match on network 10.0.0.0, the mask should be 0xff000000. |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIpDstMaskGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_inet_addr_t * | addr, | ||
open_inet_addr_t * | mask | ||
) |
Gets the destination IPv4 address and net mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | ip | ip address |
[out] | mask | ip address mask. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIpSrcMaskAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_inet_addr_t | addr, | ||
open_inet_addr_t | mask | ||
) |
Add the source IPv4 address and net mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | addr | ip address |
[in] | mask | ip address mask. A bit value of '0' represents don't care. E.g., to match on network 10.0.0.0, the mask should be 0xff000000. |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIpSrcMaskGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_inet_addr_t * | addr, | ||
open_inet_addr_t * | mask | ||
) |
Gets the source IPv4 address and net mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | addr | ip address |
[out] | mask | ip address mask. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIpv6DstPfxAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_inet_addr_t | addr, | ||
uint32_t | pfxLen | ||
) |
Add the destination IPV6 address and prefix length.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | addr | ipv6 address |
[in] | pfxLen | prefix length |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIpv6DstPfxGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_inet_addr_t * | addr, | ||
uint32_t * | pfxLen | ||
) |
Gets the destination IPV6 address and prefix length.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | addr | ipv6 address |
[out] | pfxLen | prefix length |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIpv6SrcPfxAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_inet_addr_t | addr, | ||
uint32_t | pfxLen | ||
) |
Add the source IPV6 address and prefix length.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | addr | ipv6 address |
[in] | pfxLen | prefix length |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchIpv6SrcPfxGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_inet_addr_t * | addr, | ||
uint32_t * | pfxLen | ||
) |
Gets the source IPV6 address and prefix length.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | addr | ipv6 address |
[out] | pfxLen | prefix length |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchL4DstPortAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_L4_PORT_OPERATOR_t | oper, | ||
uint32_t | startPort, | ||
uint32_t | endPort | ||
) |
Add a Layer 4 destination port match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | oper | operator or range specifier |
[in] | startPort | layer 4 port |
- | Minimum value OPENAPI_ACL_L4_PORT_MIN | |
- | Maximum value OPENAPI_ACL_L4_PORT_MAX | |
[in] | endPort | ending layer 4 port (used if oper is OPEN_ACL_L4_PORT_OPERATOR_RANGE) |
- | Minimum value OPENAPI_ACL_L4_PORT_MIN | |
- | Maximum value OPENAPI_ACL_L4_PORT_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchL4DstPortGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_L4_PORT_OPERATOR_t * | oper, | ||
uint32_t * | startPort, | ||
uint32_t * | endPort | ||
) |
Get a Layer 4 destination port match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | oper | operator or range specifier |
[out] | startPort | layer 4 port |
[out] | endPort | ending layer 4 port (used if oper is OPEN_ACL_L4_PORT_OPERATOR_RANGE) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchL4SrcPortAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_L4_PORT_OPERATOR_t | oper, | ||
uint32_t | startPort, | ||
uint32_t | endPort | ||
) |
Add a Layer 4 source port match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | oper | operator or range specifier |
[in] | startPort | layer 4 port |
- | Minimum value OPENAPI_ACL_L4_PORT_MIN | |
- | Maximum value OPENAPI_ACL_L4_PORT_MAX | |
[in] | endPort | ending layer 4 port (used if oper is OPEN_ACL_L4_PORT_OPERATOR_RANGE) |
- | Minimum value OPENAPI_ACL_L4_PORT_MIN | |
- | Maximum value OPENAPI_ACL_L4_PORT_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchL4SrcPortGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_L4_PORT_OPERATOR_t * | oper, | ||
uint32_t * | startPort, | ||
uint32_t * | endPort | ||
) |
Get a Layer 4 source port match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | oper | operator or range specifier |
[out] | startPort | layer 4 port |
[out] | endPort | ending layer 4 port (used if oper is OPEN_ACL_L4_PORT_OPERATOR_RANGE) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchLoggingAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool | aclLogging | ||
) |
Set the logging flag for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | aclLogging | logging flag (true/false) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchLoggingGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool * | aclLogging | ||
) |
Gets the logging flag from an existing access list rule entry.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | aclLogging | logging flag (true/false) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacCos2Add | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | cos | ||
) |
Add a Secondary Class Of Server (COS) match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | cos | secondary class of service value. |
- | Minimum value OPENAPI_ACL_COS_MIN | |
- | Maximum value OPENAPI_ACL_COS_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacCos2Get | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | cos | ||
) |
Get the Secondary Class Of Server (COS) match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | cos | secondary class of service value. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacCosAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | cos | ||
) |
Add a Class Of Server (COS) match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | cos | class of service value. |
- | Minimum value OPENAPI_ACL_COS_MIN | |
- | Maximum value OPENAPI_ACL_COS_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacCosGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | cos | ||
) |
Get the Class Of Server (COS) match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | cos | class of service value. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacDstMacAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_buffdesc * | mac, | ||
open_buffdesc * | mask | ||
) |
Add the destination MAC address and mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | mac | MAC address |
[in] | mask | MAC mask. A bit value of '0' represents don't care. E.g., to do an exact match on source mac-address of 00:11:22:33:44:55, the mask should be set to ff:ff:ff:ff:ff:ff. To do a match on source mac address of 00:11:22:xx:xx:xx, the mask should be set to ff:ff:ff:00:00:00. |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacDstMacGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_buffdesc * | mac, | ||
open_buffdesc * | mask | ||
) |
Get the destination MAC address and mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | mac | MAC address |
[out] | mask | MAC mask. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacEtherTypeAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | type | ||
) |
Add a MAC Ethertype match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | type | four-digit hexadecimal Ethertype value. |
- | Minimum value OPENAPI_ETHERTYPE_MIN | |
- | Maximum value OPENAPI_ETHERTYPE_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacEtherTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | type | ||
) |
Get the MAC Ethertype match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | type | four-digit hexadecimal Ethertype value. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacSecondaryVlanAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_VLAN_OPERATOR_t | oper, | ||
uint32_t | startId, | ||
uint32_t | endId | ||
) |
Add a Secondary VLAN match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | oper | operator or range specifier |
[in] | startId | VLAN Id |
- | Minimum value OPENAPI_ACL_VLAN_ID_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_ID_MAX | |
[in] | endId | ending VLAN Id (used if oper is OPEN_ACL_VLAN_OPERATOR_RANGE) |
- | Minimum value OPENAPI_ACL_VLAN_ID_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_ID_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacSecondaryVlanGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_VLAN_OPERATOR_t * | oper, | ||
uint32_t * | startId, | ||
uint32_t * | endId | ||
) |
Get the Secondary VLAN match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | oper | operator or range specifier |
[out] | startId | VLAN Id |
[out] | endId | ending VLAN Id (used if oper is OPEN_ACL_VLAN_OPERATOR_RANGE) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacSrcMacAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_buffdesc * | mac, | ||
open_buffdesc * | mask | ||
) |
Add the source MAC address and mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | mac | MAC address |
[in] | mask | MAC mask. A bit value of '0' represents don't care. E.g., to do an exact match on source mac-address of 00:11:22:33:44:55, the mask should be set to ff:ff:ff:ff:ff:ff. To do a match on source mac address of 00:11:22:xx:xx:xx, the mask should be set to ff:ff:ff:00:00:00. |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacSrcMacGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_buffdesc * | mac, | ||
open_buffdesc * | mask | ||
) |
Get the source MAC address and mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | mac | MAC address |
[out] | mask | MAC mask. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacVlanAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_VLAN_OPERATOR_t | oper, | ||
uint32_t | startId, | ||
uint32_t | endId | ||
) |
Add a VLAN match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | oper | operator or range specifier |
[in] | startId | VLAN Id |
- | Minimum value OPENAPI_ACL_VLAN_ID_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_ID_MAX | |
[in] | endId | ending VLAN Id (used if oper is OPEN_ACL_VLAN_OPERATOR_RANGE) |
- | Minimum value OPENAPI_ACL_VLAN_ID_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_ID_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMacVlanGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_VLAN_OPERATOR_t * | oper, | ||
uint32_t * | startId, | ||
uint32_t * | endId | ||
) |
Get the VLAN match condition.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | oper | operator or range specifier |
[out] | startId | VLAN Id |
[out] | endId | ending VLAN Id (used if oper is OPEN_ACL_VLAN_OPERATOR_RANGE) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMirrorAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | intf | ||
) |
Set the mirror interface for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | intf | internal interface number |
- | Minimum value OPENAPI_ACL_MIRROR_INTF_MIN | |
- | Maximum value openapiAclMaxMirrorIntfCountGet() |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchMirrorAgentAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | agent | ||
) |
Add the mirror external agent id for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | agent | agent id |
- | Minimum value OPENAPI_ACL_AGENT_ID_MIN | |
- | Maximum value OPENAPI_ACL_AGENT_ID_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.12
open_error_t openapiAclRuleMatchMirrorAgentGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | agent | ||
) |
Get the mirror external agent id from an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | agent | agent id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.12
open_error_t openapiAclRuleMatchMirrorGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | intf | ||
) |
Get the mirror interface from an existing access list rule entry.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | intf | internal interface number |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchPrecedenceAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | precedence | ||
) |
Set the match condition precedence value.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | precedence | precedence value |
- | Minimum value OPENAPI_ACL_PRECEDENCE_MIN | |
- | Maximum value OPENAPI_ACL_PRECEDENCE_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchPrecedenceGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | precedence | ||
) |
Get the match condition for precedence value.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | precedence | precedence value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchProtocolAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | aclProtocol | ||
) |
Add a protocol to an existing access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | aclProtocol | protocol |
- | Minimum value OPENAPI_ACL_PROTOCOL_MIN | |
- | Maximum value OPENAPI_ACL_PROTOCOL_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchProtocolGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | aclProtocol | ||
) |
Gets the protocol from an existing access list rule entry.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | aclProtocol | protocol |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchRateLimitAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | dataRate, | ||
uint32_t | burstSize | ||
) |
Set the rate limit parameters for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | dataRate | data-rate in Kbps |
- | Minimum value OPENAPI_ACL_RATE_LIMIT_DATA_RATE_MIN | |
- | Maximum value OPENAPI_ACL_RATE_LIMIT_DATA_RATE_MAX | |
[in] | burstSize | burst-size in Kbytes |
- | Minimum value OPENAPI_ACL_RATE_LIMIT_BURST_SIZE_MIN | |
- | Maximum value OPENAPI_ACL_RATE_LIMIT_BURST_SIZE_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchRateLimitGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | dataRate, | ||
uint32_t * | burstSize | ||
) |
Get the rate limit parameters from an existing access list rule entry.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | dataRate | data-rate in Kbps |
[out] | burstSize | burst-size in Kbytes |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchRedirectAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | intf | ||
) |
Add the redirect interface for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | intf | internal interface number |
- | Minimum value OPENAPI_ACL_REDIRECT_INTF_MIN | |
- | Maximum value openapiAclMaxRedirectIntfCountGet() |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchRedirectAgentAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | agent | ||
) |
Add the redirect external agent id for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | agent | agent id |
- | Minimum value OPENAPI_ACL_AGENT_ID_MIN | |
- | Maximum value OPENAPI_ACL_AGENT_ID_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchRedirectAgentGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | agent | ||
) |
Get the redirect agent Id from an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | agent | agent id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchRedirectGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | intf | ||
) |
Get the redirect interface from an existing access list rule entry.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | intf | internal interface number |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchRoutingAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool | flag | ||
) |
Set the routing flag for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | flag | routing flag |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchRoutingGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool * | flag | ||
) |
Get the routing flag for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | flag | routing flag |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchSflowSamplingAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool | aclSflowSampling | ||
) |
Set the sFlow sampling flag for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | aclSflowSampling | sFlow Sampling flag (true/false) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature or sFlow hardware sampling is not supported on this platform. |
OpEN API Version: 1.15
open_error_t openapiAclRuleMatchSflowSamplingGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
bool * | aclSflowSampling | ||
) |
Gets the sFlow sampling flag from an existing access list rule entry.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | aclSflowSampling | sFlow sampling flag (true/false) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature or sFlow hardware sampling is not supported on this platform. |
OpEN API Version: 1.15
open_error_t openapiAclRuleMatchTcpFlagsAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t | tcpVal, | ||
uint32_t | tcpMask | ||
) |
Add a match condition using a TCP Control Flag and Mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | tcpVal | tos bits |
[in] | tcpMask | tos mask |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchTcpFlagsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
uint32_t * | tcpVal, | ||
uint32_t * | tcpMask | ||
) |
Get a match condition using a TCP Control Flag and Mask.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | tcpVal | tos bits |
[out] | tcpMask | tos mask |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchTimeRangeAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_buffdesc * | name | ||
) |
Add the time range name for an access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | name | time range name |
- | Minimum value OPENAPI_TIME_RANGE_NAME_LEN_MIN | |
- | Maximum value OPENAPI_TIME_RANGE_NAME_LEN_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchTimeRangeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_buffdesc * | name | ||
) |
Get the time range name assigned to access list rule.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | name | time range name |
- | Minimum value OPENAPI_TIME_RANGE_NAME_LEN_MIN | |
- | Maximum value OPENAPI_TIME_RANGE_NAME_LEN_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchTimeRangeStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
OPEN_ACL_RULE_STATUS_t * | status | ||
) |
Get the rule status of an access list rule entry.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | status | time range status |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchTosAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_buffdesc * | tos, | ||
open_buffdesc * | tosMask | ||
) |
Add a match condition based on the value of the IP ToS field.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[in] | tos | ToS bits. A two-digit hexadecimal number from 00 to ff. |
[in] | tosMask | ToS mask. A two-digit hexadecimal number from 00 to ff. |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclRuleMatchTosGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | aclId, | ||
uint32_t | aclRule, | ||
open_buffdesc * | tos, | ||
open_buffdesc * | tosMask | ||
) |
Get the match condition for IP ToS field.
[in] | client_handle | client handle from registration API |
[in] | aclId | ACL identifier |
[in] | aclRule | ACL rule |
[out] | tos | ToS bits. A two-digit hexadecimal number from 00 to ff. |
[out] | tosMask | ToS mask. A two-digit hexadecimal number from 00 to ff. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclVlanDirAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlan, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
uint32_t | aclId, | ||
uint32_t | seqNum | ||
) |
Add an access list to the specified VLAN and direction.
[in] | client_handle | client handle from registration API |
[in] | vlan | VLAN id |
- | Minimum value OPENAPI_ACL_VLAN_ID_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_ID_MAX | |
[in] | dir | VLAN direction |
[in] | aclId | ACL identifier |
[in] | seqNum | the ACL evaluation order sequence number |
- | Minimum value OPENAPI_ACL_VLAN_SEQ_NUM_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_SEQ_NUM_MAX |
OPEN_E_NONE | ACL successfully added intf and dir |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_EXISTS | intf and dir is already assigned an ACL |
OPEN_E_FAIL | Add failed or intf and dir is not ACL compatible. |
OPEN_E_FULL | ACL assignment is at capacity for intf and dir |
OPEN_E_INTERNAL | If hardware update failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclVlanDirDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlan, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
uint32_t | aclId | ||
) |
Remove an access list from the specified VLAN and direction.
[in] | client_handle | client handle from registration API |
[in] | vlan | VLAN id |
- | Minimum value OPENAPI_ACL_VLAN_ID_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_ID_MAX | |
[in] | dir | VLAN direction |
[in] | aclId | ACL identifier |
OPEN_E_NONE | ACL successfully added intf and dir |
OPEN_E_ERROR | Another application has denied approval of this configuration change. |
OPEN_E_FAIL | Add failed or intf and dir is not ACL compatible. |
OPEN_E_INTERNAL | If hardware update failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | ACL feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiAclVlanDirListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlan, | ||
OPEN_ACL_DIRECTION_t | dir, | ||
OPEN_ACL_VLAN_DIR_LIST_t * | listInfo | ||
) |
Get the list of ACLs currently assigned to the specified VLAN and direction.
[in] | client_handle | client handle from registration API |
[in] | vlan | internal interface number |
- | Minimum value OPENAPI_ACL_VLAN_ID_MIN | |
- | Maximum value OPENAPI_ACL_VLAN_ID_MAX | |
[in] | dir | VLAN direction |
[out] | listInfo | list of assigned ACLs |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. No more valid ACLs |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FULL | If the listInfo->listEntry array is not large enough to hold the maximum ACL entries. |
OpEN API Version: 1.2