Because VRAgent is a subclass of SNMPAgent, the attributes of a VRAgent are the same as the attributes of an SNMPAgent with the following exception: the VRAgent has an additional attribute called RouterID.

Attributes for Management agent lists some key attributes for management agent.

Table 1. Attributes for Management agent

Attribute

Description

Allowed values

AgentAddress

IP address used by the initial ICMP or ICMPv6 poll to contact this management agent; for example:

10.9.1.108

or

3FFE:80C0:22C:92:0:0:0:1

String

AgentAddressList

List of IP addresses discovered on the system hosting this management agent.

Note:

The IP address set for the AgentAddress attribute is always the first entry in this list.

String

AuthPass

SNMPv3 only: Authentication password of the user for the SNMP engine of this management agent.

String

AuthProtocol

SNMPv3 only: Protocol used to authenticate the SNMP request sent to this management agent.

Enum:

  • MD5

  • SHA

  • NONE (default)

DisplayName

Name, as shown in the Global Console, of this management agent; for example:

SNMPAgent-asm-swwas0

String

EngineBoots

SNMPv3 only: Number of times that the SNMP engine of this management agent has initialized or reinitialized since its last configuration.

Integer

EngineBootTime

SNMPv3 only: Date and time that the SNMP engine of this management agent last initialized or reinitialized.

String

EngineID

SNMPv3 only: Identifier that uniquely identifies the SNMP engine of this management agent; for example:

800002b804616263

String

IsSystemUnresponsive

TRUE if the system hosting this management agent is not responding to ICMP and ICMPv6 pings or SNMP polls.

(FALSE if the host system is responding to ICMP and ICMPv6 pings and/or SNMP polls.)

Boolean:

TRUE, FALSE

Name

Name, as known in the modeled topology, of this management agent; for example:

SNMPAgent-asm-swwas0

String

PortNumber

Port number used by the first SNMP poll to successfully communicate with this management agent.

Integer: 161 by default

PrivPass

SNMPv3 only: Encryption password of the user for the SNMP engine of this management agent.

String

PrivProtocol

SNMPv3 only: Protocol used to encrypt SNMP request sent to this management agent.

Enum:

  • DES

  • AES

  • NONE (default)

ProbeSuccessful

TRUE if this management agent was successfully probed by the discovery probes.

Boolean:

TRUE, FALSE

ReadCommunity

SNMPv1 or v2c only: SNMP read community string used by the first SNMP poll to successfully communicate with this management agent.

String: public by default

RouterID

Applicable to VRAgent only: Identifier (index) for this VRAgent.

Integer

SeedName

Original name specified for the system hosting this management agent; for example:

asm-swwas0

The seed name is typically the name listed in a seed file.

String

SNMPStatus

Current state of this management agent as reported by the instrumentation:

  • OK indicates that the agent is responding to SNMP requests.

  • AUTHFAILURE indicates an authentication failure to an SNMP request.

  • TIMEDOUT indicates that the agent is not responding to SNMP requests but that the host system is responding to ICMP and ICMPv6 pings.

  • UNREACHABLE indicates that the host system is not responding to ICMP and ICMPv6 pings.

  • OTHER indicates that an unspecified failure occurred.

  • UNKNOWN indicates that the agent has yet to be polled.

Enum:

  • OK

  • AUTHFAILURE

  • TIMEDOUT

  • UNREACHABLE

  • OTHER

  • UNKNOWN

SNMPVersion

SNMP protocol version used by the first SNMP poll to successfully communicate with this management agent:

  • V1 indicates that SNMPv1 was used by the first SNMP poll to successfully communicate with the agent.

  • V2C indicates that SNMPv2c was used by the first SNMP poll to successfully communicate with the agent.

  • V3 indicates that SNMPv3 was used by the first SNMP poll to successfully communicate with the agent.

    Note:

    The SNMPVersion attribute value is set to "unknown_SNMP_version" for a management agent that does not support any of the SNMP protocol versions.

Enum:

  • V1

  • V2C

  • V3

Status

Current status of this management agent.

Enum:

  • RESPONSIVE

  • UNRESPONSIVE

  • UNKNOWN

SupportsSNMP

TRUE if this management agent was contacted successfully at least once using the SNMP protocol.

Boolean:

TRUE, FALSE

sysDescr

Description of the system hosting this management agent; for example:

Ethernet Stackable Switching System

String

sysLocation

Description of where the system hosting this management agent is located; for example:

QARack2_ASM_setup

String

sysName

Administratively assigned name for the system hosting this management agent; for example:

asm-swwas0

By convention, this name is the host’s fully qualified domain name (FQDN).

String

sysObjectID

System object identifier associated with the vendor of the system hosting this management agent; example:

.1.3.6.1.4.1.674.10895.3002

String

SystemName

Name of the system hosting this management agent; for example:

asm-swwas0

String

TopologyUpdateInfo

Table of topology information discovered through this management agent.

struct[]

User

SNMPv3 only: Name of the user included in the SNMP request sent to this management agent.

String

WriteCommunity

SNMPv1 or v2c only: SNMP write community string for this management agent.

String