com.citrix.netscaler.nitro.resource.config.network.channel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nitro Show documentation
Show all versions of nitro Show documentation
The Citrix® NetScaler® NITRO client for Java allows you to configure and monitor the NetScaler appliance programmatically in Java based applications. Source code taken from Build 121 of NetScaler release 10.1
The newest version!
/*
* Copyright (c) 2008-2015 Citrix Systems, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.citrix.netscaler.nitro.resource.config.network;
import com.citrix.netscaler.nitro.resource.base.*;
import com.citrix.netscaler.nitro.service.nitro_service;
import com.citrix.netscaler.nitro.service.options;
import com.citrix.netscaler.nitro.util.*;
import com.citrix.netscaler.nitro.exception.nitro_exception;
class channel_response extends base_response
{
public channel[] channel;
}
/**
* Configuration for channel resource.
*/
public class channel extends base_resource
{
private String id;
private String[] ifnum;
private String state;
private String mode;
private String conndistr;
private String macdistr;
private String lamac;
private String speed;
private String flowctl;
private String hamonitor;
private String tagall;
private String trunk;
private String ifalias;
private Long throughput;
private Long bandwidthhigh;
private Long bandwidthnormal;
private Long lrminthroughput;
//------- Read only Parameter ---------;
private String devicename;
private Long unit;
private String description;
private Long flags;
private Long mtu;
private Long vlan;
private String mac;
private Long uptime;
private Long downtime;
private String reqmedia;
private String reqspeed;
private String reqduplex;
private String reqflowcontrol;
private String media;
private String actspeed;
private String duplex;
private String actflowctl;
private String lamode;
private Long autoneg;
private Long autonegresult;
private Long tagged;
private Long taggedany;
private Long taggedautolearn;
private Long hangdetect;
private Long hangreset;
private Long linkstate;
private Long intfstate;
private Long rxpackets;
private Long rxbytes;
private Long rxerrors;
private Long rxdrops;
private Long txpackets;
private Long txbytes;
private Long txerrors;
private Long txdrops;
private Long indisc;
private Long outdisc;
private Long fctls;
private Long hangs;
private Long stsstalls;
private Long txstalls;
private Long rxstalls;
private Long bdgmuted;
private String vmac;
private String vmac6;
private Long reqthroughput;
private Long actthroughput;
private String backplane;
private Long cleartime;
private String lacpmode;
private String lacptimeout;
private Long lacpactorpriority;
private Long lacpactorportno;
private String lacppartnerstate;
private String lacppartnertimeout;
private String lacppartneraggregation;
private String lacppartnerinsync;
private String lacppartnercollecting;
private String lacppartnerdistributing;
private String lacppartnerdefaulted;
private String lacppartnerexpired;
private Long lacppartnerpriority;
private String lacppartnersystemmac;
private Long lacppartnersystempriority;
private Long lacppartnerportno;
private Long lacppartnerkey;
private String lacpactoraggregation;
private String lacpactorinsync;
private String lacpactorcollecting;
private String lacpactordistributing;
private String lacpportmuxstate;
private String lacpportrxstat;
private String lacpportselectstate;
private Long __count;
/**
*
* ID for the LA channel or cluster LA channel to be created. Specify an LA channel in LA/x notation or cluster LA channel in CLA/x notation, where x can range from 1 to 4. Cannot be changed after the LA channel is created.
*
*/
public void set_id(String id) throws Exception{
this.id = id;
}
/**
*
* ID for the LA channel or cluster LA channel to be created. Specify an LA channel in LA/x notation or cluster LA channel in CLA/x notation, where x can range from 1 to 4. Cannot be changed after the LA channel is created.
*
*/
public String get_id() throws Exception {
return this.id;
}
/**
*
* Interfaces to be bound to the LA channel of a NetScaler appliance or to the LA channel of a cluster configuration.
For an LA channel of a NetScaler appliance, 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.
*
*/
public void set_ifnum(String[] ifnum) throws Exception{
this.ifnum = ifnum;
}
/**
*
* Interfaces to be bound to the LA channel of a NetScaler appliance or to the LA channel of a cluster configuration.
For an LA channel of a NetScaler appliance, 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.
*
*/
public String[] get_ifnum() throws Exception {
return this.ifnum;
}
/**
*
* Enable or disable the LA channel.
Default value: ENABLED
Possible values = ENABLED, DISABLED
*
*/
public void set_state(String state) throws Exception{
this.state = state;
}
/**
*
* Enable or disable the LA channel.
Default value: ENABLED
Possible values = ENABLED, DISABLED
*
*/
public String get_state() throws Exception {
return this.state;
}
/**
*
* The initital mode for the LA channel.
Possible values = MANUAL, AUTO
*
*/
public void set_mode(String mode) throws Exception{
this.mode = mode;
}
/**
*
* The initital mode for the LA channel.
Possible values = MANUAL, AUTO
*
*/
public String get_mode() throws Exception {
return this.mode;
}
/**
*
* The 'connection' distribution mode for the LA channel.
Possible values = DISABLED, ENABLED
*
*/
public void set_conndistr(String conndistr) throws Exception{
this.conndistr = conndistr;
}
/**
*
* The 'connection' distribution mode for the LA channel.
Possible values = DISABLED, ENABLED
*
*/
public String get_conndistr() throws Exception {
return this.conndistr;
}
/**
*
* The 'MAC' distribution mode for the LA channel.
Possible values = SOURCE, DESTINATION, BOTH
*
*/
public void set_macdistr(String macdistr) throws Exception{
this.macdistr = macdistr;
}
/**
*
* The 'MAC' distribution mode for the LA channel.
Possible values = SOURCE, DESTINATION, BOTH
*
*/
public String get_macdistr() throws Exception {
return this.macdistr;
}
/**
*
* MAC address for LA channels on VPX Platforms namely VPX on SDX,Xen,ESX.
*
*/
public void set_lamac(String lamac) throws Exception{
this.lamac = lamac;
}
/**
*
* MAC address for LA channels on VPX Platforms namely VPX on SDX,Xen,ESX.
*
*/
public String get_lamac() throws Exception {
return this.lamac;
}
/**
*
* 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
*
*/
public void set_speed(String speed) throws Exception{
this.speed = speed;
}
/**
*
* 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
*
*/
public String get_speed() throws Exception {
return this.speed;
}
/**
*
* Flow control for the LA channel.
Default value: OFF
Possible values = OFF, RX, TX, RXTX
*
*/
public void set_flowctl(String flowctl) throws Exception{
this.flowctl = flowctl;
}
/**
*
* Flow control for the LA channel.
Default value: OFF
Possible values = OFF, RX, TX, RXTX
*
*/
public String get_flowctl() throws Exception {
return this.flowctl;
}
/**
*
* 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
*
*/
public void set_hamonitor(String hamonitor) throws Exception{
this.hamonitor = hamonitor;
}
/**
*
* 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
*
*/
public String get_hamonitor() throws Exception {
return this.hamonitor;
}
/**
*
* 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
*
*/
public void set_tagall(String tagall) throws Exception{
this.tagall = tagall;
}
/**
*
* 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
*
*/
public String get_tagall() throws Exception {
return this.tagall;
}
/**
*
* This is deprecated by tagall.
Default value: OFF
Possible values = ON, OFF
*
*/
public void set_trunk(String trunk) throws Exception{
this.trunk = trunk;
}
/**
*
* This is deprecated by tagall.
Default value: OFF
Possible values = ON, OFF
*
*/
public String get_trunk() throws Exception {
return this.trunk;
}
/**
*
* 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
*
*/
public void set_ifalias(String ifalias) throws Exception{
this.ifalias = ifalias;
}
/**
*
* 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
*
*/
public String get_ifalias() throws Exception {
return this.ifalias;
}
/**
*
* Low threshold value for the throughput of the LA channel, in Mbps. In an HA configuration, failover is triggered if the LA channel has HA MON enabled and the throughput is below the specified threshold.
Minimum value = 0
Maximum value = 80000
*
*/
public void set_throughput(long throughput) throws Exception {
this.throughput = new Long(throughput);
}
/**
*
* Low threshold value for the throughput of the LA channel, in Mbps. In an HA configuration, failover is triggered if the LA channel has HA MON enabled and the throughput is below the specified threshold.
Minimum value = 0
Maximum value = 80000
*
*/
public void set_throughput(Long throughput) throws Exception{
this.throughput = throughput;
}
/**
*
* Low threshold value for the throughput of the LA channel, in Mbps. In an HA configuration, failover is triggered if the LA channel has HA MON enabled and the throughput is below the specified threshold.
Minimum value = 0
Maximum value = 80000
*
*/
public Long get_throughput() throws Exception {
return this.throughput;
}
/**
*
* High threshold value for the bandwidth usage of the LA channel, in Mbps. The NetScaler appliance 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 = 80000
*
*/
public void set_bandwidthhigh(long bandwidthhigh) throws Exception {
this.bandwidthhigh = new Long(bandwidthhigh);
}
/**
*
* High threshold value for the bandwidth usage of the LA channel, in Mbps. The NetScaler appliance 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 = 80000
*
*/
public void set_bandwidthhigh(Long bandwidthhigh) throws Exception{
this.bandwidthhigh = bandwidthhigh;
}
/**
*
* High threshold value for the bandwidth usage of the LA channel, in Mbps. The NetScaler appliance 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 = 80000
*
*/
public Long get_bandwidthhigh() throws Exception {
return this.bandwidthhigh;
}
/**
*
* Normal threshold value for the bandwidth usage of the LA channel, in Mbps. When the bandwidth usage of the LA channel becomes less than or equal to the specified normal threshold after exceeding the high threshold, the NetScaler appliance generates an SNMP trap message to indicate that the bandwidth usage has returned to normal.
Minimum value = 0
Maximum value = 80000
*
*/
public void set_bandwidthnormal(long bandwidthnormal) throws Exception {
this.bandwidthnormal = new Long(bandwidthnormal);
}
/**
*
* Normal threshold value for the bandwidth usage of the LA channel, in Mbps. When the bandwidth usage of the LA channel becomes less than or equal to the specified normal threshold after exceeding the high threshold, the NetScaler appliance generates an SNMP trap message to indicate that the bandwidth usage has returned to normal.
Minimum value = 0
Maximum value = 80000
*
*/
public void set_bandwidthnormal(Long bandwidthnormal) throws Exception{
this.bandwidthnormal = bandwidthnormal;
}
/**
*
* Normal threshold value for the bandwidth usage of the LA channel, in Mbps. When the bandwidth usage of the LA channel becomes less than or equal to the specified normal threshold after exceeding the high threshold, the NetScaler appliance generates an SNMP trap message to indicate that the bandwidth usage has returned to normal.
Minimum value = 0
Maximum value = 80000
*
*/
public Long get_bandwidthnormal() throws Exception {
return this.bandwidthnormal;
}
/**
*
* Minimum required throughput for a channel where we require Link Redundancy. When throughput falls below the threshold, the subset of interfaces which can give maximum throughput will become active When configured in HA pair, this will work along with the throughput parameter set. If lrMinThroughput can be achieved Link Failover will be attempted before Node Failover.
Minimum value = 0
Maximum value = 80000
*
*/
public void set_lrminthroughput(long lrminthroughput) throws Exception {
this.lrminthroughput = new Long(lrminthroughput);
}
/**
*
* Minimum required throughput for a channel where we require Link Redundancy. When throughput falls below the threshold, the subset of interfaces which can give maximum throughput will become active When configured in HA pair, this will work along with the throughput parameter set. If lrMinThroughput can be achieved Link Failover will be attempted before Node Failover.
Minimum value = 0
Maximum value = 80000
*
*/
public void set_lrminthroughput(Long lrminthroughput) throws Exception{
this.lrminthroughput = lrminthroughput;
}
/**
*
* Minimum required throughput for a channel where we require Link Redundancy. When throughput falls below the threshold, the subset of interfaces which can give maximum throughput will become active When configured in HA pair, this will work along with the throughput parameter set. If lrMinThroughput can be achieved Link Failover will be attempted before Node Failover.
Minimum value = 0
Maximum value = 80000
*
*/
public Long get_lrminthroughput() throws Exception {
return this.lrminthroughput;
}
/**
*
* LA channel name in form LA/x, where x is channel ID, which ranges from 1 to 4.
*
*/
public String get_devicename() throws Exception {
return this.devicename;
}
/**
*
* Unit number of the channel. This is an internal reference number that the NetScaler uses to identify the channel.
*
*/
public Long get_unit() throws Exception {
return this.unit;
}
/**
*
* The IEEE standard that the channel is based on.
*
*/
public String get_description() throws Exception {
return this.description;
}
/**
*
* Flags of this channel.
*
*/
public Long get_flags() throws Exception {
return this.flags;
}
/**
*
* MTU of the channel. This is the maximum frame size that the channel can process.
*
*/
public Long get_mtu() throws Exception {
return this.mtu;
}
/**
*
* Native VLAN of the channel.
*
*/
public Long get_vlan() throws Exception {
return this.vlan;
}
/**
*
* MAC address of the channel.
*
*/
public String get_mac() throws Exception {
return this.mac;
}
/**
*
* 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.
*
*/
public Long get_uptime() throws Exception {
return this.uptime;
}
/**
*
* 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.
*
*/
public Long get_downtime() throws Exception {
return this.downtime;
}
/**
*
* 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
*
*/
public String get_reqmedia() throws Exception {
return this.reqmedia;
}
/**
*
* 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
*
*/
public String get_reqspeed() throws Exception {
return this.reqspeed;
}
/**
*
* Requested duplex setting for this channel. Since no media are associated with LA, the displayed values carry no significance.
Possible values = AUTO, HALF, FULL
*
*/
public String get_reqduplex() throws Exception {
return this.reqduplex;
}
/**
*
* 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
*
*/
public String get_reqflowcontrol() throws Exception {
return this.reqflowcontrol;
}
/**
*
* Requested media setting for this interface.
Possible values = AUTO, UTP, FIBER
*
*/
public String get_media() throws Exception {
return this.media;
}
/**
*
* Actual speed setting for this channel.
Possible values = AUTO, 10, 100, 1000, 10000
*
*/
public String get_actspeed() throws Exception {
return this.actspeed;
}
/**
*
* Actualduplex setting for this interface.
Possible values = AUTO, HALF, FULL
*
*/
public String get_duplex() throws Exception {
return this.duplex;
}
/**
*
* Actual flow control setting for this channel.
Possible values = OFF, RX, TX, RXTX
*
*/
public String get_actflowctl() throws Exception {
return this.actflowctl;
}
/**
*
* The mode(AUTO/MANNUAL) for the LA channel.
Possible values = MANUAL, AUTO
*
*/
public String get_lamode() throws Exception {
return this.lamode;
}
/**
*
* Requested auto negotiation setting for this channel. Since no media are associated with LA, this setting has no effect.
*
*/
public Long get_autoneg() throws Exception {
return this.autoneg;
}
/**
*
* Actual auto negotiation setting for this channel.
*
*/
public Long get_autonegresult() throws Exception {
return this.autonegresult;
}
/**
*
* VLAN tags setting on this channel.
*
*/
public Long get_tagged() throws Exception {
return this.tagged;
}
/**
*
* Channel setting to accept/drop all tagged packets.
*
*/
public Long get_taggedany() throws Exception {
return this.taggedany;
}
/**
*
* Dynaminc vlan membership on this channel.
*
*/
public Long get_taggedautolearn() throws Exception {
return this.taggedautolearn;
}
/**
*
* Hang detect for this channel.
*
*/
public Long get_hangdetect() throws Exception {
return this.hangdetect;
}
/**
*
* Hang reset for this channel.
*
*/
public Long get_hangreset() throws Exception {
return this.hangreset;
}
/**
*
* 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.
*
*/
public Long get_linkstate() throws Exception {
return this.linkstate;
}
/**
*
* Current state of the specified interface. The interface state set to UP only if the link state is UP and administrative state is ENABLED.
*
*/
public Long get_intfstate() throws Exception {
return this.intfstate;
}
/**
*
* Number of bytes received by all the slave interfaces of the channel since the NetScaler appliance was started or the interface statistics were cleared.
*
*/
public Long get_rxpackets() throws Exception {
return this.rxpackets;
}
/**
*
* Number of packets received by all member interfaces since the NetScaler appliance was started or the interface statistics were cleared.
*
*/
public Long get_rxbytes() throws Exception {
return this.rxbytes;
}
/**
*
* Number of inbound packets dropped by the hardware of the slave interfaces since the NetScaler appliance was started or the interface statistics were cleared. Possible causes of dropped packets are CRC, length (undersize or oversize), and alignment errors.
*
*/
public Long get_rxerrors() throws Exception {
return this.rxerrors;
}
/**
*
* 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 NetScaler 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.
*
*/
public Long get_rxdrops() throws Exception {
return this.rxdrops;
}
/**
*
* Number of packets transmitted by slave interfaces of a channel since the NetScaler appliance was started or the interface statistics were cleared.
*
*/
public Long get_txpackets() throws Exception {
return this.txpackets;
}
/**
*
* Number of bytes transmitted by slave interfaces of a channel since the NetScaler appliance was started or the interface statistics were cleared.
*
*/
public Long get_txbytes() throws Exception {
return this.txbytes;
}
/**
*
* Number of outbound packets dropped by the hardware of a channel's slave interfaces since the NetScaler appliance was started or the interface statistics were cleared. Possible causes of dropped packets are length (undersize or oversize) errors and lack of resources.
*
*/
public Long get_txerrors() throws Exception {
return this.txerrors;
}
/**
*
* 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.
*
*/
public Long get_txdrops() throws Exception {
return this.txdrops;
}
/**
*
* Number of error-free inbound packets discarded by a channel's slave interfaces because of a lack of resources (for example, insufficient receive buffers).
*
*/
public Long get_indisc() throws Exception {
return this.indisc;
}
/**
*
* 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 NetScaler MPX 12500/12500/15500-10G platforms.
(2) 10G data ports on NetScaler MPX 17500/19500/21500 platforms.
*
*/
public Long get_outdisc() throws Exception {
return this.outdisc;
}
/**
*
* Number of times flow control is performed on a channel's slave interfaces because of pause frames.
*
*/
public Long get_fctls() throws Exception {
return this.fctls;
}
/**
*
* Number of hangs that occurred on the channel's slave interfaces.
*
*/
public Long get_hangs() throws Exception {
return this.hangs;
}
/**
*
* Number of status stalls that occurred on the channel's slave interfaces.
*
*/
public Long get_stsstalls() throws Exception {
return this.stsstalls;
}
/**
*
* Number of Tx stalls happened that occurred on the channel's slave interfaces.
*
*/
public Long get_txstalls() throws Exception {
return this.txstalls;
}
/**
*
* Number of Rx stalls that occurred on the channel's slave interfaces.
*
*/
public Long get_rxstalls() throws Exception {
return this.rxstalls;
}
/**
*
* Number of times a channel's slave interfaces stopped transmitting and receiving packets because of MAC moves between ports.
*
*/
public Long get_bdgmuted() throws Exception {
return this.bdgmuted;
}
/**
*
* Virtual MAC of this channel.
*
*/
public String get_vmac() throws Exception {
return this.vmac;
}
/**
*
* Virtual MAC for IPv6 on this interface.
*
*/
public String get_vmac6() throws Exception {
return this.vmac6;
}
/**
*
* 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 = 80000
*
*/
public Long get_reqthroughput() throws Exception {
return this.reqthroughput;
}
/**
*
* Actual throughput for the interface.
*
*/
public Long get_actthroughput() throws Exception {
return this.actthroughput;
}
/**
*
* 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
*
*/
public String get_backplane() throws Exception {
return this.backplane;
}
/**
*
* Time since the interface stats are cleared last time.
*
*/
public Long get_cleartime() throws Exception {
return this.cleartime;
}
/**
*
* 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
*
*/
public String get_lacpmode() throws Exception {
return this.lacpmode;
}
/**
*
* Time to wait for the LACPDU. If a LACPDU is not received within this interval, the NetScaler 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
*
*/
public String get_lacptimeout() throws Exception {
return this.lacptimeout;
}
/**
*
* 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.
*
*/
public Long get_lacpactorpriority() throws Exception {
return this.lacpactorpriority;
}
/**
*
* LACP Actor port number. LACP uses the port priority with the port number to form the port identifier.
*
*/
public Long get_lacpactorportno() throws Exception {
return this.lacpactorportno;
}
/**
*
* LACP Partner State. Whether the port is in Active or Passive negotiating state.
Possible values = MANUAL, AUTO
*
*/
public String get_lacppartnerstate() throws Exception {
return this.lacppartnerstate;
}
/**
*
* 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
*
*/
public String get_lacppartnertimeout() throws Exception {
return this.lacppartnertimeout;
}
/**
*
* 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
*
*/
public String get_lacppartneraggregation() throws Exception {
return this.lacppartneraggregation;
}
/**
*
* 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
*
*/
public String get_lacppartnerinsync() throws Exception {
return this.lacppartnerinsync;
}
/**
*
* 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
*
*/
public String get_lacppartnercollecting() throws Exception {
return this.lacppartnercollecting;
}
/**
*
* 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
*
*/
public String get_lacppartnerdistributing() throws Exception {
return this.lacppartnerdistributing;
}
/**
*
* If the timer expires in the Expired state, the Receive Machine enters the Defaulted state.
Possible values = NS_EMPTY_STR, DEFAULTED
*
*/
public String get_lacppartnerdefaulted() throws Exception {
return this.lacppartnerdefaulted;
}
/**
*
* 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
*
*/
public String get_lacppartnerexpired() throws Exception {
return this.lacppartnerexpired;
}
/**
*
* 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.
*
*/
public Long get_lacppartnerpriority() throws Exception {
return this.lacppartnerpriority;
}
/**
*
* LACP Partner System MAC.
*
*/
public String get_lacppartnersystemmac() throws Exception {
return this.lacppartnersystemmac;
}
/**
*
* 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.
*
*/
public Long get_lacppartnersystempriority() throws Exception {
return this.lacppartnersystempriority;
}
/**
*
* LACP Partner Port number. LACP uses the port priority with the port number to form the port identifier.
*
*/
public Long get_lacppartnerportno() throws Exception {
return this.lacppartnerportno;
}
/**
*
* LACP Partner Key. The LACP key used by the partner port.
*
*/
public Long get_lacppartnerkey() throws Exception {
return this.lacppartnerkey;
}
/**
*
* 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
*
*/
public String get_lacpactoraggregation() throws Exception {
return this.lacpactoraggregation;
}
/**
*
* 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
*
*/
public String get_lacpactorinsync() throws Exception {
return this.lacpactorinsync;
}
/**
*
* 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
*
*/
public String get_lacpactorcollecting() throws Exception {
return this.lacpactorcollecting;
}
/**
*
* 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
*
*/
public String get_lacpactordistributing() throws Exception {
return this.lacpactordistributing;
}
/**
*
* 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
*
*/
public String get_lacpportmuxstate() throws Exception {
return this.lacpportmuxstate;
}
/**
*
* 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
*
*/
public String get_lacpportrxstat() throws Exception {
return this.lacpportrxstat;
}
/**
*
* LACP Port SELECT state. The state of the SELECT state machine, It could be SELECTED or UNSELECTED.
Possible values = UNSELECTED, SELECTED, STANDBY
*
*/
public String get_lacpportselectstate() throws Exception {
return this.lacpportselectstate;
}
/**
*
* converts nitro response into object and returns the object array in case of get request.
*
*/
protected base_resource[] get_nitro_response(nitro_service service, String response) throws Exception{
channel_response result = (channel_response) service.get_payload_formatter().string_to_resource(channel_response.class, response);
if(result.errorcode != 0) {
if (result.errorcode == 444) {
service.clear_session();
}
if(result.severity != null)
{
if (result.severity.equals("ERROR"))
throw new nitro_exception(result.message,result.errorcode);
}
else
{
throw new nitro_exception(result.message,result.errorcode);
}
}
return result.channel;
}
/**
*
* Returns the value of object identifier argument
*
*/
protected String get_object_name() {
return this.id;
}
/**
* Use this API to add channel.
*/
public static base_response add(nitro_service client, channel resource) throws Exception {
channel addresource = new channel();
addresource.id = resource.id;
addresource.ifnum = resource.ifnum;
addresource.state = resource.state;
addresource.mode = resource.mode;
addresource.conndistr = resource.conndistr;
addresource.macdistr = resource.macdistr;
addresource.lamac = resource.lamac;
addresource.speed = resource.speed;
addresource.flowctl = resource.flowctl;
addresource.hamonitor = resource.hamonitor;
addresource.tagall = resource.tagall;
addresource.trunk = resource.trunk;
addresource.ifalias = resource.ifalias;
addresource.throughput = resource.throughput;
addresource.bandwidthhigh = resource.bandwidthhigh;
addresource.bandwidthnormal = resource.bandwidthnormal;
return addresource.add_resource(client);
}
/**
* Use this API to add channel resources.
*/
public static base_responses add(nitro_service client, channel resources[]) throws Exception {
base_responses result = null;
if (resources != null && resources.length > 0) {
channel addresources[] = new channel[resources.length];
for (int i=0;i 0) {
channel deleteresources[] = new channel[id.length];
for (int i=0;i 0) {
channel deleteresources[] = new channel[resources.length];
for (int i=0;i 0) {
channel updateresources[] = new channel[resources.length];
for (int i=0;i 0) {
channel unsetresources[] = new channel[id.length];
for (int i=0;i 0) {
channel unsetresources[] = new channel[resources.length];
for (int i=0;i0) {
channel response[] = new channel[id.length];
channel obj[] = new channel[id.length];
for (int i=0;i