Property Name |
Type |
Display Name (ENU) |
Description (ENU) |
Key |
Max Length |
Min Length |
Case Sensitive |
System.Entity: |
DisplayName |
string |
Display Name |
Display name of monitoring object. |
false | 256 |
0 |
False |
ComTrade.Citrix.NetScaler.Appliance.Component.Base: |
HostID |
string |
MPNS Key |
The NetScaler Management Pack key value. It is combination of host id, serial number and NetScaler IP address. |
false | 256 |
0 |
False |
IPAddress |
string |
Device IP Address |
The NetScaler Device IP Address. |
false | 256 |
0 |
False |
DeviceKey |
string |
Device Key |
The key property of the device node in System Center Operations Manager. |
true | 256 |
0 |
False |
ComTrade.Citrix.NetScaler.Appliance.Component.Network.Interface: |
autoneg |
string |
Auto Negotiation |
The state of auto negotiation for the specified interface. Possible values are Enabled or Disabled. If auto negotiation is enabled on an interface then that interface tries to auto negotiate the speed and duplex settings with the link partner. If Speed or Duplex are set by the user other then AUTO, than auto negotiation of that parameter does not happen. |
false | 256 |
0 |
False |
autonegresult |
string |
Auto Negotiation Result |
Actual auto negotiation setting for this interface. |
false | 256 |
0 |
False |
bandwidthhigh |
string |
Bandwidth High |
Configured high threshold of the interface bandwidth usage in Mbits/s. Trap will be sent if bandwidth usage of the interface crosses this limit. |
false | 256 |
0 |
False |
bandwidthnormal |
string |
Bandwidth Normal |
Configured normal threshold of the interface bandwidth usage in Mbits/s. Trap will be sent if bandwidth usage of the interface comes back to this limit. |
false | 256 |
0 |
False |
conndistr |
string |
Connection Distribution |
Connection distribution setting on this interface. |
false | 256 |
0 |
False |
description |
string |
Description |
Gives the information about the device: the type of interface, on which speeds this interface can operate and type of SFP, if applicable. |
false | 256 |
0 |
False |
devicename |
string |
Device Name |
Name of the interface. |
false | 256 |
0 |
False |
duplex |
string |
Duplex |
The requested duplex mode for the interface. Possible values are: 1. AUTO: Default setting. Indicates that the NetScaler will attempt to auto-negotiate the duplex mode of the interface when it is brought up. 2. HALF 3. FULL For settings other than AUTO, duplex and speed settings should be kept identical at both ends of the link for the it to be up. |
false | 256 |
0 |
False |
flags |
string |
Flags |
Flags for this interface. This is used for communicating the device states. |
false | 256 |
0 |
False |
flowctl |
string |
Flow Control |
The requested 802. 3x flow control setting for the interface. Possible values are OFF (the default), RX, TX, RXTX, and ON (\"forced RXTX\"). The 802.3x specification does not define flow control for 10 Mbps and 100 Mbps speeds, but if a Gigabit Ethernet interface operates at those speeds, the flow control settings can be applied. The flow control setting that is finally applied to an interface depends on auto-negotiation. With the ON option, auto-negotiation gives the peer the opportunity to negotiate the flow control, but the appliance then forces two-way flow control for the interface. Any other link-parameter mismatches can sometimes cause problems and should be avoided by thoroughly checking the settings. Default value: OFF Possible values = OFF, RX, TX, RXTX. |
false | 256 |
0 |
False |
hamonitor |
string |
HA Monitor |
Triggers a failover when the interface on which it is enabled goes down. By default, this option is enabled on all interfaces. It is recommended that this option be disabled on all unused interfaces and other non-critical ones. |
false | 256 |
0 |
False |
hangdetect |
string |
Hang Detection |
Hang detection enabled or disabled for this interface. |
false | 256 |
0 |
False |
hangreset |
string |
Hang Reset |
Hang reset enabled or disabled for this interface. |
false | 256 |
0 |
False |
id |
string |
ID |
The interface number in the a/b format. 'a' can take one of the following values: 1. '0': Indicates a management interface. 2. '1': Indicates a 10/100/1000 Mbps ports and 10G ports of NetScaler 12000-10G and NetScaler MPX 15000 and 17000 platforms. 3. '10': Indicates a 10 Gbps port. 4. 'LA': Indicates a link aggregation port. 5. 'LO': Indicates a loop back port. 'b' is an integer that is used to provide a unique label for the interfaces in the groups defined by 'a'. |
true | 256 |
0 |
False |
ifalias |
string |
Alias Name |
The alias name for the interface. |
false | 256 |
0 |
False |
lacpkey |
string |
LACP Key |
Identifies the LA channel to which the interface is bound. The possible values are 1, 2, 3, and 4. |
false | 256 |
0 |
False |
lacpmode |
string |
Enable LACP |
The LACP mode of the specified interface. The possible values are: 1. Active: A port in active mode will generate LACP protocol messages on a regular basis, regardless of any need expressed by its partner to hear them. 2. Passive: A port in passive mode will generally not transmit LACP messages unless its partner is in the active mode; that is, it will 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. |
false | 256 |
0 |
False |
lacppriority |
string |
LACP Priority |
LACP port priority expressed as an integer ranging from 1 to 65535. The highest priority is 1. The NetScaler limits the number of interfaces in an LA channel to 8. If LACP is enabled on more than 8 interfaces, NetScaler selects 8 interfaces, in descending order of port priority, to form a channel. |
false | 256 |
0 |
False |
lacptimeout |
string |
LACP Timeout |
Time to wait for the LACPDU. If a LACPDU is not received within this interval, the NetScaler marks the link partner port as DOWN. Possible values are Long and Short. Long LACP timeout is 90 sec and Short LACP timeout is 3 sec. |
false | 256 |
0 |
False |
mac |
string |
MAC |
MAC address for this interface. |
false | 256 |
0 |
False |
macdistr |
string |
MAC Distribution |
MAC distribution setting on this interface. |
false | 256 |
0 |
False |
mode |
string |
Mode |
Interface Link Aggregation mode(Auto/Manual) setting. |
false | 256 |
0 |
False |
mtu |
string |
MTU |
MTU for this interface. It shows the maximum size of frame which can be delivered by this interface. |
false | 256 |
0 |
False |
reqduplex |
string |
Requested Duplex |
Requested duplex setting for this interface. |
false | 256 |
0 |
False |
reqflowcontrol |
string |
Requested Flow Control |
Requested flow control setting for this interface. |
false | 256 |
0 |
False |
reqmedia |
string |
Requested Media |
Requested media setting for this interface. |
false | 256 |
0 |
False |
reqspeed |
string |
Requested Speed |
Requested speed setting for this interface. |
false | 256 |
0 |
False |
reqthroughput |
string |
Requested Throughput |
Minimum required throughput for an interface. If the interface is a logical interface (LA) and HAMON is ON on that interface then if the operating throughput of that interface falls below this value, failover is triggered. |
false | 256 |
0 |
False |
speed |
string |
Speed |
The requested Ethernet speed of the interface. Possible values are: 1. AUTO: Default value. Indicates that the NetScaler will attempt to auto-negotiate or auto-sense the line speed of the interface when it is brought up. 2. 10, 100, 1000, and 10000: 10 Mbps, 100 Mbps, 1 Gbps, and 10 Gbps respectively. Setting a speed other than AUTO requires the device at the other end of the link to be configured identically. Mismatched speed and duplex settings will lead to link errors, packet loss, etc. Some interfaces do not support certain speeds. When an unsupported speed is set, an error is displayed. |
false | 256 |
0 |
False |
tagall |
string |
Tag All |
The option to select whether this port is a trunk port or not for the interface. By default, this is set to OFF for all interfaces. When ON, the traffic will be tagged for all VLANs bound to this interface. If one wants 802.1q behavior with backward compatibility the OFF setting for this variable. |
false | 256 |
0 |
False |
tagged |
string |
Tagged |
VLAN tags setting on this channel. |
false | 256 |
0 |
False |
taggedany |
string |
Tagged Any |
Interface setting to accept/drop all tagged packets. |
false | 256 |
0 |
False |
taggedautolearn |
string |
Tagged Auto Learn |
Dynamic VLAN membership auto learning enabled or disabled on this interface. |
false | 256 |
0 |
False |
throughput |
string |
Throughput |
Minimum required throughput for an interface. If the interface is a logical interface (LA) and HAMON is ON on that interface then if the operating throughput of that interface falls below this value, failover is triggered. |
false | 256 |
0 |
False |
trunk |
string |
Trunk |
This argument is deprecated by tag all. |
false | 256 |
0 |
False |
unit |
string |
Unit |
Unit number for this interface; it shows the sequence number in which this interface is discovered on this NetScaler. |
false | 256 |
0 |
False |
vlan |
string |
VLAN |
Native VLAN for this interface. |
false | 256 |
0 |
False |
vmac |
string |
VMAC |
Virtual MAC of this interface. |
false | 256 |
0 |
False |
vmac6 |
string |
VMAC6 |
Virtual MAC for IPv6 of this interface. |
false | 256 |
0 |
False |
ComTrade.Citrix.NetScaler.Appliance.10.Component.Network.Interface: |
slavestate |
string |
Slave State |
State of the member interfaces. |
false | 256 |
0 |
False |
slavespeed |
string |
Slave Speed |
Speed of the member interfaces. |
false | 256 |
0 |
False |
slavemedia |
string |
Slave Media |
Media type of the member interfaces. |
false | 256 |
0 |
False |
slaveflowctl |
string |
Slave Flow Control |
Flow control of the member interfaces. |
false | 256 |
0 |
False |
slaveduplex |
string |
Slave Duplex |
Duplex of the member interfaces. |
false | 256 |
0 |
False |
lagtype |
string |
LAG Type |
LAG Type (Node/Cluster). |
false | 256 |
0 |
False |
intftype |
string |
Interface Type |
Interface Type, this field will have the interface type either it is virtual, physical or loopback. |
false | 256 |
0 |
False |
ifnum |
string |
LA Master |
Contains the LA Master, if the interface is part of LA channel. |
false | 256 |
0 |
False |
backplane |
string |
Backplane |
The cluster backplane status of the interface. |
false | 256 |
0 |
False |
actthroughput |
string |
Actual Throughput |
Actual throughput for the interface. |
false | 256 |
0 |
False |
actspeed |
string |
Actual Speed |
Actual speed setting for this interface. |
false | 256 |
0 |
False |
actmedia |
string |
Actual Media |
Actual media setting for this interface. |
false | 256 |
0 |
False |
actflowctl |
string |
Actual Flow Control |
Actual flow control setting for this interface. |
false | 256 |
0 |
False |
actduplex |
string |
Actual Duplex |
Actual duplex setting for this interface. |
false | 256 |
0 |
False |