NetScaler SDX 14.1 NITRO API Reference

channel

March 20, 2024

Contributed by:

Configuration for Channels on the system resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
channel_tag_all_vlans		Read-write	If true then all the member interfaces of this channel are tagged. Possible values: true and false.
lacp_channel_time		Read-write	LACP time. Possible values: SHORT and LONG. Minimum length = 4 Maximum length = 10
channel_interface_list	<String[]>	Read-write	Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4). Maximum length = 256
channel_alias		Read-write	Alias name for this channel. Minimum length = 4 Maximum length = 31
channel_type		Read-write	Channel type if this interface represents a channel (LACP or Static). Minimum length = 4 Maximum length = 16
mtu		Read-write	MTU value, should be between 1500-9126.
channel_id		Read-write	Channel ID if this interface represents a channel (LA/1, LA/2 …). Minimum length = 4 Maximum length = 5
static_channel_state		Read-write	Static channel state (Enabled/Disabled).
channel_ha_monitoring		Read-write	HA-monitoring control for the channel. Possible values: true and false.
sync_operation		Read-write	sync operation.
channel_throughput		Read-write	Minimum required throughput in Mbps for this channel. Maximum value =
channel_bandwidth_normal		Read-write	Lower end threshold of the channel bandwidth usage in Mbps. Maximum value =
channel_bandwidth_high		Read-write	Higher end threshold of the channel bandwidth usage in Mbps. Maximum value =
state		Read-only	State of the port..

Operations

(click to see Properties )

ADD
DELETE
GET (ALL)
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/channel?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"channel": {
<b>"channel_interface_list":<String_value[]></b>,
<b>"channel_type":<String_value></b>,
<b>"channel_id":<String_value></b>,
<b>"static_channel_state":<Boolean_value></b>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"channel_alias":<String_value>,
"mtu":<Integer_value>,
"channel_ha_monitoring":<Boolean_value>,
"sync_operation":<Boolean_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_high":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>}}

<!--NeedCopy-->

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, "channel":[{
"channel_tag_all_vlans":<Boolean_value>,
"state":<String_value>,
"lacp_channel_time":<String_value>,
"host_type":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"host_ip_address":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"sync_operation":<Boolean_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>,
"channel_bandwidth_high":<Integer_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/channel?action=delete;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"channel": {
<b>"channel_id":<String_value></b>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"channel_interface_list":<String_value[]>,
"channel_alias":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_ha_monitoring":<Boolean_value>,
"static_channel_state":<Boolean_value>,
"sync_operation":<Boolean_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_high":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "channel":[{
"channel_tag_all_vlans":<Boolean_value>,
"state":<String_value>,
"lacp_channel_time":<String_value>,
"host_type":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"host_ip_address":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"sync_operation":<Boolean_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>,
"channel_bandwidth_high":<Integer_value>}]}

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/channel Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/channel ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of channel 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/channel ?pagesize=#no;pageno=#no Use this query-parameter to get the channel resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/channel ?count=yes Use this query-parameter to get the count of channel resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "channel":[{
"channel_tag_all_vlans":<Boolean_value>,
"state":<String_value>,
"lacp_channel_time":<String_value>,
"host_type":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"host_ip_address":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"sync_operation":<Boolean_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>,
"channel_bandwidth_high":<Integer_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/channel/ HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"channel":{
<b>"channel_id":<String_value></b>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"channel_interface_list":<String_value[]>,
"channel_alias":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_ha_monitoring":<Boolean_value>,
"static_channel_state":<Boolean_value>,
"sync_operation":<Boolean_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_high":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "channel":[{
"channel_tag_all_vlans":<Boolean_value>,
"state":<String_value>,
"lacp_channel_time":<String_value>,
"host_type":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"host_ip_address":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"sync_operation":<Boolean_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>,
"channel_bandwidth_high":<Integer_value>}]}

<!--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

March 20, 2024

Contributed by:

March 20, 2024

Contributed by:

channel

Properties

Operations

add

delete

get (all)

update

In this article