| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| alarmCatalogue |
Generic NE Alarm Catalogue specifying trap to alarm mappings.
type=Pointer default= Displayed(tab/group)=alarmCatalogue (Trap Configuration/Alarm Catalogue) |
| category |
This property specifies the GNE category and associated map icon for this profile.
type=genericne.CategoryType default=default Displayed(tab/group)=Generic NE Category |
| commandPrompt |
It is used to specify the command prompt. User can enter regular expression (Java).
type=string default=[\\n\\r][ \\t]?[A-Za-z0-9]*[A-Za-z0-9_-]*(>|#)[ \\t]* minimum=1 maximum=255 Displayed(tab/group)=Command Prompt (CLI Profile) |
| confirmPrompt |
It is used to specify the confirm prompt. This field is not applied if the "hasConfirmPrompt" field is false.
type=string default=Do you wish to continue minimum=1 maximum=255 Displayed(tab/group)=Prompt (CLI Profile/Login Confirm Prompt) |
| confirmPromptAnswer |
It is used to specify the answer provided by NFM-P when the confirm prompt is encountered.
It is not applied if the "hasConfirmPrompt" field is false.
type=string default=Y minimum=1 maximum=255 Displayed(tab/group)=Answer (CLI Profile/Login Confirm Prompt) |
| defaultEmCmd |
It is used to specify the default command for the NE to launch the alternate element management application.
The IP address can be identified as a tag in the command with %IP%.
DEPRECATED: 11.0 R7 - this property is subject. type=string default=N/A Displayed(tab/group)=Default Alternate Element Manager |
| defaultEmUrl |
It is used to specify the default URL for the NE for element management.
The IP address can be identified as a tag in the URL with %IP%.
type=string default= Displayed(tab/group)=Default Element Manager URL |
| defaultExternalEms |
It is used to specify the installation path for the external application to be launched.
The path is compatible to Windows, Linux, Solaris path formats where the client is installed.
The installation path must be located where the client is installed
type=string default= maximum=500 |
| description |
It is used to enter the description of the product.
type=string default= minimum=0 maximum=80 Displayed(tab/group)=Description |
| descriptorPointer |
A pointer to a descriptor to support more NFM-P domain object.
type=Pointer default= Displayed(tab/group)=Driver Module (/Driver Module) |
| disablePagingCommand |
It is a command to disable paging on NEs.
type=string default=Enter the command to disable paging (e.g. terminal length 0) minimum=0 maximum=100 Displayed(tab/group)=Disable Paging Command (CLI Profile) |
| dropCharAfterInvalidCR |
Specifies that if telnet socket detects a CR that is not followed by an LF or NUL,
what should be done with the invalid character.
(Only CR LF and CR NUL are accepted in RFC 854).
This method returns true if the character should be dropped
or false if the character should be kept.
type=boolean default=false Displayed(tab/group)=Drop Character After Invalid CR (CLI Profile) |
| enablingWriteAccessLoginPrompt |
It is used to specify the write access password prompt for second login level.
It is not applied if the "twoStepsLogin" field is disabled.
type=string default=[\\n\\r][Pp]assword(:)?[ \\t]* minimum=1 maximum=255 Displayed(tab/group)=Enable Login Prompt (CLI Profile/Second Level Login Details) |
| errorIndicator |
It is used to specify the errors in a result of command or login. User can enter regular expression (Java).
type=string default=[\\n\\r].*(ERROR|Error).* minimum=1 maximum=255 Displayed(tab/group)=Error Indicator (CLI Profile) |
| features |
Set of generic NE feature FDNs from which the objects for this feature can be retrieved from node.
type=Set (Pointer) |
| freezeDetectTime |
It is used to indicate the time that NFM-P should wait before declaring a network element as not responding after
execution of a command.
type=long default=120 minimum=1 maximum=65535 units=seconds Displayed(tab/group)=Execution Command Timeout (CLI Profile) |
| fullNodeResyncOnMaxTrapGap |
If true, forces a full node resync when the number of traps lost exceeds the
max configured.
DEPRECATED: 11.0 R5 - No longer supported for any Generic NE types supported in SAM type=boolean default=false |
| hasConfirmPrompt |
It is used to specify if the product has a confirm prompt after successful user login.
type=boolean default=false Displayed(tab/group)=Enable Confirm Prompt (CLI Profile/Login Confirm) |
| id |
The Generic NE Profile unique ID.
type=long access=read-create default=0 minimum=1 maximum=65535 Displayed(tab/group)=ID |
| idleSessionWarningMsg |
It is used to indicate if this GNE has warning message before disconnecting an idle session.
type=boolean default=false Displayed(tab/group)=Idle Session Warning Message (CLI Profile) |
| ignoreSshKeyMismatch |
It is used to specify if SSH key Mismatch has to be ignored.
type=boolean default=false |
| interfaceTypes |
Set of generic NE interface type FDNs from which the interface type
values can be retrieved.
type=Set (Pointer) |
| isAddCRToLFEnabled |
According to RFC 854, The sequence "CR LF", as defined, will cause the
NVT (Network Virtual Terminal) to be positioned at the left margin of
the next print line (as would, for example, the sequence "LF CR").
However, many systems and terminals do not treat CR and LF independently,
and will have to go to some effort to simulate their effect.
Therefore, the sequence "CR LF" must be treated as a single "new
line" character and used whenever their combined action is
intended.
type=boolean default=true Displayed(tab/group)=Add CR To LF (CLI Profile) |
| isCliSupported |
It is used to specify if the CLI is supported for the GNE.
type=boolean default=true Displayed(tab/group)=CLI Supported |
| isLoginPromptOptional |
It is used to specify if the login prompt is optional or not.
type=boolean default=true Displayed(tab/group)=Login Prompt Optional (CLI Profile) |
| loginTimeout |
It is used to specify the login timeout.
type=long default=10 minimum=1 maximum=65535 units=seconds Displayed(tab/group)=Login Timeout (CLI Profile) |
| macObjectId |
It is used to specify SNMP System MAC Object ID for this product profile.
type=string default= minimum=0 maximum=255 Displayed(tab/group)=Chassis MAC Object ID |
| maxNumSessions |
It is used to specify the number of telnet sessions that a box can handle simultaneously.
It is not currently used, future development.
type=int default=1 minimum=1 maximum=300 Displayed(tab/group)=Max Number of Sessions (CLI Profile) |
| maxPduSize |
Maximum size of PDU supported by nodes assigned to this profile.
DEPRECATED: 7.0R4 - OBSOLETE: Never supported type=int default=484 minimum=484 maximum=9216 |
| maxTrapGap |
Max number of trap losses that can be sustained before performing a full node resync.
DEPRECATED: 11.0 R5 - No longer supported for any Generic NE types supported in SAM type=int default=200 minimum=1 maximum=1000 |
| minTimeIntervalBetweenFullNodeResyncs |
Minimum time interval between subsequent full node resyncs, if these resyncs are
caused by trap gaps being exceeded.
DEPRECATED: 11.0 R5 - No longer supported for any Generic NE types supported in SAM type=int default=600 minimum=600 maximum=86400 units=seconds |
| negotiationDelay |
It is used to add delay between Telnet negotiation messages. If the value is non-zero then NFM-P will wait the time specified
before replying to negotiation messages. It was found that some generic node(s) may not deal particularly well
with fast responses to negotiation requests, typically this may cause login failure.
If required, try to set this value to as low as possible because the delay will be added to every
telnet negotiation response. For example a 50 ms value should be sufficient.
For most nodes it is recommended to leave the default value, the only known generic NE
that requires this value to be greater than zero is the ADVA network element, otherwise NFM-P
will not be able to login to this node via CLI.
type=int default=0 minimum=0 maximum=1000 units=milliseconds Displayed(tab/group)=Negotiation Delay (CLI Profile) |
| preLoginPrompt |
It is used to specify the pre prompt message when NFM-P connects to a GNE. (e.g. "---------------more-----------------").
type=string default= minimum=0 maximum=255 Displayed(tab/group)=Pre Login Prompt (CLI Profile) |
| productName |
It is used to specify the NE type for this generic NE profile (e.g. "7670 RSP").
type=string access=read-create minimum=1 maximum=80 Mandatory on create Displayed(tab/group)=Generic NE Type |
| reachabilityCheckInterval |
Interval defines how often the NE is checked for SNMP reachability (in minutes)
type=int default=10 minimum=2 maximum=60 units=minutes Displayed(tab/group)=Reachability Check Interval |
| readLoginPrompt |
It is used to specify the read access login prompt. User can enter regular expression (Java).
type=string default=[\\n\\r][lL]ogin(:)?[ \\t]* minimum=1 maximum=255 Displayed(tab/group)=Read Login Prompt (CLI Profile) |
| readPasswordPrompt |
It is used to specify the read access password prompt. User can enter regular expression (Java).
type=string default=[\\n\\r][Pp]assword(:)?[ \\t]* minimum=1 maximum=255 Displayed(tab/group)=Read Password Prompt (CLI Profile) |
| resetCommand |
It is a command to return to the root of CLI command tree.
type=string default=Enter the reset command (e.g. end) minimum=1 maximum=100 Displayed(tab/group)=Reset Command (CLI Profile) |
| supportsTrapRestorationLogs |
If true, all GNEs associated with this profile support trap restoration logs which
can be used to restore traps if traps are lost.
DEPRECATED: 11.0 R5 - No longer supported for any Generic NE types supported in SAM type=boolean default=false |
| supportsTrapSeqNumber |
If true, all GNEs associated with this profile support trap sequencing in a
SAM-friendly manner.
DEPRECATED: 11.0 R5 - No longer supported for any Generic NE types supported in SAM type=boolean default=false |
| sysObjectId |
It is used to specify SNMP System Object ID for this product profile.
The Sys Object ID can be specific to a product (e.g. "7670 RSP" the sys object id .1.3.6.1.4.1.637.69.2.1.1.63)
or to a family of a product (e.g. "Cisco product" the general sys object id 1.3.6.1.4.1.9.1.*).
type=string access=read-create default=.1.3.6.1.4.1. minimum=14 maximum=255 Mandatory on create Displayed(tab/group)=Sys Object ID |
| telnetPort |
It is used to specify the telnet port number for Script Management.
type=int default=23 minimum=1 maximum=65535 Displayed(tab/group)=Telnet Port (CLI Profile) |
| translators |
Set of generic NE Translator FDNs from which the objects can be retrieved from node.
type=Set (Pointer) |
| trapConfigScriptPointer |
A pointer to a script which through CLI sets GNE to send traps to NFM-P.
type=Pointer default= Displayed(tab/group)=Script (Trap Configuration/Trap Configuration Script) |
| trapDeConfigScriptPointer |
A pointer to a script which through CLI sets GNE not to send traps to NFM-P.
type=Pointer default= Displayed(tab/group)=Script (Trap Configuration/Trap De-Configuration Script) |
| trapDestinationReenableTimeInterval |
Minimum time period to wait before re-enabling the trap destination on the associated
nodes so that they can resume sending traps to SAM.
DEPRECATED: 7.0R4 - OBSOLETE: Never supported type=int default=300 minimum=300 maximum=3600 units=seconds |
| twoStepsLogin |
It is used to specify if the product has two levels of login for write access.
type=boolean default=false Displayed(tab/group)=Enable Second Login (CLI Profile/Second Level Login) |
| userDefined |
It is used internally.
type=boolean access=read-only default=true |
| writeAccessLoginCommand |
It is used to enable the second login (e.g. "enable"). This field is not applied if the "twoStepsLogin" field is disabled.
type=string default=Enter the login command (e.g enable) minimum=1 maximum=255 Displayed(tab/group)=Enable Login Command (CLI Profile/Second Level Login Details) |
| writeLoginPrompt |
It is used to specify the write access login prompt. User can enter regular expression (Java).
type=string default=[\\n\\r][lL]ogin(:)?[ \\t]* minimum=1 maximum=255 Displayed(tab/group)=Write Login Prompt (CLI Profile) |
| writePasswordPrompt |
It is used to specify the write access password prompt. User can enter regular expression (Java).
type=string default=[\\n\\r][Pp]assword(:)?[ \\t]* minimum=1 maximum=255 Displayed(tab/group)=Write Password Prompt (CLI Profile) |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
configInfo
: generic.CommonManagedContainmentEntityConfigurationInformation - An instance of Generic NE Profile.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
objectFullName
: string - Object Full name of Generic NE Profile that is modified.
genericne.GenericNeProfile.configureException
productName
: string -
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
scriptList
: List (generic.CommonManagedEntityInformation) -
genericne.GenericNeProfile.findScriptsException
genericNeProfile
: string -
oldDescriptorPointer
: string -
newDescriptorPointer
: string -
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
upgradeResult
: genericne.DriverUpgradeInfo - Upgrade result returned if specified in descriptor.xml