ADC NITRO APIs

channel

August 17, 2023

Contributed by:

Configuration for channel resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
id	<String>	Read-write	ID for the LA channel or cluster LA channel or LR channel to be created. Specify an LA channel in LA/x notation, where x can range from 1 to 8 or cluster LA channel in CLA/x notation or Link redundant channel in LR/x notation, where x can range from 1 to 4. Cannot be changed after the LA channel is created.
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.
state	<String>	Read-write	Enable or disable the LA channel. Default value: ENABLED Possible values = ENABLED, DISABLED
mode	<String>	Read-write	The initital mode for the LA channel. Possible values = MANUAL, AUTO
conndistr	<String>	Read-write	The 'connection' distribution mode for the LA channel. Possible values = DISABLED, ENABLED
macdistr	<String>	Read-write	The 'MAC' distribution mode for the LA channel. Possible values = SOURCE, DESTINATION, BOTH
lamac	<String>	Read-write	Specifies a MAC address for the LA channels configured in Citrix ADC virtual appliances (VPX). This MAC address is persistent after each reboot. If you don't specify this parameter, a MAC address is generated randomly for each LA channel. These MAC addresses change after each reboot.
speed	<String>	Read-write	Ethernet speed of the channel, in Mbps. If the speed of any bound interface is greater than or equal to the value set for this parameter, the state of the interface is UP. Otherwise, the state is INACTIVE. Bound Interfaces whose state is INACTIVE do not process any traffic. Default value: AUTO Possible values = AUTO, 10, 100, 1000, 10000, 25000, 40000, 50000, 100000
flowctl	<String>	Read-write	Specifies the flow control type for this LA channel to manage the flow of frames. Flow control is a function as mentioned in clause 31 of the IEEE 802.3 standard. Flow control allows congested ports to pause traffic from the peer device. Flow control is achieved by sending PAUSE frames. Default value: OFF Possible values = OFF, RX, TX, RXTX, ON
hamonitor	<String>	Read-write	In a High Availability (HA) configuration, monitor the LA channel for failure events. Failure of any LA channel that has HA MON enabled triggers HA failover. Default value: ON Possible values = ON, OFF
haheartbeat	<String>	Read-write	In a High Availability (HA) configuration, configure the LA channel for sending heartbeats. LA channel that has HA Heartbeat disabled should not send the heartbeats. Default value: ON Possible values = OFF, ON
tagall	<String>	Read-write	Adds a four-byte 802.1q tag to every packet sent on this channel. The ON setting applies tags for all VLANs that are bound to this channel. OFF applies the tag for all VLANs other than the native VLAN. Default value: OFF Possible values = ON, OFF
trunk	<String>	Read-write	This is deprecated by tagall. Default value: OFF Possible values = ON, OFF
ifalias	<String>	Read-write	Alias name for the LA channel. Used only to enhance readability. To perform any operations, you have to specify the LA channel ID. Default value: " " Maximum length = 31
throughput	<Double>	Read-write	Low threshold value for the throughput of the LA channel, in Mbps. In an high availability (HA) configuration, failover is triggered when the LA channel has HA MON enabled and the throughput is below the specified threshold. Minimum value = 0 Maximum value = 160000
bandwidthhigh	<Double>	Read-write	High threshold value for the bandwidth usage of the LA channel, in Mbps. The Citrix ADC generates an SNMP trap message when the bandwidth usage of the LA channel is greater than or equal to the specified high threshold value. Minimum value = 0 Maximum value = 160000
bandwidthnormal	<Double>	Read-write	Normal threshold value for the bandwidth usage of the LA channel, in Mbps. When the bandwidth usage of the LA channel returns to less than or equal to the specified normal threshold after exceeding the high threshold, the Citrix ADC generates an SNMP trap message to indicate that the bandwidth usage has returned to normal. Minimum value = 0 Maximum value = 160000
mtu	<Double>	Read-write	The maximum transmission unit (MTU) is the largest packet size, measured in bytes excluding 14 bytes ethernet header and 4 bytes crc, that can be transmitted and received by this interface. Default value of MTU is 1500 on all the interface of Citrix ADC any value configured more than 1500 on the interface will make the interface as jumbo enabled. In case of cluster backplane interface MTU value will be changed to 1514 by default, user has to change the backplane interface value to maximum mtu configured on any of the interface in cluster system plus 14 bytes more for backplane interface if Jumbo is enabled on any of the interface in a cluster system. Changing the backplane will bring back the MTU of backplane interface to default value of 1500. If a channel is configured as backplane then the same holds true for channel as well as member interfaces. Default value: 1500 Minimum value = 1500 Maximum value = 9216
lrminthroughput	<Double>	Read-write	Specifies the minimum throughput threshold (in Mbps) to be met by the active subchannel. Setting this parameter automatically divides an LACP channel into logical subchannels, with one subchannel active and the others in standby mode. When the maximum supported throughput of the active channel falls below the lrMinThroughput value, link failover occurs and a standby subchannel becomes active. Minimum value = 0 Maximum value = 80000
linkredundancy	<String>	Read-write	Link Redundancy for Cluster LAG. Default value: OFF Possible values = ON, OFF
devicename	<String>	Read-only	LA channel name in form LA/x, where x is channel ID, which ranges from 1 to 8 or LR channel name in form LR/x, where x is channel ID, which ranges from 1 to 4.
unit	<Double>	Read-only	Unit number of the channel. This is an internal reference number that the Citrix ADC uses to identify the channel.
description	<String>	Read-only	The IEEE standard that the channel is based on.
flags	<Double>	Read-only	Flags of this channel.
actualmtu	<Double>	Read-only	MTU of the channel. This is the maximum frame size that the channel can process.
vlan	<Double>	Read-only	Native VLAN of the channel.
mac	<String>	Read-only	MAC address of the channel.
uptime	<Double>	Read-only	Duration for which the channel is UP. (Example: 3 hours 1 minute 1 second). This value is reset when the channel state changes to DOWN.
downtime	<Double>	Read-only	Duration for which the channel is DOWN. (Example: 3 hours 1 minute 1 second). This value is reset when the channel state changes to UP.
reqmedia	<String>	Read-only	Requested media setting for this channel. Since there is no media associated with LA, the displayed values carry no significance. Possible values = AUTO, UTP, FIBER
reqspeed	<String>	Read-only	Requested speed setting for this channel. Since no media are associated with LA, this speed is used to determine the threshold for the slave interfaces. If the speed of the member interface is less than the requested speed, that interface is considered inactive. Possible values = AUTO, 10, 100, 1000, 10000, 25000, 40000, 50000, 100000
reqduplex	<String>	Read-only	Requested duplex setting for this channel. Since no media are associated with LA, the displayed values carry no significance. Possible values = AUTO, HALF, FULL
reqflowcontrol	<String>	Read-only	Requested flow control setting for this channel. Since no media are associated with LA, the displayed values carry no significance. Possible values = OFF, RX, TX, RXTX, ON
media	<String>	Read-only	Requested media setting for this interface. Possible values = AUTO, UTP, FIBER
actspeed	<String>	Read-only	Actual speed setting for this channel. Possible values = AUTO, 10, 100, 1000, 10000, 25000, 40000, 50000, 100000
duplex	<String>	Read-only	Actualduplex setting for this interface. Possible values = AUTO, HALF, FULL
actflowctl	<String>	Read-only	Actual flow control setting for this channel. Possible values = OFF, RX, TX, RXTX, ON
lamode	<String>	Read-only	The mode(AUTO/MANNUAL) for the LA channel. Possible values = MANUAL, AUTO
autoneg	<Double>	Read-only	Requested auto negotiation setting for this channel. Since no media are associated with LA, this setting has no effect.
autonegresult	<Double>	Read-only	Actual auto negotiation setting for this channel.
tagged	<Double>	Read-only	VLAN tags setting on this channel.
taggedany	<Double>	Read-only	Channel setting to accept/drop all tagged packets.
taggedautolearn	<Double>	Read-only	Dynaminc vlan membership on this channel.
hangdetect	<Double>	Read-only	Hang detect for this channel.
hangreset	<Double>	Read-only	Hang reset for this channel.
linkstate	<Double>	Read-only	The current state of the link associated with the interface. For logical interfaces (LA), the state of the link is dependent on the state of the slave interfaces. For the link to be UP at least one of the slave interfaces needs to be UP.
intfstate	<Double>	Read-only	Current state of the specified interface. The interface state set to UP only if the link state is UP and administrative state is ENABLED.
rxpackets	<Double>	Read-only	Number of bytes received by all the slave interfaces of the channel since the Citrix ADC was started or the interface statistics were cleared.
rxbytes	<Double>	Read-only	Number of packets received by all member interfaces since the Citrix ADC was started or the interface statistics were cleared.
rxerrors	<Double>	Read-only	Number of inbound packets dropped by the hardware of the slave interfaces since the Citrix ADC was started or the interface statistics were cleared. Possible causes of dropped packets are CRC, length (undersize or oversize), and alignment errors.
rxdrops	<Double>	Read-only	Number of inbound packets dropped by the channel's slave interfaces. Commonly dropped packets are multicast frames, spanning tree BPDUs, packets destined to a MAC not owned by the Citrix ADC when L2 mode is disabled, or packets tagged for a VLAN that is not bound to the interface. In most healthy networks, this statistic increments at a steady rate regardless of traffic load. A sharp spike in dropped packets generally indicates an issue with connected L2 switches, such as a forwarding database overflow resulting in packets being broadcast on all ports.
txpackets	<Double>	Read-only	Number of packets transmitted by slave interfaces of a channel since the Citrix ADC was started or the interface statistics were cleared.
txbytes	<Double>	Read-only	Number of bytes transmitted by slave interfaces of a channel since the Citrix ADC was started or the interface statistics were cleared.
txerrors	<Double>	Read-only	Number of outbound packets dropped by the hardware of a channel's slave interfaces since the Citrix ADC was started or the interface statistics were cleared. Possible causes of dropped packets are length (undersize or oversize) errors and lack of resources.
txdrops	<Double>	Read-only	Number of packets dropped in transmission by a channel's slave interfaces for one of the following reasons: (1) VLAN mismatch. (2) Oversized packets. (3) Interface congestion. (4) Loopback packets sent on non-loopback interface.
indisc	<Double>	Read-only	Number of error-free inbound packets discarded by a channel's slave interfaces because of a lack of resources (for example, insufficient receive buffers).
outdisc	<Double>	Read-only	Number of error-free outbound packets discarded by a channel's slave interfaces because of a lack of resources. This statistic is not available on: (1) 10G ports of Citrix ADC MPX 12500/12500/15500-10G platforms. (2) 10G data ports on Citrix ADC MPX 17500/19500/21500 platforms.
fctls	<Double>	Read-only	Number of times flow control is performed on a channel's slave interfaces because of pause frames.
hangs	<Double>	Read-only	Number of hangs that occurred on the channel's slave interfaces.
stsstalls	<Double>	Read-only	Number of status stalls that occurred on the channel's slave interfaces.
txstalls	<Double>	Read-only	Number of Tx stalls happened that occurred on the channel's slave interfaces.
rxstalls	<Double>	Read-only	Number of Rx stalls that occurred on the channel's slave interfaces.
bdgmuted	<Double>	Read-only	Number of times a channel's slave interfaces stopped transmitting and receiving packets because of MAC moves between ports.
vmac	<String>	Read-only	Virtual MAC of this channel.
vmac6	<String>	Read-only	Virtual MAC for IPv6 on this interface.
reqthroughput	<Double>	Read-only	Minimum required throughput for an interface. Failover is triggered if the operating throughput of a Link Aggregation (LA) channel for which HAMON is ON falls below this value. Minimum value = 0 Maximum value = 160000
actthroughput	<Double>	Read-only	Actual throughput for the interface.
backplane	<String>	Read-only	The cluster backplane status of the LA. If the status is enabled, the LA is part of the cluster backplane. By default, the backplane status is disabled. Possible values = ENABLED, DISABLED
cleartime	<Double>	Read-only	Time since the interface stats are cleared last time.
lacpmode	<String>	Read-only	The LACP mode of the specified interface. The possible values are: 1. Active: A port in active mode generates LACP protocol messages on a regular basis, regardless of any need expressed by its partner to receive them. 2. Passive: A port in passive mode generally does not transmit LACP messages unless its partner is in the active mode; that is, it does not speak unless spoken to. 3. Disabled: Removes the interface from the LA channel. If this is only interface in the LA channel, the LA channel is also deleted. . Possible values = DISABLED, ACTIVE, PASSIVE
lacptimeout	<String>	Read-only	Time to wait for the LACPDU. If a LACPDU is not received within this interval, the Citrix ADC markes the link partner port as DOWN. Possible values: Long and Short. Long lacptimeout is 90 sec and Short LACP timeout is 3 sec. Possible values = LONG, SHORT
lacpactorpriority	<Double>	Read-only	LACP Actor Priority. A LACP port priority is configured on each port using LACP. LACP uses the port priority with the port number to form the port identifier. The port priority determines which ports should be put in standby mode when there is a hardware limitation that prevents all compatible ports from aggregating.
lacpactorportno	<Double>	Read-only	LACP Actor port number. LACP uses the port priority with the port number to form the port identifier.
lacppartnerstate	<String>	Read-only	LACP Partner State. Whether the port is in Active or Passive negotiating state. Possible values = MANUAL, AUTO
lacppartnertimeout	<String>	Read-only	The timeout value for the information revieved in LACPDUs. It can have values as SHORT or LONG. The SHORT timeout is 3s and the LONG timeout is 90s. Possible values = LONG, SHORT
lacppartneraggregation	<String>	Read-only	The Aggregation flag indicates that the participant will allow the link to be used as part of an aggregate. Otherwise the link is to be used as an individual link, i.e. not aggregated with any other. Possible values = NS_EMPTY_STR, AGG
lacppartnerinsync	<String>	Read-only	The Synchronization flag indicates that the transmitting participant.s mux component is in sync with the system id and key information transmitted. Possible values = NS_EMPTY_STR, SYNC
lacppartnercollecting	<String>	Read-only	The Collecting flag indicates that the participant.s collector, i.e. the reception component of the mux, is definitely on. If set the flag communicates collecting. Possible values = NS_EMPTY_STR, COLLECTING
lacppartnerdistributing	<String>	Read-only	The Distributing flag indicates that the participant.s distributor is not definitely off. If reset the flag indicates not distributing. Possible values = NS_EMPTY_STR, DISTRIBUTING
lacppartnerdefaulted	<String>	Read-only	If the timer expires in the Expired state, the Receive Machine enters the Defaulted state. Possible values = NS_EMPTY_STR, DEFAULTED
lacppartnerexpired	<String>	Read-only	If the LACPDUs are received for timeout period, the Receive Machine enters the Expired state and the timer is restarted with the timeout value of SHORT timeout. Possible values = NS_EMPTY_STR, EXPIRED
lacppartnerpriority	<Double>	Read-only	LACP Partner Priority. A LACP port priority is configured on each port using LACP. LACP uses the port priority with the port number to form the port identifier. The port priority determines which ports should be put in standby mode when there is a hardware limitation that prevents all compatible ports from aggregating.
lacppartnersystemmac	<String>	Read-only	LACP Partner System MAC.
lacppartnersystempriority	<Double>	Read-only	LACP Partner System Priority. The LACP partner's system priority. The values for the priority range from 0 to 65535. The lower the value, the higher the system priority. The switch with the lower system priority value determines which links between LACP partner are active and which are in the standby for each LACP Channel.
lacppartnerportno	<Double>	Read-only	LACP Partner Port number. LACP uses the port priority with the port number to form the port identifier.
lacppartnerkey	<Double>	Read-only	LACP Partner Key. The LACP key used by the partner port.
lacpactoraggregation	<String>	Read-only	The Aggregation flag indicates that the participant will allow the link to be used as part of an aggregate. Otherwise the link is to be used as an individual link, i.e. not aggregated with any other. Possible values = NS_EMPTY_STR, AGG
lacpactorinsync	<String>	Read-only	The Synchronization flag indicates that the transmitting participant.s mux component is in sync with the system id and key information transmitted. Possible values = NS_EMPTY_STR, SYNC
lacpactorcollecting	<String>	Read-only	The Collecting flag indicates that the participant.s collector, i.e. the reception component of the mux, is definitely on. If set the flag communicates collecting. Possible values = NS_EMPTY_STR, COLLECTING
lacpactordistributing	<String>	Read-only	The Distributing flag indicates that the participant.s distributor is not definitely off. If reset the flag indicates not distributing. Possible values = NS_EMPTY_STR, DISTRIBUTING
lacpportmuxstate	<String>	Read-only	LACP Port MUX state. The state of the MUX control machine. The Mux Control Machine attaches the physical port to an aggregate port, using the Selection Logic to choose an appropriate port, and turns the distributor and collector for the physical port on or off as required by protocol information. Possible values = DETACHED, WAITING, ATTACHED, COLLECTING, DISTRIBUTING
lacpportrxstat	<String>	Read-only	LACP Port RX state. The state of the Receive machine. The Receive Machine maintains partner information, recording protocol information from LACPDUs sent by remote partner(s). Received information is subject to a timeout, and if sufficient time elapses the receive machine will revert to using default partner information. Possible values = INIT, PORT_DISABLED, LACP_DISABLED, EXPIRED, DEFAULTED, CURRENT
lacpportselectstate	<String>	Read-only	LACP Port SELECT state. The state of the SELECT state machine, It could be SELECTED or UNSELECTED. Possible values = UNSELECTED, SELECTED, STANDBY
lldpmode	<String>	Read-only	Link Layer Discovery Protocol (LLDP) mode for an interface. The resultant LLDP mode of an interface depends on the LLDP mode configured at the global and the interface levels. Possible values = NONE, TRANSMITTER, RECEIVER, TRANSCEIVER
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
UPDATE
UNSET
GET (ALL)
GET
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/channel

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"channel":{
<b>      "id":<String_value>,
</b>      "ifnum":<String[]_value>,
      "state":<String_value>,
      "mode":<String_value>,
      "conndistr":<String_value>,
      "macdistr":<String_value>,
      "lamac":<String_value>,
      "speed":<String_value>,
      "flowctl":<String_value>,
      "hamonitor":<String_value>,
      "haheartbeat":<String_value>,
      "tagall":<String_value>,
      "trunk":<String_value>,
      "ifalias":<String_value>,
      "throughput":<Double_value>,
      "bandwidthhigh":<Double_value>,
      "bandwidthnormal":<Double_value>
}}

