Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | open_bgpDecProcHist_s |
Structure used to report BGP decision process history. More... | |
struct | open_bgpPeerRxAttrErrors_s |
Counters for BGP path attribute errors for received paths. More... | |
struct | open_bgpPeerStatus_s |
Structure used to report BGP peer status. More... | |
Macros | |
#define | OPEN_BGP_AFI_MAX 3 |
Maximum of BGP address family. | |
#define | OPEN_BGP_ERR_STR_LEN 64 |
String length of last Received/Sent error notification message from peer. | |
#define | OPEN_BGP_MAX_DP_REASON_STR 16 |
Maximum length of a reason (Why decision process was triggered) string. | |
#define | OPEN_BGP_MAX_PASSWORD 25 |
Maximum length of neighbor password. | |
#define | OPEN_BGP_MAX_STATS_ENTRIES 20 |
Number of decision process runs to keep in history. | |
#define | OPEN_BGP_MAX_TEMPLATE_NAME 32 |
Maximum length of template name. | |
#define | OPEN_BGP_NBR_MAX_PFX_NOLIMIT 0xFFFFFFFFUL |
For neighbor maximum-prefixes command, indicates no limit. More... | |
#define | OPEN_BGP_PEER_ADDR_STR_LENGTH 128 |
Maximum length of peer address string. | |
#define | OPEN_BGP_PEER_DESC_LENGTH 80 |
Maximum length of peer description. | |
#define | OPEN_BGP_UPD_GROUP_NONE 0xFFFF |
Outbound update group ID that indicates a group is inactive or a group ID is unassigned. | |
Typedefs | |
typedef struct open_bgpDecProcHist_s | open_bgpDecProcHist_t |
Structure used to report BGP decision process history. | |
typedef struct open_bgpPeerRxAttrErrors_s | open_bgpPeerRxAttrErrors_t |
Counters for BGP path attribute errors for received paths. | |
typedef struct open_bgpPeerStatus_s | open_bgpPeerStatus_t |
Structure used to report BGP peer status. | |
Functions | |
open_error_t | openapiBgpAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode) |
Gets the Bgp Admin Mode. More... | |
open_error_t | openapiBgpAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode) |
Sets the Bgp Admin mode. More... | |
open_error_t | openapiBgpGlobalHoldTimeConfiguredGet (openapiClientHandle_t *client_handle, uint32_t *holdTime) |
Get the configured hold time for all peers. More... | |
open_error_t | openapiBgpGlobalHoldTimeConfiguredSet (openapiClientHandle_t *client_handle, uint32_t holdTime) |
Set the configured hold time for all peers. More... | |
open_error_t | openapiBgpGlobalKeepAliveConfiguredGet (openapiClientHandle_t *client_handle, uint32_t *keepAlive) |
Get the configured keep alive time for all peers. More... | |
open_error_t | openapiBgpGlobalKeepAliveConfiguredSet (openapiClientHandle_t *client_handle, uint32_t keepAlive) |
Set the configured keep alive time for all peers. More... | |
open_error_t | openapiBgpIpv4RouteMax (openapiClientHandle_t *client_handle, uint32_t *maxRoutes) |
Get the (configured) maximum number of BGP IPv4 routes for this platform. More... | |
open_error_t | openapiBgpIpv6RouteMax (openapiClientHandle_t *client_handle, uint32_t *maxRoutes) |
Get the (configured) maximum number of BGP IPv6 routes for this platform. More... | |
open_error_t | openapiBgpLocalASGet (openapiClientHandle_t *client_handle, uint32_t *localAS) |
Get the Local Autonomous System (AS) number. More... | |
open_error_t | openapiBgpLocalASSet (openapiClientHandle_t *client_handle, uint32_t localAS) |
Set the Local Autonomous System (AS) number. More... | |
open_error_t | openapiBgpLocalIdGet (openapiClientHandle_t *client_handle, uint32_t *routerId) |
Get the BGP router ID. More... | |
open_error_t | openapiBgpLocalIdSet (openapiClientHandle_t *client_handle, uint32_t routerId) |
Set the BGP router ID. More... | |
open_error_t | openapiBgpLocalPrefGet (openapiClientHandle_t *client_handle, uint32_t *localPref) |
Get the value of local preference attribute. More... | |
open_error_t | openapiBgpLocalPrefSet (openapiClientHandle_t *client_handle, uint32_t localPref) |
Set the value of local preference attribute. More... | |
open_error_t | openapiBgpLogNeighborChangesGet (openapiClientHandle_t *client_handle, bool *log) |
Get the log neighbor changes parameter. More... | |
open_error_t | openapiBgpLogNeighborChangesSet (openapiClientHandle_t *client_handle, bool log) |
Enable/Disable log neighbor changes. More... | |
open_error_t | openapiBgpMapDecProcHistoryByIndexGet (openapiClientHandle_t *client_handle, OPEN_AF_t af, uint32_t index, open_bgpDecProcHist_t *pHist) |
Get Decision Process History information of BGP for a given index and address family. More... | |
open_error_t | openapiBgpMapDecProcHistoryCountGet (openapiClientHandle_t *client_handle, OPEN_AF_t af, uint32_t *numEntries) |
Get Decision Process History count of BGP for a given address family. More... | |
open_error_t | openapiBgpMapGlobalStatusInfoGet (openapiClientHandle_t *client_handle, OPEN_AF_t af, uint32_t *numNetworks, uint32_t *numAsPaths) |
Get BGP global status of number of network entries and number of AS paths. More... | |
open_error_t | openapiBgpMapPeerConnRetryIntervalGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t *connRetryInterval) |
Get the connection retry interval for a given BGP peer. More... | |
open_error_t | openapiBgpMapPeerFalloverBfdGet (openapiClientHandle_t *client_handle, open_inet_addr_t peerAddr, uint32_t scopeId, OPEN_BOOL_t *enableBfd) |
Get the BFD fast fallover setting to the peer. More... | |
open_error_t | openapiBgpMapPeerFlapCountGet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, uint32_t *flapCount) |
Get flap count of given neighbor. More... | |
open_error_t | openapiBgpMapPeerPasswordGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, open_buffdesc *bufdName) |
Get the TCP MD5 password for a given peer. More... | |
open_error_t | openapiBgpMapPeerPasswordMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *maxLen) |
Get maximum length of password. More... | |
open_error_t | openapiBgpMapPeerPasswordSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, open_buffdesc *bufdName, bool defValue) |
Set the TCP MD5 password for a given peer. More... | |
open_error_t | openapiBgpMapPeerRemoteAddrGetNext (openapiClientHandle_t *client_handle, OPEN_AF_t af, open_inet_addr_t prevRemoteAddr, uint32_t prevScopeId, open_inet_addr_t *remoteAddr, uint32_t *scopeId) |
Given the IP address of one peer, get the IP address of the next peer. More... | |
open_error_t | openapiBgpMapPeerRemoteAddrVrfGetNext (openapiClientHandle_t *client_handle, OPEN_AF_t af, open_inet_addr_t prevRemoteAddr, uint32_t prevScopeId, open_buffdesc *vrf, open_inet_addr_t *remoteAddr, uint32_t *scopeId) |
Given the IP address of one peer, and a VRF name, get the IP address of the next peer. More... | |
open_error_t | openapiBgpMapPeerStatusGet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, open_bgpPeerStatus_t *status) |
Get the status of a peer for a default VRF instance with a given IP address. More... | |
open_error_t | openapiBgpMapPeerStatusVrfGet (openapiClientHandle_t *client_handle, open_buffdesc *vrf, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, open_bgpPeerStatus_t *status) |
Get the status of a peer for the given VRF instance and IP address. More... | |
open_error_t | openapiBgpMaxPathsGet (openapiClientHandle_t *client_handle, OPEN_AF_t af, bool isIbgp, uint32_t *maxPaths) |
Get the value of maximum Paths attribute. More... | |
open_error_t | openapiBgpMaxPathsSet (openapiClientHandle_t *client_handle, OPEN_AF_t af, bool isIbgp, uint32_t maxPaths) |
Set the value of maximum Paths attribute. More... | |
open_error_t | openapiBgpNetworkAddDelete (openapiClientHandle_t *client_handle, bool normalMode, bool useRm, open_inet_addr_t addr, uint32_t pfxLen, open_buffdesc *rmName) |
Add or Delete a logically originated network. More... | |
open_error_t | openapiBgpPeerActivateGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, bool *activate) |
Determine whether a given peer is configured to exchange routes for a given address family. More... | |
open_error_t | openapiBgpPeerActivateSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, bool activate, bool defValue) |
Configure whether a given peer advertises and accepts routes for a given address family. More... | |
open_error_t | openapiBgpPeerAddressStringMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *maxLen) |
Gets the BGP peer address name string length. More... | |
open_error_t | openapiBgpPeerAddrScopeCat (openapiClientHandle_t *client_handle, open_buffdesc *bufdName, uint32_t scopeId) |
Utility to concatenate an address scope to a peer address. More... | |
open_error_t | openapiBgpPeerAdminStatusGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_BGP_PEER_STATE_t *status) |
Get the administrative status (start/stop) of a given BGP peer. More... | |
open_error_t | openapiBgpPeerAdminStatusSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_BGP_PEER_STATE_t status, bool defValue) |
Set the administrative status (start/stop) of a given BGP peer. More... | |
open_error_t | openapiBgpPeerAdminStatusVrfGet (openapiClientHandle_t *client_handle, open_buffdesc *vrf, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_BGP_PEER_STATE_t *status) |
Get the administrative status (start/stop) of a given BGP peer. More... | |
open_error_t | openapiBgpPeerAdminStatusVrfSet (openapiClientHandle_t *client_handle, open_buffdesc *vrf, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_BGP_PEER_STATE_t status, bool defValue) |
Set the administrative status (start/stop) of a given BGP peer. More... | |
open_error_t | openapiBgpPeerAdvertisementIntervalGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, uint32_t *interval) |
Get the advertisement interval for a given BGP peer. More... | |
open_error_t | openapiBgpPeerAdvertisementIntervalSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, uint32_t interval, bool defValue) |
Set the advertisement interval for a given BGP peer. More... | |
open_error_t | openapiBgpPeerAutodetectedIpGet (openapiClientHandle_t *client_handle, uint32_t scopeId, open_inet_addr_t *nbrPeerAddr) |
Get the IP address of autodetected peer on the specifed interface. More... | |
open_error_t | openapiBgpPeerDescriptionGet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, open_buffdesc *bufdName) |
Get the description for a given peer. More... | |
open_error_t | openapiBgpPeerDescriptionNameMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *maxLen) |
Gets the description name maximum length. More... | |
open_error_t | openapiBgpPeerDescriptionSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, open_buffdesc *bufdName, bool defValue) |
Set the description field for the specified peer. More... | |
open_error_t | openapiBgpPeerDescriptionVrfGet (openapiClientHandle_t *client_handle, open_buffdesc *vrf, open_inet_addr_t remoteAddr, uint32_t scopeId, open_buffdesc *bufdName) |
Get the description for a given peer. More... | |
open_error_t | openapiBgpPeerDescriptionVrfSet (openapiClientHandle_t *client_handle, open_buffdesc *vrf, open_inet_addr_t remoteAddr, uint32_t scopeId, open_buffdesc *bufdName, bool defValue) |
Set the description field for the specified peer. More... | |
open_error_t | openapiBgpPeerHoldTimeConfiguredGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t *holdTime) |
Get the configured hold time for a given BGP peer. More... | |
open_error_t | openapiBgpPeerHoldTimeConfiguredSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t holdTime, bool defValue) |
Set the configured hold time for a given BGP peer. More... | |
open_error_t | openapiBgpPeerInheritGet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, open_buffdesc *bufdName) |
Get the template name for a given peer. More... | |
open_error_t | openapiBgpPeerInheritSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, open_buffdesc *bufdName, bool defValue) |
Configure a given peer to inherit configuration parameters from a named peer template. More... | |
open_error_t | openapiBgpPeerKeepAliveConfiguredGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t *keepAlive) |
Get the configured keep alive time for a given BGP peer. More... | |
open_error_t | openapiBgpPeerKeepAliveConfiguredSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t keepAlive, bool defValue) |
Set the configured keep alive time for a given BGP peer. More... | |
open_error_t | openapiBgpPeerNextHopSelfModeGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, OPEN_CONTROL_t *enable) |
Determine whether BGP sets the BGP NEXT_HOP to a local address when forwarding external routes to a given internal peer. More... | |
open_error_t | openapiBgpPeerNextHopSelfModeSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, OPEN_CONTROL_t enable, bool defValue) |
Configure BGP to use a local address when advertising routes to a given internal peer. More... | |
open_error_t | openapiBgpPeerPfxLimitGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, uint32_t *pfxLimit, uint32_t *threshold, bool *warningOnly) |
Get the prefix limit configured for a given peer. More... | |
open_error_t | openapiBgpPeerPfxLimitSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, OPEN_AF_t af, uint32_t pfxLimit, uint32_t threshold, bool warningOnly, bool defValue) |
Set the prefix limit configured for a given peer. More... | |
open_error_t | openapiBgpPeerRemoteASGet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t *remoteAS) |
Return a remote Autonomous System (AS) number that this peer belongs to. More... | |
open_error_t | openapiBgpPeerRemoteASSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t remoteAS) |
Create a peer with a given IP address and Autonomous System (AS) number. More... | |
open_error_t | openapiBgpPeerRemoteASVrfGet (openapiClientHandle_t *client_handle, open_buffdesc *vrf, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t *remoteAS) |
Return a remote Autonomous System (AS) number that this peer belongs to. More... | |
open_error_t | openapiBgpPeerRemoteASVrfSet (openapiClientHandle_t *client_handle, open_buffdesc *vrf, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t remoteAS) |
Create a peer with a given IP address and Autonomous System (AS) number. More... | |
open_error_t | openapiBgpPeerUpdateSourceGet (openapiClientHandle_t *client_handle, OPEN_BGP_PARAM_TYPE pType, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t *source) |
Get the interface whose IP address that BGP uses as the source IP address in packets sent to a given peer. More... | |
open_error_t | openapiBgpPeerUpdateSourceSet (openapiClientHandle_t *client_handle, open_inet_addr_t remoteAddr, uint32_t scopeId, uint32_t source, bool defValue) |
Set the interface whose IP address that BGP uses as the source IP address in packets sent to a given peer. More... | |
open_error_t | openapiBgpRedistributionSet (openapiClientHandle_t *client_handle, bool add, open_buffdesc *protoName, bool matchSet, uint32_t matchBits, bool metricSet, bool metricValueSet, uint32_t metricValue, bool routeMapSet, OPEN_AF_t af, open_buffdesc *rmName) |
Set route redistribution options for routes learned from a specific source. More... | |
open_error_t | openapiBgpTemplateAFClear (openapiClientHandle_t *client_handle, open_buffdesc *bufdName, OPEN_AF_t af) |
Clear the address-family of given template. More... | |
open_error_t | openapiBgpTemplateAFSet (openapiClientHandle_t *client_handle, open_buffdesc *bufdName, OPEN_AF_t af) |
Set the address-family of given template. More... | |
open_error_t | openapiBgpTemplateDelete (openapiClientHandle_t *client_handle, open_buffdesc *bufdName) |
Clear the template name and inuse flag. More... | |
open_error_t | openapiBgpTemplateNameMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *maxLen) |
Gets the Template Name string length. More... | |
open_error_t | openapiBgpTemplateSendCommunitySet (openapiClientHandle_t *client_handle, open_buffdesc *bufdName, OPEN_AF_t af, OPEN_CONTROL_t enable) |
Clear the address-family of given template. More... | |
open_error_t | openapiBgpTemplateSet (openapiClientHandle_t *client_handle, open_buffdesc *bufdName) |
Set the template name and inuse flag. More... | |
#define OPEN_BGP_NBR_MAX_PFX_NOLIMIT 0xFFFFFFFFUL |
For neighbor maximum-prefixes command, indicates no limit.
Definition at line 44 of file openapi_bgp_config.h.
Definition at line 87 of file openapi_bgp_config.h.
Enumerator | |
---|---|
OPEN_BGP_PEER_TYPE_DYNAMIC |
Dynamic. |
OPEN_BGP_PEER_TYPE_STATIC |
Static. |
OPEN_BGP_PEER_TYPE_UNSPECIFIED |
Unspecified or IPv6. |
Definition at line 98 of file openapi_bgp_config.h.
enum OPEN_BGP_PARAM_TYPE |
A peer can inherit parameter values from a peer template.
When we query the value of a configuration parameter for a peer, sometimes we want the value configured on the peer itself, even if that is just the default value. In other contexts, we want to get the actual value in use for the peer, whether that is configured on the peer or inherited from a template. This enumeration is used to indicate which value we want when we get a configuration parameter for a peer.
Enumerator | |
---|---|
OPEN_BGP_GET_FINAL |
peer or inherited value from template |
OPEN_BGP_GET_PEER |
peer value |
Definition at line 74 of file openapi_bgp_config.h.
Start or stop a BGP peer.
Enumerator | |
---|---|
OPEN_BGP_STOP |
Shutdown. |
OPEN_BGP_START |
Startup. |
Definition at line 81 of file openapi_bgp_config.h.
enum OPEN_E_OPTCAPTYPES_t |
Enumerator | |
---|---|
OPEN_MULTI_PROTOCOL_CAP |
Multi-protocol. |
OPEN_ROUTE_REFLECT_CAP |
Route Reflect. |
OPEN_COMMUNITIES_CAP |
Communities. |
OPEN_CONFEDERATION_CAP |
Confederation. |
OPEN_ROUTE_REFRESH_CAP |
Route Refresh. |
Definition at line 105 of file openapi_bgp_config.h.
OSPF redistribution metric bits for match option.
Definition at line 58 of file openapi_bgp_config.h.
open_error_t openapiBgpAdminModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | adminMode | ||
) |
Gets the Bgp Admin Mode.
[in] | client_handle | client handle from registration API |
[out] | adminMode | status of admin mode |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Set failed if the api failed to get admin mode. |
OpEN API Version: 1.6
open_error_t openapiBgpAdminModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | adminMode | ||
) |
Sets the Bgp Admin mode.
[in] | client_handle | client handle from registration API |
[in] | adminMode | status of admin mode |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Set failed if the api failed to set admin mode. |
OpEN API Version: 1.6
open_error_t openapiBgpGlobalHoldTimeConfiguredGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | holdTime | ||
) |
Get the configured hold time for all peers.
[in] | client_handle | client handle from registration API |
[out] | holdTime | hold time (secs) |
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 openapiBgpGlobalHoldTimeConfiguredSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | holdTime | ||
) |
Set the configured hold time for all peers.
[in] | client_handle | client handle from registration API |
[in] | holdTime | hold time (secs) |
- | Minimum value OPENAPI_BGP4_HOLD_TIME_MIN | |
- | Maximum value OPENAPI_BGP4_HOLD_TIME_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpGlobalKeepAliveConfiguredGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | keepAlive | ||
) |
Get the configured keep alive time for all peers.
[in] | client_handle | client handle from registration API |
[out] | keepAlive | keep alive time (secs) |
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 openapiBgpGlobalKeepAliveConfiguredSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | keepAlive | ||
) |
Set the configured keep alive time for all peers.
[in] | client_handle | client handle from registration API |
[in] | keepAlive | keep alive time (secs) |
- | Minimum value OPENAPI_BGP4_KEEP_ALIVE_TIME_MIN | |
- | Maximum value OPENAPI_BGP4_KEEP_ALIVE_TIME_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpIpv4RouteMax | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxRoutes | ||
) |
Get the (configured) maximum number of BGP IPv4 routes for this platform.
[in] | client_handle | client handle from registration API |
[out] | maxRoutes | maximum number of routes |
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 openapiBgpIpv6RouteMax | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxRoutes | ||
) |
Get the (configured) maximum number of BGP IPv6 routes for this platform.
[in] | client_handle | client handle from registration API |
[out] | maxRoutes | maximum number of routes |
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 openapiBgpLocalASGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | localAS | ||
) |
Get the Local Autonomous System (AS) number.
[in] | client_handle | client handle from registration API |
[out] | localAS | local AS number |
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 openapiBgpLocalASSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | localAS | ||
) |
Set the Local Autonomous System (AS) number.
[in] | client_handle | client handle from registration API |
[in] | localAS | local AS number |
- | Minimum value 0 | |
- | Maximum value signed integer (65535) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpLocalIdGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | routerId | ||
) |
Get the BGP router ID.
[in] | client_handle | client handle from registration API |
[out] | routerId | router id |
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 openapiBgpLocalIdSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | routerId | ||
) |
Set the BGP router ID.
[in] | client_handle | client handle from registration API |
[in] | routerId | router ipv4 address for BGP |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpLocalPrefGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | localPref | ||
) |
Get the value of local preference attribute.
[in] | client_handle | client handle from registration API |
[out] | localPref | local preference |
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 openapiBgpLocalPrefSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | localPref | ||
) |
Set the value of local preference attribute.
[in] | client_handle | client handle from registration API |
[in] | localPref | local preference |
- | Minimum value 0 | |
- | Maximum value unsigned integer (4294967295) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpLogNeighborChangesGet | ( | openapiClientHandle_t * | client_handle, |
bool * | log | ||
) |
Get the log neighbor changes parameter.
[in] | client_handle | client handle from registration API |
[out] | log | if true, then logging is allowed |
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 openapiBgpLogNeighborChangesSet | ( | openapiClientHandle_t * | client_handle, |
bool | log | ||
) |
Enable/Disable log neighbor changes.
[in] | client_handle | client handle from registration API |
[in] | log | if true, then logging is allowed |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpMapDecProcHistoryByIndexGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | af, | ||
uint32_t | index, | ||
open_bgpDecProcHist_t * | pHist | ||
) |
Get Decision Process History information of BGP for a given index and address family.
[in] | client_handle | client handle from registration API |
[in] | af | address family |
[in] | index | index of process history information |
[out] | pHist | pointer to the history structure open_bgpDecProcHist_t |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpMapDecProcHistoryCountGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | af, | ||
uint32_t * | numEntries | ||
) |
Get Decision Process History count of BGP for a given address family.
[in] | client_handle | client handle from registration API |
[in] | af | address family |
[out] | numEntries | process history count |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpMapGlobalStatusInfoGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | af, | ||
uint32_t * | numNetworks, | ||
uint32_t * | numAsPaths | ||
) |
Get BGP global status of number of network entries and number of AS paths.
[in] | client_handle | client handle from registration API |
[in] | af | address family |
[out] | numNetworks | Number of distinct prefixes in the local RIB |
[out] | numAsPaths | Number of AS paths in the local RIB |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Failed to get BGP global status |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerConnRetryIntervalGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t * | connRetryInterval | ||
) |
Get the connection retry interval for a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[out] | connRetryInterval | connection retry interval in seconds |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerFalloverBfdGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | peerAddr, | ||
uint32_t | scopeId, | ||
OPEN_BOOL_t * | enableBfd | ||
) |
Get the BFD fast fallover setting to the peer.
[in] | client_handle | client handle from registration API |
[in] | peerAddr | IP address of peer |
[in] | scopeId | address scope |
[out] | enableBfd | OPEN_TRUE is BFD session is desired |
OPEN_E_NONE | Get successful |
OPEN_E_NOT_FOUND | if the neighbor is not found |
OPEN_E_FAIL | any other failure |
OPEN_E_UNAVAIL | BFD feature is not supported on this platform |
OPEN_E_PARAM | Error in parameter passed |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerFlapCountGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
uint32_t * | flapCount | ||
) |
Get flap count of given neighbor.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[in] | af | address family |
[out] | flapCount | number of times the given peer state changed from established to idle |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerPasswordGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
open_buffdesc * | bufdName | ||
) |
Get the TCP MD5 password for a given peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[out] | bufdName | password Must be at least OPEN_BGP_MAX_PASSWORD + 1. |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerPasswordMaxLengthGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxLen | ||
) |
Get maximum length of password.
[in] | client_handle | client handle from registration API |
[out] | maxLen | string length maximum length OPEN_BGP_MAX_PASSWORD |
OPEN_E_NONE | String length Get successful. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerPasswordSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
open_buffdesc * | bufdName, | ||
bool | defValue | ||
) |
Set the TCP MD5 password for a given peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[out] | bufdName | TCP MD5 password to set
|
[in] | defValue | true if interval is set to a non-default value |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerRemoteAddrGetNext | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | af, | ||
open_inet_addr_t | prevRemoteAddr, | ||
uint32_t | prevScopeId, | ||
open_inet_addr_t * | remoteAddr, | ||
uint32_t * | scopeId | ||
) |
Given the IP address of one peer, get the IP address of the next peer.
[in] | client_handle | client handle from registration API |
[in] | af | address family |
[in] | prevRemoteAddr | IP address of previous peer. Pass NULL to get the first peer. |
[in] | prevScopeId | scope ID of previous peer |
[out] | remoteAddr | IP address of next peer |
[out] | scopeId | (optional) scope ID of next peer address |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Failed to get next peer address |
OPEN_E_INTERNAL | Lower-level error occurred |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerRemoteAddrVrfGetNext | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | af, | ||
open_inet_addr_t | prevRemoteAddr, | ||
uint32_t | prevScopeId, | ||
open_buffdesc * | vrf, | ||
open_inet_addr_t * | remoteAddr, | ||
uint32_t * | scopeId | ||
) |
Given the IP address of one peer, and a VRF name, get the IP address of the next peer.
[in] | client_handle | client handle from registration API |
[in] | af | address family |
[in] | prevRemoteAddr | IP address of previous peer. Pass NULL to get the first peer. |
[in] | prevScopeId | scope ID of previous peer |
[in] | vrf | VRF name. Use "" for default. |
[out] | remoteAddr | IP address of next peer |
[out] | scopeId | (optional) scope ID of next peer address |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Failed to get next peer address |
OPEN_E_INTERNAL | Lower-level error occurred |
OpEN API Version: 1.15
open_error_t openapiBgpMapPeerStatusGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
open_bgpPeerStatus_t * | status | ||
) |
Get the status of a peer for a default VRF instance with a given IP address.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the IP address of the peer |
[in] | scopeId | scope ID of the peer's IP address |
[in] | af | address family of interest (only affects which minRouteAdvInterval is reported) |
[out] | status | the status record to fill |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Failed to get status of given peer |
OPEN_E_NOT_FOUND | No peer with the given IP address |
OPEN_E_INTERNAL | Lower-level error occurred |
OpEN API Version: 1.6
open_error_t openapiBgpMapPeerStatusVrfGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vrf, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
open_bgpPeerStatus_t * | status | ||
) |
Get the status of a peer for the given VRF instance and IP address.
[in] | client_handle | Client handle from registration API |
[in] | vrf | VRF name. Use "" for default. Maximum length L7_VRF_MAX_NAME_LEN |
[in] | remoteAddr | The IP address of the peer |
[in] | scopeId | Scope ID of the peer's IP address |
[in] | af | Address family of interest (only affects which minRouteAdvInterval is reported) |
[out] | status | The status record to fill |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Failed to get status of given peer |
OPEN_E_NOT_FOUND | No peer with the given IP address |
OPEN_E_INTERNAL | Lower-level error occurred |
OpEN API Version: 1.15
open_error_t openapiBgpMaxPathsGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | af, | ||
bool | isIbgp, | ||
uint32_t * | maxPaths | ||
) |
Get the value of maximum Paths attribute.
[in] | client_handle | client handle from registration API |
[in] | af | address family |
[in] | isIbgp | if true, then selects ibgp else ebgp |
[out] | maxPaths | storage space for maximum path value |
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 openapiBgpMaxPathsSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | af, | ||
bool | isIbgp, | ||
uint32_t | maxPaths | ||
) |
Set the value of maximum Paths attribute.
[in] | client_handle | client handle from registration API |
[in] | af | address family |
[in] | isIbgp | if true, then selects ibgp else ebgp |
[in] | maxPaths | storage space for maximum path value |
- | Minimum value OPENAPI_BGP4_MAXPATH_MIN | |
- | Maximum value openapiBgpMaxPathsGet() |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpNetworkAddDelete | ( | openapiClientHandle_t * | client_handle, |
bool | normalMode, | ||
bool | useRm, | ||
open_inet_addr_t | addr, | ||
uint32_t | pfxLen, | ||
open_buffdesc * | rmName | ||
) |
Add or Delete a logically originated network.
[in] | client_handle | client handle from registration API |
[in] | normalMode | true to add, false to remove |
[in] | useRm | true if a route-map is specified |
[in] | addr | ip address |
[in] | pfxLen | prefix length |
[in] | rmName | route map name |
- | Maximum length OPENAPI_ROUTEMAP_NAME_SIZE_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpPeerActivateGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
bool * | activate | ||
) |
Determine whether a given peer is configured to exchange routes for a given address family.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | af | address family |
[out] | activate | true if address family is active |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OpEN API Version: 1.2
open_error_t openapiBgpPeerActivateSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
bool | activate, | ||
bool | defValue | ||
) |
Configure whether a given peer advertises and accepts routes for a given address family.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | af | address family |
[in] | activate | true if address family is active |
[in] | defValue | true if interval is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_UNAVAIL | Set if there is a failure applying the configuration change |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpPeerAddressStringMaxLengthGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxLen | ||
) |
Gets the BGP peer address name string length.
[in] | client_handle | client handle from registration API |
[out] | maxLen | string length maximum length OPEN_BGP_PEER_ADDR_STR_LENGTH |
OPEN_E_NONE | String length Get successful. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.6
open_error_t openapiBgpPeerAddrScopeCat | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufdName, | ||
uint32_t | scopeId | ||
) |
Utility to concatenate an address scope to a peer address.
[in] | client_handle | client handle from registration API |
[in,out] | bufdName | String representation of peer's IP address
|
[in] | scopeId | address scope |
OPEN_E_NONE | Get successful |
OPEN_E_PARAM | Error in parameter passed |
This is only used for BGP peer addresses, the interface cannot be a loopback interface.
OpEN API Version: 1.6
open_error_t openapiBgpPeerAdminStatusGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_BGP_PEER_STATE_t * | status | ||
) |
Get the administrative status (start/stop) of a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[out] | status | admin status of the peer (start/stop) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.2
open_error_t openapiBgpPeerAdminStatusSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_BGP_PEER_STATE_t | status, | ||
bool | defValue | ||
) |
Set the administrative status (start/stop) of a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | status | admin status of the peer (start/stop) |
[in] | defValue | enable if status is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.2
open_error_t openapiBgpPeerAdminStatusVrfGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vrf, | ||
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_BGP_PEER_STATE_t * | status | ||
) |
Get the administrative status (start/stop) of a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | vrf | VRF name ("" for default) |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[out] | status | admin status of the peer (start/stop) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.16
open_error_t openapiBgpPeerAdminStatusVrfSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vrf, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_BGP_PEER_STATE_t | status, | ||
bool | defValue | ||
) |
Set the administrative status (start/stop) of a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | vrf | VRF name ("" for default) |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | status | admin status of the peer (start/stop) |
[in] | defValue | enable if status is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.16
open_error_t openapiBgpPeerAdvertisementIntervalGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
uint32_t * | interval | ||
) |
Get the advertisement interval for a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | af | address family |
[out] | interval | advertisement interval (secs) |
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 openapiBgpPeerAdvertisementIntervalSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
uint32_t | interval, | ||
bool | defValue | ||
) |
Set the advertisement interval for a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | af | address family |
[in] | interval | advertisement interval (secs) |
- | Minimum value OPENAPI_BGP4_ADV_INTERVAL_MIN | |
- | Maximum value OPENAPI_BGP4_ADV_INTERVAL_MAX | |
[in] | defValue | true if interval is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_UNAVAIL | Set if there is a failure applying the configuration change. Could possibly be due to an invalid route for the specified transport. For example, ipv4 routes not being supported over an ipv6 transport. |
OpEN API Version: 1.2
open_error_t openapiBgpPeerAutodetectedIpGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | scopeId, | ||
open_inet_addr_t * | nbrPeerAddr | ||
) |
Get the IP address of autodetected peer on the specifed interface.
[in] | client_handle | client handle from registration API |
[in] | scopeId | scope ID of the peer's IP address |
[out] | nbrPeerAddr | IP address of detected peer |
OPEN_E_NONE | Get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Get failed |
OPEN_E_ERROR | if the multiple peers are autodetected |
OPEN_E_UNAVAIL | RFC 5549 feature is not supported on this platform |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpPeerDescriptionGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
open_buffdesc * | bufdName | ||
) |
Get the description for a given peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[out] | bufdName | the description of the peer |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpPeerDescriptionNameMaxLengthGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxLen | ||
) |
Gets the description name maximum length.
[in] | client_handle | client handle from registration API |
[out] | maxLen | string length maximum length OPEN_BGP_PEER_DESC_LENGTH |
OPEN_E_NONE | String length Get successful. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.6
open_error_t openapiBgpPeerDescriptionSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
open_buffdesc * | bufdName, | ||
bool | defValue | ||
) |
Set the description field for the specified peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[in] | bufdName | the description of the peer |
[in] | defValue | true if interval is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Set failed. |
OPEN_E_NOT_FOUND | if peer not found |
OPEN_E_INTERNAL | catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpPeerDescriptionVrfGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vrf, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
open_buffdesc * | bufdName | ||
) |
Get the description for a given peer.
[in] | client_handle | client handle from registration API |
[in] | vrf | VRF name ("" for default) |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[out] | bufdName | the description of the peer |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.16
open_error_t openapiBgpPeerDescriptionVrfSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vrf, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
open_buffdesc * | bufdName, | ||
bool | defValue | ||
) |
Set the description field for the specified peer.
[in] | client_handle | client handle from registration API |
[in] | vrf | VRF name ("" for default) |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[in] | bufdName | the description of the peer |
[in] | defValue | true if interval is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Set failed. |
OPEN_E_NOT_FOUND | if peer not found |
OPEN_E_INTERNAL | catch for lower level failures |
OpEN API Version: 1.16
open_error_t openapiBgpPeerHoldTimeConfiguredGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t * | holdTime | ||
) |
Get the configured hold time for a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[out] | holdTime | hold time (secs) |
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 openapiBgpPeerHoldTimeConfiguredSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t | holdTime, | ||
bool | defValue | ||
) |
Set the configured hold time for a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | holdTime | hold time (secs) |
- | Minimum value OPENAPI_BGP4_HOLD_TIME_MIN | |
- | Maximum value OPENAPI_BGP4_HOLD_TIME_MAX | |
[in] | defValue | true if interval is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OpEN API Version: 1.2
open_error_t openapiBgpPeerInheritGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
open_buffdesc * | bufdName | ||
) |
Get the template name for a given peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[in] | bufdName | the template name
|
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpPeerInheritSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
open_buffdesc * | bufdName, | ||
bool | defValue | ||
) |
Configure a given peer to inherit configuration parameters from a named peer template.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | IP address of peer |
[in] | scopeId | address scope |
[in] | bufdName | template name
|
[in] | defValue | true if interval is set to a non-default value |
OPEN_E_NONE | Set successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Set failed |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_INTERNAL | Catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpPeerKeepAliveConfiguredGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t * | keepAlive | ||
) |
Get the configured keep alive time for a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[out] | keepAlive | keep alive time (secs) |
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 openapiBgpPeerKeepAliveConfiguredSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t | keepAlive, | ||
bool | defValue | ||
) |
Set the configured keep alive time for a given BGP peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | keepAlive | keep alive time (secs) |
- | Minimum value OPENAPI_BGP4_KEEP_ALIVE_TIME_MIN | |
- | Maximum value OPENAPI_BGP4_KEEP_ALIVE_TIME_MAX | |
[in] | defValue | true if interval is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OpEN API Version: 1.2
open_error_t openapiBgpPeerNextHopSelfModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
OPEN_CONTROL_t * | enable | ||
) |
Determine whether BGP sets the BGP NEXT_HOP to a local address when forwarding external routes to a given internal peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | af | address family |
[out] | enable | enabled if BGP uses its own address as the BGP NEXT HOP in advertisements to this peer |
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 openapiBgpPeerNextHopSelfModeSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
OPEN_CONTROL_t | enable, | ||
bool | defValue | ||
) |
Configure BGP to use a local address when advertising routes to a given internal peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | af | address family |
[in] | enable | enabled if BGP uses its own address as the BGP NEXT HOP in advertisements to this peer |
[in] | defValue | true if enable is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OpEN API Version: 1.2
open_error_t openapiBgpPeerPfxLimitGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
uint32_t * | pfxLimit, | ||
uint32_t * | threshold, | ||
bool * | warningOnly | ||
) |
Get the prefix limit configured for a given peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | af | address family |
[out] | pfxLimit | maximum number of prefixes |
[out] | threshold | threshold percentage for warning generation |
[out] | warningOnly | true if new prefixes are allowed, but give warning message when limit exceeded. |
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 openapiBgpPeerPfxLimitSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
OPEN_AF_t | af, | ||
uint32_t | pfxLimit, | ||
uint32_t | threshold, | ||
bool | warningOnly, | ||
bool | defValue | ||
) |
Set the prefix limit configured for a given peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | af | address family |
[out] | pfxLimit | maximum number of prefixes (see notes) |
[in] | threshold | threshold percentage for warning generation |
[in] | warningOnly | true if new prefixes are allowed, but give warning message when limit exceeded. |
[in] | defValue | true if source is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OPEN_E_UNAVAIL | Set if there is a failure applying the configuration change. Could possibly be due to an invalid route for the specified transport. For example, ipv4 routes not being supported over an ipv6 transport. |
OpEN API Version: 1.2
open_error_t openapiBgpPeerRemoteASGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t * | remoteAS | ||
) |
Return a remote Autonomous System (AS) number that this peer belongs to.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[out] | remoteAS | AS number of peer |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiBgpPeerRemoteASSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t | remoteAS | ||
) |
Create a peer with a given IP address and Autonomous System (AS) number.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | remoteAS | AS number of peer |
- | Minimum value 0 | |
- | Maximum value signed integer (65535) |
OPEN_E_NONE | set successful. |
OPEN_E_FAIL | set failed. |
OPEN_E_PARAM | error in parameter passed. |
OPEN_E_FULL | exceeded the maximum number of peers |
OPEN_E_UNAVAIL | if a peer is already configured at this IP address but with a different AS number. |
OpEN API Version: 1.2
open_error_t openapiBgpPeerRemoteASVrfGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vrf, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t * | remoteAS | ||
) |
Return a remote Autonomous System (AS) number that this peer belongs to.
[in] | client_handle | client handle from registration API |
[in] | vrf | VRF name ("" for default VRF) |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[out] | remoteAS | AS number of peer |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.16
open_error_t openapiBgpPeerRemoteASVrfSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vrf, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t | remoteAS | ||
) |
Create a peer with a given IP address and Autonomous System (AS) number.
[in] | client_handle | client handle from registration API |
[in] | vrf | VRF name ("" for default VRF) |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | remoteAS | AS number of peer |
- | Minimum value 0 | |
- | Maximum value signed integer (65535) |
OPEN_E_NONE | set successful. |
OPEN_E_FAIL | set failed. |
OPEN_E_PARAM | error in parameter passed. |
OPEN_E_FULL | exceeded the maximum number of peers |
OPEN_E_UNAVAIL | if a peer is already configured at this IP address but with a different AS number. |
OpEN API Version: 1.16
open_error_t openapiBgpPeerUpdateSourceGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_BGP_PARAM_TYPE | pType, | ||
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t * | source | ||
) |
Get the interface whose IP address that BGP uses as the source IP address in packets sent to a given peer.
[in] | client_handle | client handle from registration API |
[in] | pType | Whether to get the value configured directly on the peer or the active value, which may be inherited from a peer template |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[out] | source | internal interface number |
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 openapiBgpPeerUpdateSourceSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t | remoteAddr, | ||
uint32_t | scopeId, | ||
uint32_t | source, | ||
bool | defValue | ||
) |
Set the interface whose IP address that BGP uses as the source IP address in packets sent to a given peer.
[in] | client_handle | client handle from registration API |
[in] | remoteAddr | the peer's IP address |
[in] | scopeId | If remoteAddr has link scope, internal interface number where address is valid |
[in] | source | internal interface number |
[in] | defValue | true if source is set to a non-default value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Set if the neighbor is not found |
OpEN API Version: 1.2
open_error_t openapiBgpRedistributionSet | ( | openapiClientHandle_t * | client_handle, |
bool | add, | ||
open_buffdesc * | protoName, | ||
bool | matchSet, | ||
uint32_t | matchBits, | ||
bool | metricSet, | ||
bool | metricValueSet, | ||
uint32_t | metricValue, | ||
bool | routeMapSet, | ||
OPEN_AF_t | af, | ||
open_buffdesc * | rmName | ||
) |
Set route redistribution options for routes learned from a specific source.
[in] | client_handle | client handle from registration API |
[in] | add | if true, customer is setting or adding options |
[in] | protoName | redistribution route name |
- | Maximum length openapiRouteProtoNameLenMax() | |
[in] | matchSet | if true, set OSPF match |
[in] | matchBits | match options for OSPF |
[in] | metricSet | if true, turn metric options on |
[in] | metricValueSet | if true, use new metric value |
[in] | metricValue | new metric value |
- | Minimum value 0 | |
- | Maximum value unsigned integer (4294967295) | |
[in] | routeMapSet | if true, select optional route map |
[in] | af | address family |
[in] | rmName | route map tag |
- | Maximum length OPENAPI_ROUTEMAP_NAME_SIZE_MAX |
OPEN_E_NONE | set successful. |
OPEN_E_FAIL | set failed. |
OPEN_E_PARAM | error in parameter passed. |
OPEN_E_FULL | if route-map couldn't be created |
OPEN_E_NOT_FOUND | if the route-map name doesn't match (no form) |
OPEN_E_UNAVAIL | if the peer address requires a non-zero scope ID |
OpEN API Version: 1.2
open_error_t openapiBgpTemplateAFClear | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufdName, | ||
OPEN_AF_t | af | ||
) |
Clear the address-family of given template.
[in] | client_handle | client handle from registration API |
[in] | bufdName | template name |
- | Maximum length OPEN_BGP_MAX_TEMPLATE_NAME | |
[in] | af | address family |
OPEN_E_NONE | set successful |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | error in parameter passed |
OPEN_E_INTERNAL | catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpTemplateAFSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufdName, | ||
OPEN_AF_t | af | ||
) |
Set the address-family of given template.
[in] | client_handle | client handle from registration API |
[in] | bufdName | template name |
- | Maximum length OPEN_BGP_MAX_TEMPLATE_NAME | |
[in] | af | address family |
OPEN_E_NONE | set successful |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | error in parameter passed |
OPEN_E_INTERNAL | catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpTemplateDelete | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufdName | ||
) |
Clear the template name and inuse flag.
[in] | client_handle | client handle from registration API |
[in] | bufdName | template name |
- | Maximum length OPEN_BGP_MAX_TEMPLATE_NAME |
OPEN_E_NONE | set successful |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | error in parameter passed |
OPEN_E_NOT_FOUND | set if the template is not found |
OPEN_E_UNAVAIL | set if there is a failure applying the configuration change |
OPEN_E_INTERNAL | catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpTemplateNameMaxLengthGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxLen | ||
) |
Gets the Template Name string length.
This length is used to allocate and initialize the open_buffdesc type argument buffers used by various BGP OpEN APIs.
[in] | client_handle | client handle from registration API |
[out] | maxLen | string length maximum length OPEN_BGP_MAX_TEMPLATE_NAME |
OPEN_E_NONE | String length Get successful. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.6
open_error_t openapiBgpTemplateSendCommunitySet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufdName, | ||
OPEN_AF_t | af, | ||
OPEN_CONTROL_t | enable | ||
) |
Clear the address-family of given template.
[in] | client_handle | client handle from registration API |
[in] | bufdName | template name |
- | Maximum length OPEN_BGP_MAX_TEMPLATE_NAME | |
[in] | af | address family |
OPEN_E_NONE | set successful |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | error in parameter passed |
OPEN_E_INTERNAL | catch for lower level failures |
OpEN API Version: 1.6
open_error_t openapiBgpTemplateSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bufdName | ||
) |
Set the template name and inuse flag.
[in] | client_handle | client handle from registration API |
[in] | bufdName | template name |
- | Maximum length OPEN_BGP_MAX_TEMPLATE_NAME |
OPEN_E_NONE | set successful |
OPEN_E_FAIL | set failed |
OPEN_E_PARAM | error in parameter passed |
OPEN_E_FULL | exceeded the maximum number of templates |
OPEN_E_INTERNAL | catch for lower level failures |
OpEN API Version: 1.6