ADC NITRO APIs

bfdsession

August 17, 2023

Contributed by:

Configuration for BFD configuration resource.

Properties

(click to see Operations )

Name	Permissions	Description
localip	Read-write	IPV4 or IPV6 Address of Local Node.
remoteip	Read-write	IPV4 or IPV6 Address of Remote Node.
state	Read-only	Current state of the BFD session. Possible values = ADMIN DOWN, DOWN, INIT, UP
localport	Read-only	Source Port used by Local node to send Control packets for the BFD session.
remoteport	Read-only	Source Port used by Remote node to send Control packets for the BFD session.
minimumtransmitinterval	Read-only	Minimum trasmit interval, in milliseconds, the local node would like to use when transmitting BFD Control packets.
negotiatedminimumtransmitinterval	Read-only	Negotiated Minimum Transmit Interval. This is the interval at which the local node will be sending out BFD control packets.
minimumreceiveinterval	Read-only	Minimum receive interval, in milliseconds, between received BFD Control packets that the local node is capable of supporting.
negotiatedminimumreceiveinterval	Read-only	Negotiated Minimum Receive Interval. This is the interval at which the local node will be expecting BFD control packets.
multiplier	Read-only	Detection Multiplier. The negotiated transmit interval multiplied by Detection multiplier provides the Detection Time for the remote node for the BFD session.
remotemultiplier	Read-only	Your Multiplier. The negotiated receive interval multiplied by Your Multiplier provides the Detection Time for the local node for the BFD session.
vlan	Read-only	VLAN ID on which the BDS session is configured.
localdiagnotic	Read-only	Diagnostic Code specifying the local system’s reason for the last change in session state.
localdiscriminator	Read-only	A unique discriminator value generated by the local node for the session.
remotediscriminator	Read-only	A unique discriminator value as received from the remote node for the session.
passive	Read-only	Flag indicating that the session is passive.
multihop	Read-only	Flag indicating if the session is multihop.
admindown	Read-only	Flag indicating if admin down is being sent.
originalownerpe	Read-only	Original Owner PE of the BFD session.
currentownerpe	Read-only	Current Owner PE of the BFD session.
ownernode	Read-only	The owner node in a Cluster for this BFD session. Owner node can vary from 0 to 31. If ownernode is not specified then the session is treated as Striped session. Default value: 255
__count	Read-only	count parameter

Operations

(click to see Properties )

GET (ALL)
COUNT

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/bfdsession

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/bfdsession? args=localip: <String_value> ,remoteip: <String_value>

Use this query-parameter to get bfdsession resources based on additional properties.

attrs

http:// <netscaler-ip-address> /nitro/v1/config/bfdsession? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/bfdsession? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of bfdsession resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/bfdsession? view=summary

Use this query-parameter to get the summary output of bfdsession resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/bfdsession? pagesize=#no;pageno=#no

Use this query-parameter to get the bfdsession resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

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 Header:

Content-Type:application/json

Response Payload:

{ "bfdsession": [ {
localip:<String_value>,remoteip:<String_value>      "state":<String_value>,
      "localport":<Double_value>,
      "remoteport":<Double_value>,
      "minimumtransmitinterval":<Double_value>,
      "negotiatedminimumtransmitinterval":<Double_value>,
      "minimumreceiveinterval":<Double_value>,
      "negotiatedminimumreceiveinterval":<Double_value>,
      "multiplier":<Double_value>,
      "remotemultiplier":<Double_value>,
      "vlan":<Double_value>,
      "localdiagnotic":<Double_value>,
      "localdiscriminator":<Double_value>,
      "remotediscriminator":<Double_value>,
      "passive":<Boolean_value>,
      "multihop":<Boolean_value>,
      "admindown":<Boolean_value>,
      "originalownerpe":<Double_value>,
      "currentownerpe":<Double_value>,
      "ownernode":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/bfdsession? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

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 Header:

Content-Type:application/json

Response Payload:

{ "bfdsession": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

bfdsession

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

bfdsession

Properties

Operations

get (all)

count

In this article