<!--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/channel/ id_value<String>

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"channel":{
<b>      "id":<String_value>,
</b>      "state":<String_value>,
      "mode":<String_value>,
      "conndistr":<String_value>,
      "macdistr":<String_value>,
      "lamac":<String_value>,
      "speed":<String_value>,
      "mtu":<Double_value>,
      "flowctl":<String_value>,
      "hamonitor":<String_value>,
      "haheartbeat":<String_value>,
      "tagall":<String_value>,
      "trunk":<String_value>,
      "ifalias":<String_value>,
      "throughput":<Double_value>,
      "lrminthroughput":<Double_value>,
      "linkredundancy":<String_value>,
      "bandwidthhigh":<Double_value>,
      "bandwidthnormal":<Double_value>
}}

<!--NeedCopy-->

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/channel? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"channel":{
<b>      "id":<String_value>,
</b>      "state":true,
      "mode":true,
      "conndistr":true,
      "macdistr":true,
      "speed":true,
      "mtu":true,
      "flowctl":true,
      "hamonitor":true,
      "haheartbeat":true,
      "tagall":true,
      "trunk":true,
      "ifalias":true,
      "throughput":true,
      "lrminthroughput":true,
      "linkredundancy":true,
      "bandwidthhigh":true,
      "bandwidthnormal":true
}}

