Developer Documentation
NetScaler SDX 13.1 NITRO API Reference

snmp_interface

March 20, 2024
Contributed by: 
C

Configuration for XenServer Interface resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
inOctets Read-write The total number of octets received on the interface.
outOctets Read-write The total number of octets transmitted out of the interface.
outNUcastPkts Read-write Number of braoadcast or multicast packets transmitted from this interface.
inDiscards Read-write Number of discarded inbound packets.
speed Read-write Interface’s current bandwidth in bits per second.
mtu Read-write Range for Base Mac Address.
outDiscards Read-write Number of discarded outbound packets.
outErrors Read-write Number of outbound packets that could not be transmitted because of errors.
descr Read-write Interface Description.

Minimum length = 1

Maximum length = 50
inUnknownProtos Read-write Number of packets recieved with unknown or unsupportedprotocol.
index Read-write SNMP Index for interfaces and Channels.

Minimum value = 1
lastChange Read-write Time when the interface entered its current operational state.
outUcastPkts Read-write Number of unicast packets transmitted from this interface.
inNUcastPkts Read-write Number of Broadcast and Multicast packets recieved on this interface.
outQLen Read-write The length of the output packet queue (in packets).
type Read-write The type of interface.
inUcastPkts Read-write Number of Unicast packets recieved on this interface.
inErrors Read-write Number of inbound packets that contained errors.
operStatus 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 Read-only State of the Interface eg. up, down or testing.
ifSpecific Read-only A reference to MIB definitions specific to the particular media being used to realize the interface.
physAddress 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

    snmp_interface
    March 20, 2024
    Contributed by: 
    C
    March 20, 2024
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.