bfdInterface

Last published : Oct 30, 2026
Configuration for bfdInterface resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
interval <Integer> Read-write Transmit interval for bfd packets
Minimum value: 100
Maximum value: 30000
minrx <Integer> Read-write Minimim receive interval for bfd packets
Minimum value: 100
Maximum value: 30000
multiplier <Integer> Read-write Multiplier for bfd packets
Minimum value: 1
Maximum value: 20
name <String> Read-write Name of the interface
passive <Boolean> Read-write Make bfd session passive

Operations

(click to see Properties )
  • ADD
  • SET
  • UNSET
  • GET
Some options that you can use for each operations:
  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
    To do this, you must specify the username and password in the request header of the NITRO request as follows:
    X-NITRO-USER: <username>
    X-NITRO-PASS: <password>
    Note: In such cases, make sure that the request header DOES not include the following:
    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/bfdInterface HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"routerDynamicRouting" : {
"bfdInterface" : {
"interval" : <Integer>,
"minrx" : <Integer>,
"multiplier" : <Integer>,
<b>"name" : <String></b>,
"passive" : <Boolean>
}
}}
Response: HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

set

URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/bfdInterface HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"routerDynamicRouting" : {
"bfdInterface" : {
"interval" : <Integer>,
"minrx" : <Integer>,
"multiplier" : <Integer>,
<b>"name" : <String></b>,
"passive" : <Boolean>
}
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/bfdInterface HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"routerDynamicRouting" : {
"bfdInterface" : {
<b>"name" : <String></b>,
"passive" : true
}
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/bfdInterface Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/bfdInterface
Use this query-parameter to get bfdInterface resources based on additional properties.
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Request Payload:
{"routerDynamicRouting" : {
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Payload:
{ "routerDynamicRouting": {
"bfdInterface" : [{
"interval" : <Integer>,
"minrx" : <Integer>,
"multiplier" : <Integer>,
"name" : <String>,
"passive" : <Boolean>
}]
}}