Appendix D: Map and Device Details

Name

Specifies a unique name of the map.

Label

Specifies label of the map as displayed in the tree and also on the display panel (internal frame). Edit this field to change the name of the map as displayed in the tree and then click Modify to effect change.

TreeIconFileName

Specifies the image name and location of the icon representing the map in the tree. Edit this field to specify any other icon image from <Web NMS Home>/images directory and then click Modify to effect the change.

ImageName

Specifies the image name and location of the background image for that map. If nothing is specified in this field, a blank white background is set to the map. Edit this field to provide the background image from <Web NMS Home>/image directory and then click Modify to effect the change.

MapLinkRenderer

Specifies the Map Link Renderer that renders the links in the map.

MapSymbolRenderer

Specifies the Map Symbol Renderer that renders the symbols in the map.

CurrentTopology

Specifies the topology property which has to be set as the default topology.

Anchored

If this field is selected (click Modify for change to take effect), the user will not be able to edit that map anymore.

AutoPlacement

When set true, the map layout is set with the CurrentTopology.

HelpDoc

Specifies the URL for the help documentation to be displayed when the Help button is clicked in the Map Properties dialog. Edit this field to provide a new URL and then click Modify to effect the change.

MenuName

Specifies the map-specific menu file (XML) name. This menu is shown in the menu bar when the map is selected or as a pop-up when you right-click the map.

Save changes to server

If you want to effect the changes you have made to the fields in Map Properties dialog, select this option. On selecting this, all the clients connected incorporate the change you have made.

If this option is not selected, then the changes you make are reflected only in the client you are working on.

Name

Specifies the unique name of the link.

Label

Specifies the label for the link. On entering a label name, the same is depicted next to the link on the map. If you do not want a label, leave the field empty. On editing this field, click Modify to effect the change.

Tip: If you want this change to be reflected in all the clients connected, save changes to server.

ObjName

Specifies the name of the object that the link represents.

Source

Specifies the map symbol name from where the link starts.

Destination

Specifies the destination map symbol with which the link is established.

MapName

Specifies  the map name in which the link is located.

MenuName

Specifies the menu name in which link-related tasks are available.

ObjType

Specifies the type of the object.

LinkType

Specifies the type of the link (can be used to paint the link).

Community

Specifies the community string of the agent associated with the link.

Status

Specifies the current status of the link in that network.

Managed

Specifies whether that link is in managed or unmanaged state.

INITIAL_MIBS

Specifies the initial MIB associated with that link.

Thickness

Specifies the current thickness of the link as displayed in the map. By default the thickness is '3'. Enter the value (1 or more than 1) and click Modify to effect the change.

Tip: If you want this change to reflect in all the connected clients, save changes to server.

OwnerName

Specifies the owner to whom the link is associated.

IconName

Specifies the image and its location representing the link in the map. Edit this to provide new image for the link from <Web NMS Home>/images directory and click Modify to effect the change.

Tip: If you want this change to reflect in all the connected clients, save changes to server.

Y

Specifies the X coordinate value where the link is positioned.

X

Specifies the Y coordinate value where the link is positioned.

GroupName

Specifies the group name to which the link belongs. 'null' is displayed if the link does not belong to any group.

ParentName

Specifies the name of the parent tree node

Save changes to server

If you want to effect the changes you have made to the fields in link Object Properties dialog, select this option. On selecting this, all the clients connected incorporates the change you have made.

If this option is not selected, then the changes you make is be reflected only in the client you are working on.

Name

Specifies the unique name of the map symbol.

Label

Specifies the label for the map symbol. Edit this field to change the label of the map symbol and then click Modify for change to take effect.

Tip: If you want this change to be reflected in all the clients connected, Save changes to server.

ObjName

Specifies the object name of the selected symbol.

MapName

Specifies the map name in which the map symbol is located.

IconName

Specifies the image and its location representing the map symbol. Edit this to provide new image for the map symbol from <Web NMS Home>/images directory and click Modify to effect the change.

Tip: If you want this change to reflect in all the connected clients, save changes to server.

MenuName

Specifies the menu name in which the map symbol-related tasks are available.

ParentName

Specifies the parent name of the selected symbol.

GroupName

Specifies the group name to which the map symbol belongs. 'null' is displayed if the link does not belong to any group.

Community

Specifies the community string of the agent associated with that map symbol.

Status

Specifies the current status of the map symbol in that network.

Managed

Specifies whether that map symbol is in managed or unmanaged state.

INITIAL_MIBS

Specifies the initial MIB associated with that map symbol.

Y

Specifies the current X coordinate value where the map symbol is positioned. Edit this field to place the map symbol as and click Modify to effect the change.

X

Specifies the current Y coordinate value where the map symbol is positioned. Edit this field to place the map symbol as and click Modify to effect the change.

Height

Specifies the current height of the map symbol. Edit this field to resize the map symbol and click Modify to effect the change.

Width

Specifies the current width of the map symbol. Edit this field to resize the map symbol and click Modify to effect the change.

OwnerName

Specifies the owner to whom the link is associated.

Type

Specifies the type of the device associated with that map symbol.

Save changes to server

If you want to effect the changes you have made to the fields in map symbol Object Properties dialog, select this option. On selecting this, all the clients connected incorporate the change you have made.

If this option is not selected, then the changes you make is be reflected only in the client you are working on.

containment

Specifies whether the symbols inside the container should truly be contained within the boundaries of the container or not. If the value is set to true, you cannot move any of the symbols outside the boundaries of the container. If set to false, you can move symbols outside the boundaries and still they will be children objects of the container with their ParentName referring to the container object.

topology

Specifies the layout of the map. For more than one layout, specify as comma separated values.

Example: $grid(width=55, height=55), star, ring, flow

