channel_interface_binding

Last published : Oct 30, 2026
Binding object showing the interface that can be bound to channel.

Properties

(click to see Operations)
Name Data Type Permissions Description
svmcmd <Double> Read-write New attribute added to identify the source of cmd, when SVM fires the nitro cmd, it will set the value of SVMCMD to be 1. .
Default value: 0
ifnum <String[]> Read-write Interfaces to be bound to the LA channel of a Citrix ADC or to the LA channel of a cluster configuration. For an LA channel of a Citrix ADC, specify an interface in C/U notation (for example, 1/3). For an LA channel of a cluster configuration, specify an interface in N/C/U notation (for example, 2/1/3). where C can take one of the following values: * 0 - Indicates a management interface. * 1 - Indicates a 1 Gbps port. * 10 - Indicates a 10 Gbps port. U is a unique integer for representing an interface in a particular port group. N is the ID of the node to which an interface belongs in a cluster configuration. Use spaces to separate multiple entries.
id <String> Read-write ID of the LA channel or the cluster LA channel to which you want to bind interfaces. Specify an LA channel in LA/x notation, where x can range from 1 to 8 or a cluster LA channel in CLA/x notation or Link redundant channel in LR/x notation , where x can range from 1 to 4.
lamode <String> Read-only The mode(AUTO/MANNUAL) for the LA channel.
Possible values = MANUAL, AUTO
slavespeed <Double> Read-only Speed of the member interfaces.
slavemedia <Double> Read-only Media type of the member interfaces.
slaveduplex <Double> Read-only Duplex of the member interfaces.
lractiveintf <Boolean> Read-only LR set member interface state(active/inactive).
slaveflowctl <Double> Read-only Flowcontrol of the member interfaces.
slavetime <Double> Read-only UP time of the member interfaces.
slavestate <Double> Read-only State of the member interfaces.
__count <Double> Read-only count parameter

Operations

(click to see Properties)
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>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)/nitro/v1/config/channel_interface_binding
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:

{
"channel_interface_binding":{
<b>"id":<String_value>,
</b><b>"ifnum":<String[]_value></b>
}}
Response:
HTTP Status Code on Success: 201 Created 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 error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/channel_interface_binding/id_value<String>
Query-parameters:
args
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/channel_interface_binding/id_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 Citrix ADC specific errors). The response payload provides details of the error

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/channel_interface_binding/id_value<String>
Query-parameters:
filter
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/channel_interface_binding/id_value<String>?filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of channel_interface_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/channel_interface_binding/id_value<String>?pagesize=#no;pageno=#no
Use this query-parameter to get the channel_interface_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:

{ "channel_interface_binding": [ {
"svmcmd":<Double_value>,
"ifnum":<String[]_value>,
"id":<String_value>,
"lamode":<String_value>,
"slavespeed":<Double_value>,
"slavemedia":<Double_value>,
"slaveduplex":<Double_value>,
"lractiveintf":<Boolean_value>,
"slaveflowctl":<Double_value>,
"slavetime":<Double_value>,
"slavestate":<Double_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/channel_interface_binding
Query-parameters:
bulkbindings
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/channel_interface_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:

{ "channel_interface_binding": [ {
"svmcmd":<Double_value>,
"ifnum":<String[]_value>,
"id":<String_value>,
"lamode":<String_value>,
"slavespeed":<Double_value>,
"slavemedia":<Double_value>,
"slaveduplex":<Double_value>,
"lractiveintf":<Boolean_value>,
"slaveflowctl":<Double_value>,
"slavetime":<Double_value>,
"slavestate":<Double_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/channel_interface_binding/id_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:

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