Open Ethernet Networking (OpEN) API Guide and Reference Manual: api/include/openapi

Go to the documentation of this file.
 
 /* Copyright 2021 Broadcom. */
 
 /*************************************************/
 /* This file is auto-generated. Please do not modify. */
 /*************************************************/
 
 #define OPENAPI_ACL_ASSIGN_QUEUE_MIN 0 
 #define OPENAPI_SNTP_MIN_SERVER_PRIORITY 1 
 #define OPENAPI_SNTP_MIN_SERVER_PORT 1 
 #define OPENAPI_SNTP_MAX_SERVER_PORT 65535 
 #define OPENAPI_SNTP_VERSION_MIN 1 
 #define OPENAPI_SNTP_VERSION_MAX 4 
 #define OPEN_SNTP_MAX_SERVER_ENTRIES 12 
 #define OPENAPI_PBVLAN_MIN_GROUP_NAME 1  
 #define OPENAPI_PBVLAN_MAX_GROUP_NAME 16  
 #define OPENAPI_BGP4_HOLD_TIME_MIN 0 
 #define OPENAPI_BGP4_HOLD_TIME_MAX 65535 
 #define OPENAPI_BGP4_KEEP_ALIVE_TIME_MIN 0 
 #define OPENAPI_BGP4_KEEP_ALIVE_TIME_MAX 65535 
 #define OPENAPI_BGP4_MAXPATH_MIN 1 
 #define OPENAPI_BGP4_ADV_INTERVAL_MIN 0 
 #define OPENAPI_BGP4_ADV_INTERVAL_MAX 600 
 #define OPENAPI_OSPF_MIN_REF_BW 1 
 #define OPENAPI_OSPF_MAX_REF_BW 4294967 
 #define OPENAPI_OSPF_INTF_DEAD_MIN 1 
 #define OPENAPI_OSPF_INTF_DEAD_MAX 65535 
 #define OPENAPI_OSPF_INTF_SECONDS_MIN 1 
 #define OPENAPI_OSPF_INTF_SECONDS_MAX 65535 
 #define OPENAPI_OSPF_INTF_COST_MIN 1 
 #define OPENAPI_OSPF_INTF_COST_MAX 65535 
 #define OPENAPI_OSPF_REDIST_METRIC_MIN 0 
 #define OPENAPI_OSPF_REDIST_METRIC_MAX 16777214 
 #define OPENAPI_OSPF_SPF_DELAY_TIME_MIN 0 
 #define OPENAPI_OSPF_SPF_DELAY_TIME_MAX 65535 
 #define OPENAPI_OSPF_SPF_HOLD_TIME_MIN 0 
 #define OPENAPI_OSPF_SPF_HOLD_TIME_MAX 65535 
 #define OPENAPI_OSPF_STUB_ROUTER_DURATION_MIN 5 
 #define OPENAPI_OSPF_STUB_ROUTER_DURATION_MAX 86400 
 #define OPENAPI_OSPF_STUB_ROUTER_SUMLSA_MET_MIN 1 
 #define OPENAPI_OSPF_STUB_ROUTER_SUMLSA_MET_MAX 16777215 
 #define OPENAPI_OSPF_DIST_LIST_NA 0 
 #define OPENAPI_OSPF_REDIST_METRIC_NA -1 
 #define OPENAPI_PBVLAN_MIN_NUM_GROUPS 1 
 #define OPENAPI_PBVLAN_MAX_NUM_GROUPS 128 
 #define OPENAPI_SYSLOG_MIN_PORT 1 
 #define OPENAPI_SYSLOG_MAX_PORT 65535 
 #define OPENAPI_DEFAULT_IMAGE_DESCR_MAX 256 
 #define OPENAPI_ACL_AGENT_ID_MIN 1 
 #define OPENAPI_ACL_AGENT_ID_MAX 100 
 #define OPENAPI_FDB_MIN_TIMEOUT_ID 10 
 #define OPENAPI_FDB_MAX_TIMEOUT_ID 1000000 
 #define OPENAPI_ACL_COS_MIN 0 
 #define OPENAPI_ACL_COS_MAX 7 
 #define OPENAPI_ACL_DSCP_MIN 0 
 #define OPENAPI_ACL_DSCP_MAX 63 
 #define OPENAPI_ACL_FLOW_LABEL_MIN 0 
 #define OPENAPI_ACL_FLOW_LABEL_MAX 1048575 
 #define OPENAPI_ACL_ICMP_CODE_MIN 0 
 #define OPENAPI_ACL_ICMP_CODE_MAX 255 
 #define OPENAPI_ACL_ICMP_TYPE_MIN 0 
 #define OPENAPI_ACL_ICMP_TYPE_MAX 255 
 #define OPENAPI_ACL_IGMP_TYPE_MIN 0 
 #define OPENAPI_ACL_IGMP_TYPE_MAX 255 
 #define OPENAPI_ACL_INTF_SEQ_NUM_MIN 1 
 #define OPENAPI_ACL_INTF_SEQ_NUM_MAX 4294967295U 
 #define OPENAPI_ACL_L4_PORT_MIN 0 
 #define OPENAPI_ACL_L4_PORT_MAX 65535 
 #define OPENAPI_ACL_NAME_LEN_MIN 1 
 #define OPENAPI_ACL_NAME_LEN_MAX 255 
 #define OPENAPI_ACL_PRECEDENCE_MIN 0 
 #define OPENAPI_ACL_PRECEDENCE_MAX 7 
 #define OPENAPI_ACL_PROTOCOL_MIN 0 
 #define OPENAPI_ACL_PROTOCOL_MAX 255 
 #define OPENAPI_ACL_RATE_LIMIT_DATA_RATE_MIN 1 
 #define OPENAPI_ACL_RATE_LIMIT_DATA_RATE_MAX 4294967295UL 
 #define OPENAPI_ACL_RATE_LIMIT_BURST_SIZE_MIN 1 
 #define OPENAPI_ACL_RATE_LIMIT_BURST_SIZE_MAX 128 
 #define OPENAPI_ACL_VLAN_ID_MIN 1 
 #define OPENAPI_ACL_VLAN_ID_MAX 4093 
 #define OPENAPI_ACL_VLAN_SEQ_NUM_MIN 1 
 #define OPENAPI_ACL_VLAN_SEQ_NUM_MAX 4294967295U 
 #define OPENAPI_OSPF_DIST_LIST_MIN 1 
 #define OPENAPI_OSPF_DIST_LIST_MAX 199 
 #define OPENAPI_LOGIN_SIZE 65 
 #define OPENAPI_MIN_TERMINAL_LENGTH 5 
 #define OPENAPI_MAX_TERMINAL_LENGTH 48 
 #define OPENAPI_SNMP_SYSTEM_CONTACT_MAX 256 
 #define OPENAPI_SNMP_SYSTEM_LOCATION_MAX 256 
 #define OPENAPI_SNMP_SYSTEM_NAME_MAX 256 
 #define OPENAPI_MAX_STRING_LENGTH 256 
 #define OPENAPI_TRANSFER_USERNAME_LEN_MAX 256 
 #define OPENAPI_TRANSFER_PASSWORD_LEN_MAX 256 
 #define OPENAPI_TRANSFER_RESULT_LEN_MAX 256 
 #define OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MIN 1 
 #define OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MAX 65535 
 #define OPENAPI_CLOUD_MANAGED_USERNAME_LEN_MAX 65 
 #define OPENAPI_CLOUD_MANAGED_PASSWORD_DECRYPTED_LEN_MAX 65 
 #define OPENAPI_CLOUD_MANAGED_PASSWORD_ENCRYPTED_LEN_MAX 129 
 #define OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MIN 11 
 #define OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MAX 151 
 #define OPENAPI_ETHERTYPE_MIN 0x0600 
 #define OPENAPI_ETHERTYPE_MAX 0xFFFF 
 #define OPENAPI_DOT1Q_MIN_VLAN_ID 1 
 #define OPENAPI_DOT1S_MSTID_MIN 1 
 #define OPENAPI_DOT1S_MSTID_MAX 4094 
 #define OPENAPI_DOT1S_PRIORITY_MIN 0 
 #define OPENAPI_DOT1S_PRIORITY_MAX 61440 
 #define OPENAPI_DOT1S_MIN_REVISION_VALUE 0 
 #define OPENAPI_DOT1S_MAX_REVISION_VALUE 65535 
 #define OPENAPI_ROUTEMAP_NAME_SIZE_MAX 32 
 #define OPENAPI_SNMP_AUTH_PWD_MIN 1 
 #define OPENAPI_SNMP_AUTH_PWD_MAX 32 
 #define OPENAPI_SNMP_COMMUNITY_NAME_MIN 1 
 #define OPENAPI_SNMP_COMMUNITY_NAME_MAX 20 
 #define OPENAPI_SNMP_CONTEXT_NAME_MIN 1 
 #define OPENAPI_SNMP_CONTEXT_NAME_MAX 30 
 #define OPENAPI_SNMP_ENGINE_ID_DEF 1 
 #define OPENAPI_SNMP_ENGINE_ID_MIN 10 
 #define OPENAPI_SNMP_ENGINE_ID_MAX 64 
 #define OPENAPI_SNMP_FILTER_NAME_MIN 1 
 #define OPENAPI_SNMP_FILTER_NAME_MAX 30 
 #define OPENAPI_SNMP_GROUP_NAME_MIN 1 
 #define OPENAPI_SNMP_GROUP_NAME_MAX 30 
 #define OPENAPI_SNMP_HOST_NAME_MAX 255 
 #define OPENAPI_SNMP_MD5_KEY_SIZE 32 
 #define OPENAPI_SNMP_RETRIES_COUNT_MAX 255 
 #define OPENAPI_SNMP_SERVER_PORT_DEF 162 
 #define OPENAPI_SNMP_SERVER_PORT_MIN 1025 
 #define OPENAPI_SNMP_SERVER_PORT_MAX 65535 
 #define OPENAPI_SNMP_SHA_KEY_SIZE 48 
 #define OPENAPI_SNMP_TIMEOUT_COUNT_MAX 300 
 #define OPENAPI_SNMP_USER_NAME_MIN 1 
 #define OPENAPI_SNMP_USER_NAME_MAX 30 
 #define OPENAPI_SNMP_VIEW_NAME_MIN 1 
 #define OPENAPI_SNMP_VIEW_NAME_MAX 30 
 #define OPENAPI_SNMP_VIEW_TREE_MIN 1 
 #define OPENAPI_SNMP_VIEW_TREE_MAX 128 
 #define OPENAPI_SNMP_VERSION_DEF 1 
 #define OPENAPI_SSHD_MAX_TIMEOUT 160 
 #define OPENAPI_SERIAL_TIMEOUT_MAX 160 
 #define OPENAPI_SYSMGMT_SERVICE_TAG_MAX_LENGTH 16 
 #define OPENAPI_L7_MAC_ADDR_LEN 6 
 #define OPENAPI_TACACS_PORT_NUM_MIN 0 
 #define OPENAPI_TACACS_PORT_NUM_MAX 65535 
 #define OPENAPI_TACACS_PRIORITY_MIN 0 
 #define OPENAPI_TACACS_PRIORITY_MAX 65535 
 #define OPENAPI_TACACS_TIMEOUT_MIN 1 
 #define OPENAPI_TACACS_TIMEOUT_MAX 30 
 #define OPENAPI_TIME_RANGE_NAME_LEN_MIN 1 
 #define OPENAPI_TIME_RANGE_NAME_LEN_MAX 31 
 #define OPENAPI_ACL_MIRROR_INTF_MIN 1 
 #define OPENAPI_ACL_REDIRECT_INTF_MIN 1 
 #define OPENAPI_FILE_NAME_LENGTH_MAX 96 
 #define OPENAPI_FILEPATH_LEN_MAX 96 
 #define OPENAPI_TCP_UDP_MIN_PORT 1 
 #define OPENAPI_TCP_UDP_MAX_PORT 65535 
 #define OPENAPI_UNITMGR_SERIAL_NUMBER_SIZE 32  
 #define OPENAPI_UNITMGR_ROOTFS_VER_LENGTH  32  
 #define OPENAPI_DNS_HOST_NAME_LEN_MIN 1  
 #define OPENAPI_DNS_HOST_NAME_LEN_MAX 253  
 #define OPEN_DNS_NAME_SERVER_ENTRIES 8 
 #define OPENAPI_ENCRYPTED_PASSWORD_SIZE 129  
 #define OPENAPI_DECRYPTED_PASSWORD_SIZE 65  
 #define OPENAPI_APP_NAME_SIZE 17 
 #define OPENAPI_MAX_CPU_SHARE 99 
 #define OPENAPI_MAX_MEMORY_LIMIT 200 
 #define OPENAPI_APP_STATUS_SIZE 512 
 #define OPENAPI_APP_VERSION_SIZE 20 
 #define OPEN_POE_PORT_LIMIT_MIN 3000  
 #define OPEN_POE_USAGE_THRESHOLD_MIN 1  
 #define OPEN_POE_USAGE_THRESHOLD_MAX 99  
 #define OPEN_PING_MIN_SIZE 0          
 #define OPEN_PING_MAX_SIZE 13000          
 #define OPEN_PING_MIN_PROBES 1      
 #define OPEN_PING_MAX_PROBES 15      
 #define OPEN_PING_MIN_INTERVAL 1  
 #define OPEN_PING_MAX_INTERVAL 60  
 #define OPEN_TRACEROUTE_MIN_PROBE_PER_HOP 1    
 #define OPEN_TRACEROUTE_MAX_PROBE_PER_HOP 10    
 #define OPEN_TRACEROUTE_MIN_TTL 1                        
 #define OPEN_TRACEROUTE_MAX_TTL 255                        
 #define OPEN_TRACEROUTE_MIN_INIT_TTL 1              
 #define OPEN_TRACEROUTE_MAX_INIT_TTL 255              
 #define OPEN_TRACEROUTE_MIN_FAIL 1                      
 #define OPEN_TRACEROUTE_MAX_FAIL 255                      
 #define OPEN_TRACEROUTE_MIN_INTERVAL 1              
 #define OPEN_TRACEROUTE_MAX_INTERVAL 60              
 #define OPEN_TRACEROUTE_MIN_PORT 0                      
 #define OPEN_TRACEROUTE_MIN_PORT 0                      
 #define OPEN_TRACEROUTE_MAX_PORT 65535                      
 #define OPEN_TRACEROUTE_MAX_PORT 65535                      
 #define OPEN_TRACEROUTE_MIN_PROBE_SIZE 0          
 #define OPEN_TRACEROUTE_MAX_PROBE_SIZE 39936          
 #define OPEN_DHCP_VENDOR_SPECIFIC_SUBOPTIONS_NUM 3 
 #define OPEN_DHCP_BOOTP_VEND_OPTIONS_LEN 64 
 #define OPEN_DHCP_OPT125_VENDOR_NUMBER_MAX 3 
 #define OPEN_HOSTNAME_MAX_LEN 64 
 #define OPEN_BOOTP_FILE_LEN 128 
 #define OPEN_BOOTP_SNAME_LEN 64 
 #define OPEN_PING_MIN_SIZE 0          
 #define OPEN_PING_MAX_SIZE 13000          
 #define OPEN_PING_MIN_PROBES 1      
 #define OPEN_PING_MAX_PROBES 15      
 #define OPEN_PING_MIN_INTERVAL 1  
 #define OPEN_PING_MAX_INTERVAL 60  
 #define OPEN_TRACEROUTE_MIN_PROBE_PER_HOP 1    
 #define OPEN_TRACEROUTE_MAX_PROBE_PER_HOP 10    
 #define OPEN_TRACEROUTE_MIN_TTL 1                        
 #define OPEN_TRACEROUTE_MAX_TTL 255                        
 #define OPEN_TRACEROUTE_MIN_INIT_TTL 1              
 #define OPEN_TRACEROUTE_MAX_INIT_TTL 255              
 #define OPEN_TRACEROUTE_MIN_FAIL 1                      
 #define OPEN_TRACEROUTE_MAX_FAIL 255                      
 #define OPEN_TRACEROUTE_MIN_INTERVAL 1              
 #define OPEN_TRACEROUTE_MAX_INTERVAL 60              
 #define OPEN_TRACEROUTE_MIN_PORT 0                      
 #define OPEN_TRACEROUTE_MIN_PORT 0                      
 #define OPEN_TRACEROUTE_MAX_PORT 65535                      
 #define OPEN_TRACEROUTE_MAX_PORT 65535                      
 #define OPEN_TRACEROUTE_MIN_PROBE_SIZE 0          
 #define OPEN_TRACEROUTE_MAX_PROBE_SIZE 39936          