Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

fis_channel_binding

August 17, 2023
Contributed by: 
C

Binding object showing the channel 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).
__count Read-write count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • 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 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_channel_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{
"fis_channel_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_channel_binding/ name_value<String>

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/fis_channel_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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/fis_channel_binding/ name_value<String>

Query-parameters:

filter

http:// <netscaler-ip-address> /nitro/v1/config/fis_channel_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

pagination

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

Use this query-parameter to get the fis_channel_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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{  "fis_channel_binding": [ {
      "ownernode":<Double_value>,
      "name":<String_value>,
      "ifnum":<String_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/fis_channel_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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: 


{  "fis_channel_binding": [ {
      "ownernode":<Double_value>,
      "name":<String_value>,
      "ifnum":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/fis_channel_binding/ name_value<String> ? 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: 


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

<!--NeedCopy-->
fis_channel_binding
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.