<!--NeedCopy-->

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 (all)

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

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/channel? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/channel? filter=property-name1:property-val1,property-name2:property-val2

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

view

http:// <netscaler-ip-address> /nitro/v1/config/channel? view=summary

Use this query-parameter to get the summary output of channel resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

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

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

{ "channel": [ {
      "id":<String_value>,
      "devicename":<String_value>,
      "unit":<Double_value>,
      "description":<String_value>,
      "flags":<Double_value>,
      "mtu":<Double_value>,
      "actualmtu":<Double_value>,
      "vlan":<Double_value>,
      "mac":<String_value>,
      "lamac":<String_value>,
      "uptime":<Double_value>,
      "downtime":<Double_value>,
      "reqmedia":<String_value>,
      "reqspeed":<String_value>,
      "reqduplex":<String_value>,
      "reqflowcontrol":<String_value>,
      "media":<String_value>,
      "actspeed":<String_value>,
      "duplex":<String_value>,
      "actflowctl":<String_value>,
      "mode":<String_value>,
      "lamode":<String_value>,
      "hamonitor":<String_value>,
      "haheartbeat":<String_value>,
      "state":<String_value>,
      "autoneg":<Double_value>,
      "autonegresult":<Double_value>,
      "tagged":<Double_value>,
      "tagall":<String_value>,
      "trunk":<String_value>,
      "taggedany":<Double_value>,
      "taggedautolearn":<Double_value>,
      "hangdetect":<Double_value>,
      "hangreset":<Double_value>,
      "linkstate":<Double_value>,
      "intfstate":<Double_value>,
      "rxpackets":<Double_value>,
      "rxbytes":<Double_value>,
      "rxerrors":<Double_value>,
      "rxdrops":<Double_value>,
      "txpackets":<Double_value>,
      "txbytes":<Double_value>,
      "txerrors":<Double_value>,
      "txdrops":<Double_value>,
      "indisc":<Double_value>,
      "outdisc":<Double_value>,
      "fctls":<Double_value>,
      "hangs":<Double_value>,
      "stsstalls":<Double_value>,
      "txstalls":<Double_value>,
      "rxstalls":<Double_value>,
      "bdgmuted":<Double_value>,
      "vmac":<String_value>,
      "vmac6":<String_value>,
      "ifalias":<String_value>,
      "reqthroughput":<Double_value>,
      "lrminthroughput":<Double_value>,
      "linkredundancy":<String_value>,
      "actthroughput":<Double_value>,
      "bandwidthhigh":<Double_value>,
      "bandwidthnormal":<Double_value>,
      "ifnum":<String[]_value>,
      "backplane":<String_value>,
      "cleartime":<Double_value>,
      "lacpmode":<String_value>,
      "lacptimeout":<String_value>,
      "lacpactorpriority":<Double_value>,
      "lacpactorportno":<Double_value>,
      "lacppartnerstate":<String_value>,
      "lacppartnertimeout":<String_value>,
      "lacppartneraggregation":<String_value>,
      "lacppartnerinsync":<String_value>,
      "lacppartnercollecting":<String_value>,
      "lacppartnerdistributing":<String_value>,
      "lacppartnerdefaulted":<String_value>,
      "lacppartnerexpired":<String_value>,
      "lacppartnerpriority":<Double_value>,
      "lacppartnersystemmac":<String_value>,
      "lacppartnersystempriority":<Double_value>,
      "lacppartnerportno":<Double_value>,
      "lacppartnerkey":<Double_value>,
      "lacpactoraggregation":<String_value>,
      "lacpactorinsync":<String_value>,
      "lacpactorcollecting":<String_value>,
      "lacpactordistributing":<String_value>,
      "lacpportmuxstate":<String_value>,
      "lacpportrxstat":<String_value>,
      "lacpportselectstate":<String_value>,
      "lldpmode":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/channel/ id_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/channel/ id_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/channel/ id_value<String> ? view=summary

Use this query-parameter to get the summary output of channel resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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:

{  "channel": [ {
      "id":<String_value>,
      "devicename":<String_value>,
      "unit":<Double_value>,
      "description":<String_value>,
      "flags":<Double_value>,
      "mtu":<Double_value>,
      "actualmtu":<Double_value>,
      "vlan":<Double_value>,
      "mac":<String_value>,
      "lamac":<String_value>,
      "uptime":<Double_value>,
      "downtime":<Double_value>,
      "reqmedia":<String_value>,
      "reqspeed":<String_value>,
      "reqduplex":<String_value>,
      "reqflowcontrol":<String_value>,
      "media":<String_value>,
      "actspeed":<String_value>,
      "duplex":<String_value>,
      "actflowctl":<String_value>,
      "mode":<String_value>,
      "lamode":<String_value>,
      "hamonitor":<String_value>,
      "haheartbeat":<String_value>,
      "state":<String_value>,
      "autoneg":<Double_value>,
      "autonegresult":<Double_value>,
      "tagged":<Double_value>,
      "tagall":<String_value>,
      "trunk":<String_value>,
      "taggedany":<Double_value>,
      "taggedautolearn":<Double_value>,
      "hangdetect":<Double_value>,
      "hangreset":<Double_value>,
      "linkstate":<Double_value>,
      "intfstate":<Double_value>,
      "rxpackets":<Double_value>,
      "rxbytes":<Double_value>,
      "rxerrors":<Double_value>,
      "rxdrops":<Double_value>,
      "txpackets":<Double_value>,
      "txbytes":<Double_value>,
      "txerrors":<Double_value>,
      "txdrops":<Double_value>,
      "indisc":<Double_value>,
      "outdisc":<Double_value>,
      "fctls":<Double_value>,
      "hangs":<Double_value>,
      "stsstalls":<Double_value>,
      "txstalls":<Double_value>,
      "rxstalls":<Double_value>,
      "bdgmuted":<Double_value>,
      "vmac":<String_value>,
      "vmac6":<String_value>,
      "ifalias":<String_value>,
      "reqthroughput":<Double_value>,
      "lrminthroughput":<Double_value>,
      "linkredundancy":<String_value>,
      "actthroughput":<Double_value>,
      "bandwidthhigh":<Double_value>,
      "bandwidthnormal":<Double_value>,
      "ifnum":<String[]_value>,
      "backplane":<String_value>,
      "cleartime":<Double_value>,
      "lacpmode":<String_value>,
      "lacptimeout":<String_value>,
      "lacpactorpriority":<Double_value>,
      "lacpactorportno":<Double_value>,
      "lacppartnerstate":<String_value>,
      "lacppartnertimeout":<String_value>,
      "lacppartneraggregation":<String_value>,
      "lacppartnerinsync":<String_value>,
      "lacppartnercollecting":<String_value>,
      "lacppartnerdistributing":<String_value>,
      "lacppartnerdefaulted":<String_value>,
      "lacppartnerexpired":<String_value>,
      "lacppartnerpriority":<Double_value>,
      "lacppartnersystemmac":<String_value>,
      "lacppartnersystempriority":<Double_value>,
      "lacppartnerportno":<Double_value>,
      "lacppartnerkey":<Double_value>,
      "lacpactoraggregation":<String_value>,
      "lacpactorinsync":<String_value>,
      "lacpactorcollecting":<String_value>,
      "lacpactordistributing":<String_value>,
      "lacpportmuxstate":<String_value>,
      "lacpportrxstat":<String_value>,
      "lacpportselectstate":<String_value>,
      "lldpmode":<String_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

channel

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

channel

Properties

Operations

add

delete

update

unset

get (all)

get

count

In this article