Michael Vincent
and 1 contributors

NAME

Cisco::SNMP::Entity - Entity Interface for Cisco Management

SYNOPSIS

  use Cisco::SNMP::Entity;

DESCRIPTION

The following methods implement the Entity MIB defined in ENTITY-MIB.

METHODS

new() - create a new Cisco::SNMP::Entity object

  my $cm = Cisco::SNMP::Entity->new([OPTIONS]);

Create a new Cisco::SNMP::Entity object with OPTIONS as optional parameters. See Cisco::SNMP for options.

entityOIDs() - return OID names

  my @entityOIDs = $cm->entityOIDs();

Return list of Entity MIB object ID names.

entity_info() - return entity info

  my $entity = $cm->entity_info();

Populate a data structure with entity information. If successful, returns a pointer to an array containing entity information.

  $entity->[0]->{'Descr', 'VendorType', ...}
  $entity->[1]->{'Descr', 'VendorType', ...}
  ...
  $entity->[n]->{'Descr', 'VendorType', ...}

Allows the following accessors to be called.

entityDescr - return entity description

  $entity->entityDescr([#]);

Return the description of the entity at index '#'. Defaults to 0.

entityVendorType - return entity vendor type

  $entity->entityVendorType([#]);

Return the vendor type of the entity at index '#'. Defaults to 0.

entityContainedIn - return entity ContainedIn

  $entity->entityContainedIn([#]);

Return the ContainedIn of the entity at index '#'. Defaults to 0.

entityClass - return entity class

  $entity->entityClass([#]);

Return the class of the entity at index '#'. Defaults to 0.

entityParentRelPos - return entity ParentRelPos

  $entity->entityParentRelPos([#]);

Return the ParentRelPos of the entity at index '#'. Defaults to 0.

entityName - return entity name

  $entity->entityName([#]);

Return the name of the entity at index '#'. Defaults to 0.

entityHardwareRev - return entity hardware revision

  $entity->entityHardwareRev([#]);

Return the hardware revision of the entity at index '#'. Defaults to 0.

entityFirmwareRev - return entity firmware revision

  $entity->entityFirmwareRev([#]);

Return the firmware revision of the entity at index '#'. Defaults to 0.

entitySoftwareRev - return entity software revision

  $entity->entitySoftwareRev([#]);

Return the software revision of the entity at index '#'. Defaults to 0.

entitySerialNum - return entity serial number

  $entity->entitySerialNum([#]);

Return the serial number of the entity at index '#'. Defaults to 0.

entityMfgName - return entity manufacturer name

  $entity->entityMfgName([#]);

Return the manufacturer name of the entity at index '#'. Defaults to 0.

entityModelName - return entity model name

  $entity->entityModelName([#]);

Return the model name of the entity at index '#'. Defaults to 0.

entityAlias - return entity alias

  $entity->entityAlias([#]);

Return the alias of the entity at index '#'. Defaults to 0.

entityAssetID - return entity asset ID

  $entity->entityAssetID([#]);

Return the asset ID of the entity at index '#'. Defaults to 0.

entityIsFRU - return entity IsFRU

  $entity->entityIsFRU([#]);

Return the IsFRU of the entity at index '#'. Defaults to 0.

DIRECT ACCESS METHODS

The following methods can be called on the Cisco::SNMP::Entity object directly to access the values directly.

get_entityDescr (#)
get_entityVendorType (#)
get_entityContainedIn (#)
get_entityClass (#)
get_entityParentRelPos (#)
get_entityName (#)
get_entityHardwareRev (#)
get_entityFirmwareRev (#)
get_entitySoftwareRev (#)
get_entitySerialNum (#)
get_entityMfgName (#)
get_entityModelName (#)
get_entityAlias (#)
get_entityAssetID (#)
get_entityIsFRU (#)

Get Entity OIDs where (#) is the OID instance, not the index from entity_info. If (#) not provided, uses 0.

INHERITED METHODS

The following are inherited methods. See Cisco::SNMP for more information.

close
error
session

EXPORT

None by default.

EXAMPLES

This distribution comes with several scripts (installed to the default bin install directory) that not only demonstrate example uses but also provide functional execution.

LICENSE

This software is released under the same terms as Perl itself. If you don't know what that means visit http://perl.com/.

AUTHOR

Copyright (C) Michael Vincent 2015

http://www.VinsWorld.com

All rights reserved