snmp_interface

Last published : Oct 30, 2026
Configuration for XenServer Interface resource.

Properties

(click to see Operations )
Name Data Type Permissions Description
inOctets <String> Read-write The total number of octets received on the interface.
outOctets <String> Read-write The total number of octets transmitted out of the interface.
outNUcastPkts <String> Read-write Number of braoadcast or multicast packets transmitted from this interface.
inDiscards <String> Read-write Number of discarded inbound packets.
speed <String> Read-write Interface's current bandwidth in bits per second.
mtu <Integer> Read-write Range for Base Mac Address.
outDiscards <String> Read-write Number of discarded outbound packets.
outErrors <String> Read-write Number of outbound packets that could not be transmitted because of errors.
descr <String> Read-write Interface Description.
Minimum length = 1
Maximum length = 50
inUnknownProtos <String> Read-write Number of packets recieved with unknown or unsupportedprotocol.
index <Integer> Read-write SNMP Index for interfaces and Channels.
Minimum value = 1
lastChange <Integer> Read-write Time when the interface entered its current operational state.
outUcastPkts <String> Read-write Number of unicast packets transmitted from this interface.
inNUcastPkts <String> Read-write Number of Broadcast and Multicast packets recieved on this interface.
outQLen <String> Read-write The length of the output packet queue (in packets).
type <Integer> Read-write The type of interface.
inUcastPkts <String> Read-write Number of Unicast packets recieved on this interface.
inErrors <String> Read-write Number of inbound packets that contained errors.
operStatus <Integer> Read-only The current operational state of the interface: up(1), down(2), testing(3), unknown(4), dormant(5), notPresent(6) or lowerLayerDown(7).
adminStatus <Integer> Read-only State of the Interface eg. up, down or testing.
ifSpecific <String> Read-only A reference to MIB definitions specific to the particular media being used to realize the interface.
physAddress <String> Read-only Physical Address of the interface.

Operations

(click to see Properties )
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