ns_clag_interface

Last published : Oct 30, 2026
Configuration for CLAG Interface resource.

Properties

(click to see Operations )
Name Data Type Permissions Description
link_redundancy <Boolean> Read-write Link Redundancy. Possible values: ON(for true) and OFF(for false).
channel_tag_all_vlans <Boolean> Read-write If true then all the member interfaces of this channel are tagged. Possible values: true and false.
lacp_channel_time <String> Read-write LACP time. Possible values: long and short.
Minimum length = 4
Maximum length = 10
channel_interface_list <ns_clag_node[]> Read-write Array of CLAG nodes that are part of this channel (10/1, 10/4).
clip <String> Read-write Cluster IPAddress.
Minimum length = 1
Maximum length = 64
channel_alias <String> Read-write Alias name for this channel.
Minimum length = 4
Maximum length = 31
id <String> Read-write Id is system generated key for CLAG.
mtu <Integer> Read-write MTU value, should be between 1500-9216.
Minimum value = 1500
Maximum value =
channel_id <String> Read-write Channel ID if this interface represents a channel (CLA/1, CLA/2 ...).
Minimum length = 5
Maximum length = 5
channel_ha_monitoring <Boolean> Read-write HA-monitoring control for the channel. Possible values: true and false.
lr_min_throughput <Double> Read-write LR Minimum Throughout in Mbps.
Maximum value =
has_foreign_interfaces <Boolean> Read-write Indicates whether CLAG has interfaces from remote SDX. Possible values: true and false.
sync_operation <Boolean> Read-write sync operation.
lacp_channel_mac_address <String> Read-only Mac address of the bond on cluster.
channel_type <String> Read-only Channel type to represent the CLAG type.
channel_state <String> Read-only Indicates CLA state. Possible values: UP and DOWN.
lacp_mode <String> Read-only LACP mode can be either ACTIVE, PASSIVE, DISABLED. Applicable for channel.
act_id <String> Read-only Activity Id.

Operations

(click to see Properties )
  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • UPDATE
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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/ns_clag_interface?onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ns_clag_interface": {
<b>"channel_interface_list":[{
"nodeid":<Integer_value>,
"parent_id":<String_value>,
"id":<String_value>,
"parent_name":<String_value>,
"interface_name":<String_value>,
"local_node":<Boolean_value>}]</b>,
<b>"clip":<String_value></b>,
<b>"channel_id":<String_value></b>,
"lr_min_throughput":<Double_value>,
"has_foreign_interfaces":<Boolean_value>,
"lacp_channel_time":<String_value>,
"id":<String_value>,
"sync_operation":<Boolean_value>,
"channel_tag_all_vlans":<Boolean_value>,
"mtu":<Integer_value>,
"link_redundancy":<Boolean_value>,
"channel_alias":<String_value>,
"channel_ha_monitoring":<Boolean_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_clag_interface":[{
"link_redundancy":<Boolean_value>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"host_type":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"clip":<String_value>,
"channel_alias":<String_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"channel_ha_monitoring":<Boolean_value>,
"channel_state":<String_value>,
"lacp_mode":<String_value>,
"lr_min_throughput":<Double_value>,
"has_foreign_interfaces":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/ns_clag_interface/id_value<String> HTTPS Method: DELETE
Request Headers: X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_clag_interface Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/ns_clag_interface ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_clag_interface resources configured on the system. You can set a filter on any property of the resource.
pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_clag_interface ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_clag_interface resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/ns_clag_interface ?count=yes Use this query-parameter to get the count of ns_clag_interface resources.
HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_clag_interface":[{
"link_redundancy":<Boolean_value>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"host_type":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"clip":<String_value>,
"channel_alias":<String_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"channel_ha_monitoring":<Boolean_value>,
"channel_state":<String_value>,
"lacp_mode":<String_value>,
"lr_min_throughput":<Double_value>,
"has_foreign_interfaces":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/ns_clag_interface/id_value<String> HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_clag_interface":[{
"link_redundancy":<Boolean_value>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"host_type":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"clip":<String_value>,
"channel_alias":<String_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"channel_ha_monitoring":<Boolean_value>,
"channel_state":<String_value>,
"lacp_mode":<String_value>,
"lr_min_throughput":<Double_value>,
"has_foreign_interfaces":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/ns_clag_interface/id_value<String> HTTPS Method: PUT
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ns_clag_interface":{
<b>"id":<String_value></b>,
"clip":<String_value>,
"lr_min_throughput":<Double_value>,
"has_foreign_interfaces":<Boolean_value>,
"lacp_channel_time":<String_value>,
"sync_operation":<Boolean_value>,
"channel_interface_list":[{
"nodeid":<Integer_value>,
"parent_id":<String_value>,
"id":<String_value>,
"parent_name":<String_value>,
"interface_name":<String_value>,
"local_node":<Boolean_value>}],
"channel_tag_all_vlans":<Boolean_value>,
"mtu":<Integer_value>,
"link_redundancy":<Boolean_value>,
"channel_alias":<String_value>,
"channel_id":<String_value>,
"channel_ha_monitoring":<Boolean_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_clag_interface":[{
"link_redundancy":<Boolean_value>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"host_type":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"clip":<String_value>,
"channel_alias":<String_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"channel_ha_monitoring":<Boolean_value>,
"channel_state":<String_value>,
"lacp_mode":<String_value>,
"lr_min_throughput":<Double_value>,
"has_foreign_interfaces":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}