Skip to content

ns_clag_interface

Configuration for CLAG Interface resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
channel_id<String>Read-writeChannel ID if this interface represents a channel (CLA/1, CLA/2 ...).
Minimum length = 5
Maximum length = 5
channel_tag_all_vlans<Boolean>Read-writeIf true then all the member interfaces of this channel are tagged. Possible values: true and false.
channel_ha_monitoring<Boolean>Read-writeHA-monitoring control for the channel. Possible values: true and false.
lacp_channel_time<String>Read-writeLACP time. Possible values: long and short.
Minimum length = 4
Maximum length = 10
channel_interface_list<ns_clag_node[]>Read-writeArray of CLAG nodes that are part of this channel (10/1, 10/4).
clip<String>Read-writeCluster IPAddress.
Minimum length = 1
Maximum length = 64
channel_alias<String>Read-writeAlias name for this channel.
Minimum length = 4
Maximum length = 31
has_foreign_interfaces<Boolean>Read-writeIndicates whether CLAG has interfaces from remote SDX. Possible values: true and false.
id<String>Read-writeId is system generated key for CLAG.
mtu<Integer>Read-writeMTU value, should be between 1500-9216.
Minimum value = 1500
Maximum value =
sync_operation<Boolean>Read-writesync operation.
channel_state<String>Read-onlyIndicates CLA state. Possible values: UP and DOWN.
lacp_mode<String>Read-onlyLACP mode can be either ACTIVE, PASSIVE, DISABLED. Applicable for channel.
lacp_channel_mac_address<String>Read-onlyMac address of the bond on cluster.
channel_type<String>Read-onlyChannel type to represent the CLAG type.
act_id<String>Read-onlyActivity 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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/ns_clag_interface?onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_clag_interface: {
<b>"channel_id":<String_value></b>,
<b>"channel_interface_list":[{
"nodeid":<Integer_value>,
"parent_id":<String_value>,
"id":<String_value>,
"interface_name":<String_value>,
"local_node":<Boolean_value>,
"parent_name":<String_value>}]</b>,
<b>"clip":<String_value></b>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"channel_alias":<String_value>,
"id":<String_value>,
"mtu":<Integer_value>,
"channel_ha_monitoring":<Boolean_value>,
"sync_operation":<Boolean_value>,
"has_foreign_interfaces":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_clag_interface":[{
"channel_id":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"channel_ha_monitoring":<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>}],
"channel_state":<String_value>,
"lacp_mode":<String_value>,
"clip":<String_value>,
"channel_alias":<String_value>,
"has_foreign_interfaces":<Boolean_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/ns_clag_interface/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ns_clag_interface

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_clag_interface":[{
"channel_id":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"channel_ha_monitoring":<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>}],
"channel_state":<String_value>,
"lacp_mode":<String_value>,
"clip":<String_value>,
"channel_alias":<String_value>,
"has_foreign_interfaces":<Boolean_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ns_clag_interface/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_clag_interface":[{
"channel_id":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"channel_ha_monitoring":<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>}],
"channel_state":<String_value>,
"lacp_mode":<String_value>,
"clip":<String_value>,
"channel_alias":<String_value>,
"has_foreign_interfaces":<Boolean_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/ns_clag_interface/id_value<String>

HTTP Method: null

Request Payload:

{ns_clag_interface:{
<b>"id":<String_value></b>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"channel_interface_list":[{
"nodeid":<Integer_value>,
"parent_id":<String_value>,
"id":<String_value>,
"interface_name":<String_value>,
"local_node":<Boolean_value>,
"parent_name":<String_value>}],
"channel_alias":<String_value>,
"clip":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"channel_ha_monitoring":<Boolean_value>,
"sync_operation":<Boolean_value>,
"has_foreign_interfaces":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_clag_interface":[{
"channel_id":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"channel_ha_monitoring":<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>}],
"channel_state":<String_value>,
"lacp_mode":<String_value>,
"clip":<String_value>,
"channel_alias":<String_value>,
"has_foreign_interfaces":<Boolean_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}