Skip to content

bfdsession

Configuration for BFD configuration resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
localip<String>Read-writeIPV4 or IPV6 Address of Local Node.
remoteip<String>Read-writeIPV4 or IPV6 Address of Remote Node.
state<String>Read-onlyCurrent state of the BFD session.
Possible values = ADMIN DOWN, DOWN, INIT, UP
localport<Double>Read-onlySource Port used by Local node to send Control packets for the BFD session.
remoteport<Double>Read-onlySource Port used by Remote node to send Control packets for the BFD session.
minimumtransmitinterval<Double>Read-onlyMinimum trasmit interval, in milliseconds, the local node would like to use when transmitting BFD Control packets.
negotiatedminimumtransmitinterval<Double>Read-onlyNegotiated Minimum Transmit Interval. This is the interval at which the local node will be sending out BFD control packets.
minimumreceiveinterval<Double>Read-onlyMinimum receive interval, in milliseconds, between received BFD Control packets that the local node is capable of supporting.
negotiatedminimumreceiveinterval<Double>Read-onlyNegotiated Minimum Receive Interval. This is the interval at which the local node will be expecting BFD control packets.
multiplier<Double>Read-onlyDetection Multiplier. The negotiated transmit interval multiplied by Detection multiplier provides the Detection Time for the remote node for the BFD session.
remotemultiplier<Double>Read-onlyYour Multiplier. The negotiated receive interval multiplied by Your Multiplier provides the Detection Time for the local node for the BFD session.
vlan<Double>Read-onlyVLAN ID on which the BDS session is configured.
localdiagnotic<Double>Read-onlyDiagnostic Code specifying the local system's reason for the last change in session state.
localdiscriminator<Double>Read-onlyA unique discriminator value generated by the local node for the session.
remotediscriminator<Double>Read-onlyA unique discriminator value as received from the remote node for the session.
passive<Boolean>Read-onlyFlag indicating that the session is passive.
multihop<Boolean>Read-onlyFlag indicating if the session is multihop.
admindown<Boolean>Read-onlyFlag indicating if admin down is being sent.
originalownerpe<Double>Read-onlyOriginal Owner PE of the BFD session.
currentownerpe<Double>Read-onlyCurrent Owner PE of the BFD session.
ownernode<Double>Read-onlyThe 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<Double>Read-onlycount 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/bfdsession

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/bfdsession?view=summary

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

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>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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