Citrix ADC 12.1 NITRO API Reference

hanode_ci_binding

Binding object showing the ci that can be bound to hanode.

Properties

(click to see Operations)

Name Data Type Permissions Description
enaifaces Read-write Enabled interfaces.
routemonitor Read-write A route that you want the Citrix ADC to monitor in its internal routing table. You can specify an IPv4 address or network, or an IPv6 address or network prefix. If you specify an IPv4 network address or IPv6 network prefix, the appliance monitors any route that matches the network or prefix.
Minimum length = 1
id Read-write Number that uniquely identifies the local node. The ID of the local node is always 0.
Minimum value = 0
Maximum value = 64
__count Read-write count parameter

Operations

(click to see Properties)

GET 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

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

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/hanode_ci_binding/id_value<Double>?filter=property-name1:property-value1,property-name2:property-value2

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/hanode_ci_binding/id_value<Double>?pagesize=#no;pageno=#no

Use this query-parameter to get the hanode_ci_binding 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:


{ "hanode_ci_binding": [ {
"enaifaces":<String_value>,
"routemonitor":<String_value>,
"id":<Double_value>
}]}

<!--NeedCopy-->

get (all)

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

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/hanode_ci_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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:


{ "hanode_ci_binding": [ {
"enaifaces":<String_value>,
"routemonitor":<String_value>,
"id":<Double_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/hanode_ci_binding/id_value<Double>?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:


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

<!--NeedCopy-->
hanode_ci_binding