ADC NITRO APIs

fis_interface_binding

Binding object showing the interface that can be bound to fis.

Properties

(click to see Operations )

Name Data Type Permissions Description
ownernode Read-write ID of the cluster node for which you are creating the FIS. Can be configured only through the cluster IP address.

Minimum value = 0

Maximum value = 31
name Read-write The name of the FIS to which you want to bind interfaces.

Minimum length = 1
ifnum Read-write Interface to be bound to the FIS, specified in slot/port notation (for example, 1/3).

Operations

(click to see Properties )

  • ADD
  • DELETE

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/fis_interface_binding HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"fis_interface_binding":{
<b>"name":<String_value>,
</b><b>"ifnum":<String_value></b>
}}

<!--NeedCopy-->

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/fis_interface_binding/ name_value<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/fis_interface_binding/ name_value<String> ? args= ifnum:<String_value>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

fis_interface_binding