Overview Package Class Deprecated Help

sw
LogRetrievalManager

This class manages the logs retrieved operation related information, performed by NFM-P server, for each network element.

public class LogRetrievalManager

Properties
displayedName Specifies the displayed name of the network element.

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Name
fileRetrievalPolicyId Specifies the ID of the FileRetrieval Policy assigned to this network element.

type=int
default=1
minimum=1
maximum=65535
Displayed(tab/group)=Policy ID
fileRetrievalPolicyName Specifies the name of the FileRetrieval Policy assigned to this network element.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Policy Name
fileRetrievalPolicyType Specifies the name of the FileRetrieval Policy type.

type=mediation.FileRetrievalPolicyTypes
access=read-create
default=1
Displayed(tab/group)=Policy Type
lastLogRetrievalState Specifies the state of the last log retrieval operation, performed by NFM-P.

type=sw.BackupRestoreProcessState
access=read-only
default=notAttempted
Displayed(tab/group)=File Retrieval State (/File Retrieval Status)
lastLogRetrievedTimestamp Specifies the time of the last log retrieval operation, performed by NFM-P.

type=Date
access=read-only
default=0
Displayed(tab/group)=File Retrieved Time (/File Retrieval Status)
lastOperationDetails Specifies the text of the last message generated by a log retrieval operation.

type=string
access=read-only
default=
maximum=4096
Displayed(tab/group)=Last Operation Details
lastRSLFileRetrievalState Specifies the state of the last rsl file retrieval operation, performed by NFM-P.

type=sw.BackupRestoreProcessState
access=read-only
default=notAttempted
lastSuccessfulLogRetrievedTimestamp Specifies the time of the last successful log retrieved operation, performed by NFM-P.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Successful File Retrieved Time (/File Retrieval Status)
logType Specifies the type of logs to be retrieved.

type=sw.LogTypeEnum
default=AUDIT
Displayed(tab/group)=Log Type
nodeVersion Specifies the version of this network element.

type=string
access=read-only
default=
minimum=0
maximum=252
Displayed(tab/group)=Node Version
routerId Specifies the system address of the network element.

type=string
access=read-only
default=
maximum=64
Displayed(tab/group)=Router ID
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveLogs

This operation retrieves the log files (AUDIT, UAL and SNMP), RSL and I/C parameters from the node and saves them on the NFM-P server. When requesting for RSL, ensure that the OSS instanceFullName follows the format, network:38.120.200.156:logRMan-RSL Retrieval. When requesting for I/C parameters, ensure that the OSS instanceFullName follows the format, network:38.120.200.156:logRMan-I/C Retrieval. When requesting for log files, ensure that the OSS instanceFullName follows the format, network:38.120.200.156:logRMan-Log Retrieval, where 38.120.200.156 corresponds to node's systemAddress.
Input Parameters:
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sw.LogRetrievalManager.retrieveLogsException