CurrentTopology

Specifies the topology property which has to be set as the default topology.

Base Properties

Name

Specifies a unique name of the object, such as network, node, router.

Display Name

Specifies a unique name of the object as displayed in the map.

Type

Specifies the type of the object. For example, Network.

Classname

Specifies the class name (not fully qualified name) and this property is used  while restoring the device sub-class when it is stored in the Relational Database.

Status

Specifies the current status (severity) of the object in the network.

Managed

Specifies whether the object is managed.

true - Managed

false - Unmanaged

Discover

Specifies whether the discovery of devices in the selected network should occur or not. If the option is not selected, the discovery of the network stops.

IP Related Properties

IpAddress

Specifies the unique IP address of the object.

Netmask

Specifies the netmask of the object.

Status Related Properties

StatusUpdateTime

Specifies the time (in milliseconds) at which status polling was last done for a device. This property is updated every time a status poll is done for the device, irrespective of the result of the status poll.

StatusChangeTime

Specifies  the time (in milliseconds) at which the status of the device last changed.

PollInterval

Specifies the interval between two successive status polling of the object.

FailureCount

Specifies a counter to indicate how many consecutive attempts of status poll for this object have failed. The count is reset to 0, once the object is declared as failed or when the object recovers after the failure. The failureCount is incremented once, for each successive failure of the status poll and when the value of failureCount equals to that of failureThreshold, the object will be declared failed.

Other Properties

UserClass

Specifies the class to be invoked for status polling of the device. This has effect only if the 'tester' property is set to the value 'usertest'.

Tester

Specifies user tester class used for the status polling of selected objects.

FailureThreshold

Specifies the number of consecutively failed status poll attempts, to declare the object as failed. A status change event for the object is generated when the status polling for the object fails for 'failureThreshold' times.

User Properties

DiscoveryStatus

Specifies the discovery status of the Network object.

1 - YET_TO_BEGIN

2 - IN_PROGRESS

3 - FINISHED

4 - DISCOVERY_DISABLED

ChildrenKeys

Specifies the child keys of the network object.

GroupNames

Specifies the names of groups to which the object belongs.

UserName

Specifies the user name which is used for the security of SNMP agent.

IsDHCP

Specifies whether the object is DHCP enabled or not. True denotes that the object is DHCP enabled.

StatusPollEnabled

Specifies whether the object status polling has been enabled for the object.

true - Enabled

false - Disabled

ParentNetwork

Specifies the parent network of the selected network object.

IsGroup

Specifies whether the object is in a group.

true - In a group

false - Not in a group

IsContainer

Specifies whether the object is a container.

true - Container

false - Not a container

ContextName

Specifies the details of the context name required for the security of the SNMP agent.

IsRouter

Specifies whether the object is a router.

true - Is a router

false - Not a router

Version

Specifies the version number of the SNMP agent.

ParentNetmask

Specifies the parent netmask of the selected network object. This is available only if a parent network exists for the selected network.

IsInterface

Specifies whether the object is an interface.

true - Is an interface

false - Not an interface

IsNetwork

Specifies whether the object is a network.

true - Is a network

false - Not a network

IP Related Properties

ParentNet

Specifies the name of the network to which the router belongs.

Host Netmask

The netmask of the IP address of the Managed Object

SNMP Related Properties

Snmpport

Specifies the port number to which the interface is connected.

Community

Specifies the community string of the corresponding agent associated with the interface.

WriteCommunity

Specifies the write community string used for Set requests.

SysName

Specifies the system name as reported by the SNMP agent.

SysDescr

Specifies system description associated with the type of object.

SysOID

Specifies the Object Identifier.

SNMP Version

Indicates the SNMP version of the agent running in the Network Element

Base MIBs

List of MIBs implemented by the Network Element that the Managed Object represents

User Properties

IsNode

Specifies whether object is a node.

true - Is a node

false - Not a node

IsSNMP

Specifies whether object is an SNMP device.

true - Is SNMP device

false - Not an SNMP device

User Properties

ChildrenKeys

Specifies the children keys (all ports) of the selected switch.

RootPort

Specifies the number of the port which offers the lowest cost path from this selected bridge to the root bridge.

NumPorts

Specifies the number of ports in the selected switch.

RootCost

Specifies the cost of the path to the root as seen from the selected bridge.

User Properties

PortIfDescr

Specifies information on the port.

PortIfSpeed

Specifies an estimate of the port interface's current bandwidth (in bits per second).

PortState

Specifies the state of the port.

Example: disabled, blocking, listening,  learning, forwarding, broken, unknown

PortIfIndex

Specifies the index of the port.

User Properties

ConsoleLightString

Specifies the vendor description or label of this light in the localization specified by prtConsoleLocalization.

ConsoleDispBufferText

Specifies the content of a line in the logical display buffer of the operator's console of the printer.

PrinterDeletedErrStatus

Specifies any error condition detected by the printer.

DeviceStatus

Specifies the current operational state of the device.

1 - unknown

2 - running

3 - warning

4 - testing

5 - down

TL1 Related Properties

ConnectionHandler

This handles the non-TL1 tasks before and after the TCP connection is established.

Dictionary

Specifies the XML file which contains the syntax for input and output messages for this particular type of TL1 device.

Tl1port

Specifies the port used to connect to this device.

PortList

Specifies the list of TL1 ports to connect to this device.

SessionId

Specifies a unique ID generated for the session established with the device.

NotifyId

Specifies a unique ID generated for receiving autonomous message from the device.

LoginCommand

Specifies the command to log in to the TL1 device.

InitCommand

Specifies the initial commands to be sent to the TL1 device after login.

InfoCommand

Specifies command which will be used for data collection from device data immediately after discovery.

User Properties

IsContentUpgraded