Package | Description |
---|---|
org.netxms.client | |
org.netxms.client.datacollection | |
org.netxms.client.log | |
org.netxms.client.snmp |
Modifier and Type | Method and Description |
---|---|
void |
NXCSession.acknowledgeAlarm(long alarmId)
Acknowledge alarm.
|
void |
NXCSession.acknowledgeAlarm(long alarmId,
boolean sticky,
int time)
Acknowledge alarm.
|
void |
NXCSession.acknowledgeAlarm(String helpdeskReference)
Acknowledge alarm by helpdesk reference.
|
void |
NXCSession.addClusterNode(long clusterId,
long nodeId)
Add node to cluster.
|
void |
NXCSession.applyTemplate(long templateId,
long nodeId)
Apply data collection template to node.
|
void |
NXCSession.bindObject(long parentId,
long childId)
Bind object.
|
void |
NXCSession.cancelFileMonitoring(long nodeId,
String remoteFileName)
Cancel file monitoring
|
void |
NXCSession.cancelServerJob(long jobId)
Cancel server job
|
void |
NXCSession.changeObjecToolDisableStatuss(long toolId,
boolean enable)
Delete object tool.
|
void |
NXCSession.changeObjectZone(long objectId,
long zoneId)
Move object to different zone.
|
void |
NXCSession.clearCollectedData(long nodeId,
long dciId)
Clear collected data for given DCI
|
void |
NXCSession.closeConsole()
Close server console.
|
void |
NXCSession.closeEventProcessingPolicy()
Close event processing policy.
|
long |
NXCSession.createAction(String name)
Create new server action.
|
void |
NXCSession.createAlarmComment(long alarmId,
String text)
Create alarm comment.
|
void |
NXCSession.createAlarmComment(String helpdeskReference,
String text)
Create alarm comment by helpdesk reference.
|
org.netxms.api.client.images.LibraryImage |
NXCSession.createImage(org.netxms.api.client.images.LibraryImage image,
org.netxms.api.client.ProgressListener listener) |
void |
NXCSession.createNewCertificate(byte[] data,
String comments)
Create new certificate
|
long |
NXCSession.createObject(NXCObjectCreationData data)
Create new NetXMS object.
|
long |
NXCSession.createObject(NXCObjectCreationData data,
Object userData)
Create new NetXMS object.
|
long |
NXCSession.createSituation(String name,
String comments)
Create new situation object.
|
long |
NXCSession.createSnmpTrapConfiguration()
Create new trap configuration record.
|
long |
NXCSession.createUser(String name) |
long |
NXCSession.createUserGroup(String name) |
void |
NXCSession.deleteAction(long actionId)
Delete server action
|
void |
NXCSession.deleteAgentConfig(long id)
Seletes config by given id.
|
void |
NXCSession.deleteAgentFile(long nodeId,
String fileName)
Delete file from agent
|
void |
NXCSession.deleteAlarm(long alarmId)
Delete alarm.
|
void |
NXCSession.deleteAlarmComment(long alarmId,
long commentId)
Delete alarm comment.
|
void |
NXCSession.deleteCertificate(long id)
Delete certificate
|
void |
NXCSession.deleteEventTemplate(long eventCode)
Delete event template.
|
void |
NXCSession.deleteImage(org.netxms.api.client.images.LibraryImage image) |
void |
NXCSession.deleteObject(long objectId)
Delete object
|
void |
NXCSession.deleteObjectTool(long toolId)
Delete object tool.
|
void |
NXCSession.deletePredefinedGraph(long graphId)
Delete predefined graph.
|
void |
NXCSession.deleteScript(long scriptId) |
void |
NXCSession.deleteServerFile(String serverFileName)
Delete file from server's file store
|
void |
NXCSession.deleteServerVariable(String name) |
void |
NXCSession.deleteSituation(long id)
Delete situation object
|
void |
NXCSession.deleteSituationInstance(long id,
String instance)
Delete situation instance
|
void |
NXCSession.deleteSnmpTrapConfiguration(long trapId)
Delete SNMP trap configuration record from server.
|
void |
NXCSession.deleteUserDBObject(long id) |
void |
NXCSession.deployAgentPolicy(long policyId,
long nodeId)
Deploy policy on agent
|
void |
NXCSession.deployPackage(long packageId,
Long[] nodeList,
PackageDeploymentListener listener)
Deploy agent packages onto given nodes
|
AgentFile |
NXCSession.downloadFileFromAgent(long nodeId,
String remoteFileName,
long maxFileSize,
boolean follow)
Download file from remote host via agent.
|
File |
NXCSession.downloadFileFromServer(String remoteFileName)
Download file from server file storage.
|
File |
NXCSession.downloadMibFile()
Download MIB file from server.
|
void |
NXCSession.executeAction(long nodeId,
String action)
Execute action on remote agent
|
void |
NXCSession.executeServerCommand(long objectId,
String command)
Execute server command related to given object (usually defined as object
tool)
|
protected void |
NXCSession.executeSimpleCommand(int command)
Execute simple commands (without arguments and only returning RCC)
|
Table |
NXCSession.executeTableTool(long toolId,
long nodeId)
Execute object tool of "table" type against given node.
|
String |
NXCSession.exportConfiguration(String description,
long[] events,
long[] traps,
long[] templates,
UUID[] rules)
Export server configuration.
|
ConnectionPoint |
NXCSession.findConnectionPoint(int zoneId,
InetAddress ipAddr)
Find connection point (either directly connected or most close known
interface on a switch) for given IP address.
|
ConnectionPoint |
NXCSession.findConnectionPoint(long objectId)
Find connection point (either directly connected or most close known
interface on a switch) for given node or interface object.
|
ConnectionPoint |
NXCSession.findConnectionPoint(MacAddress macAddr)
Find connection point (either directly connected or most close known
interface on a switch) for given MAC address.
|
long |
NXCSession.generateEventCode()
Generate code for new event template.
|
long |
NXCSession.generateObjectToolId()
Generate unique ID for new object tool.
|
List<ServerAction> |
NXCSession.getActions()
Get list of configured actions from server
|
List<IpAddressListElement> |
NXCSession.getAddressList(int listId)
Get address list.
|
String |
NXCSession.getAgentConfig(long nodeId)
Get agent's master configuration file.
|
Alarm |
NXCSession.getAlarm(long alarmId)
Get information about single active alarm.
|
List<AlarmComment> |
NXCSession.getAlarmComments(long alarmId)
Get list of comments for given alarm.
|
List<EventInfo> |
NXCSession.getAlarmEvents(long alarmId)
Get information about events related to single active alarm.
|
HashMap<Long,Alarm> |
NXCSession.getAlarms()
Get list of active alarms.
|
String |
NXCSession.getAttributeForCurrentUser(String name) |
List<org.netxms.api.client.users.AuthCertificate> |
NXCSession.getCertificateList()
Get list of certificates
|
DciData |
NXCSession.getCollectedData(long nodeId,
long dciId,
Date from,
Date to,
int maxRows)
Get collected DCI data from server.
|
DciData |
NXCSession.getCollectedTableData(long nodeId,
long dciId,
String instance,
String dataColumn,
Date from,
Date to,
int maxRows)
Get collected table DCI data from server.
|
ConfigContent |
NXCSession.getConfigContent(long id)
Saves existing config
|
List<ConfigListElement> |
NXCSession.getConfigList()
Gets the list of configuration files.(Config id, name and sequence number)
|
long[] |
NXCSession.getDataCollectionEvents(long objectId)
Get all events used in data collection by given node, cluster, or template object.
|
int |
NXCSession.getEffectiveRights(long objectId)
Get effective rights of currently logged in user to given object.
|
EventProcessingPolicy |
NXCSession.getEventProcessingPolicy()
Get read-only copy of ebent processing policy.
|
List<EventTemplate> |
NXCSession.getEventTemplates()
Get event templates from server
|
String |
NXCSession.getHelpdeskIssueUrl(long alarmId)
Get URL for helpdesk issue associated with given alarm
|
org.netxms.api.client.images.LibraryImage |
NXCSession.getImage(UUID guid) |
List<org.netxms.api.client.images.LibraryImage> |
NXCSession.getImageLibrary() |
List<org.netxms.api.client.images.LibraryImage> |
NXCSession.getImageLibrary(String category) |
List<PackageInfo> |
NXCSession.getInstalledPackages()
Get list of installed packages
|
DciValue[] |
NXCSession.getLastValues(long nodeId)
Get last DCI values for given node
|
DciValue[] |
NXCSession.getLastValues(long nodeId,
boolean objectTooltipOnly)
Get last DCI values for given node
|
DciValue[] |
NXCSession.getLastValues(Set<MapDCIInstance> dciIDList)
Get last DCI values for given DCI id list(list can contain simple DCIss and table DCIs)
|
Date |
NXCSession.getMibFileTimestamp()
Get timestamp of server's MIB file.
|
NetworkPath |
NXCSession.getNetworkPath(long node1,
long node2)
Get IPv4 network path between two nodes.
|
PhysicalComponent |
NXCSession.getNodePhysicalComponents(long nodeId)
Get node's physical components (obtained from ENTITY-MIB).
|
List<SoftwarePackage> |
NXCSession.getNodeSoftwarePackages(long nodeId)
Get list of software packages installed on node.
|
List<WinPerfObject> |
NXCSession.getNodeWinPerfObjects(long nodeId)
Get list of available Windows performance objects.
|
ObjectToolDetails |
NXCSession.getObjectToolDetails(long toolId)
Get object tool details
|
List<ObjectTool> |
NXCSession.getObjectTools()
Get list of configured object tools
|
PerfTabDci[] |
NXCSession.getPerfTabItems(long nodeId)
Get list of DCIs configured to be shown on performance tab in console for
given node.
|
List<GraphSettings> |
NXCSession.getPredefinedGraphs()
Get list of predefined graphs.
|
List<Route> |
NXCSession.getRoutingTable(long nodeId)
Get routing table from node
|
org.netxms.api.client.scripts.Script |
NXCSession.getScript(long scriptId) |
List<org.netxms.api.client.scripts.Script> |
NXCSession.getScriptLibrary() |
String |
NXCSession.getServerConfigClob(String name)
Get server config CLOB
|
ServerJob[] |
NXCSession.getServerJobList()
Get list of server jobs
|
Map<String,Object> |
NXCSession.getServerStats()
Get server stats.
|
Map<String,org.netxms.api.client.servermanager.ServerVariable> |
NXCSession.getServerVariables() |
List<Situation> |
NXCSession.getSituations()
Get list of all configured situations
|
List<String> |
NXCSession.getSnmpCommunities()
Get list of well-known SNMP communities configured on server.
|
List<SnmpTrap> |
NXCSession.getSnmpTrapsConfiguration()
Get list of configured SNMP traps
|
List<SnmpTrap> |
NXCSession.getSnmpTrapsConfigurationSummary()
Get summary of SNMP trap mapping.
|
List<SnmpUsmCredential> |
NXCSession.getSnmpUsmCredentials()
Get list of well-known SNMP USM (user security model) credentials
configured on server.
|
long[] |
NXCSession.getSubnetAddressMap(long subnetId)
Get address map for subnet.
|
List<AgentParameter> |
NXCSession.getSupportedParameters(long nodeId)
Get list of parameters supported by agent running on given node.
|
List<AgentTable> |
NXCSession.getSupportedTables(long nodeId)
Get list of tables supported by agent running on given node.
|
List<FdbEntry> |
NXCSession.getSwitchForwardingDatabase(long nodeId)
Get switch forwarding database (MAC address table) from node
|
Table |
NXCSession.getTableLastValues(long nodeId,
long dciId)
Get last values for given table DCI on given node
|
Threshold[] |
NXCSession.getThresholds(long nodeId,
long dciId)
Get list of thresholds configured for given DCI
|
List<ThresholdViolationSummary> |
NXCSession.getThresholdSummary(long objectId)
Get threshold violation summary for all nodes under given parent object.
|
List<VlanInfo> |
NXCSession.getVlans(long nodeId)
Get list of VLANs configured on given node
|
List<WirelessStation> |
NXCSession.getWirelessStations(long nodeId)
Get list of wireless stations registered at given wireless controller.
|
void |
NXCSession.holdServerJob(long jobId)
Put server job on hold
|
void |
NXCSession.importConfiguration(String config,
int flags)
Import server configuration (events, traps, thresholds) from XML
|
long |
NXCSession.installPackage(PackageInfo info,
File pkgFile,
org.netxms.api.client.ProgressListener listener)
Install (upload) package on server
|
ServerFile[] |
NXCSession.listAgentFiles(ServerFile file,
String fullPath,
long objectId)
List files on agent file store.
|
List<UUID> |
NXCSession.listReports() |
ServerFile[] |
NXCSession.listServerFiles()
List files in server's file store.
|
ServerFile[] |
NXCSession.listServerFiles(String[] filter)
List files in server's file store.
|
void |
NXCSession.lockPackageDatabase()
Lock package database
|
void |
NXCSession.lockUserDatabase() |
void |
NXCSession.modifyAction(ServerAction action)
Modify server action
|
void |
NXCSession.modifyEventTemplate(EventTemplate evt)
Modify event template.
|
void |
NXCSession.modifyImage(org.netxms.api.client.images.LibraryImage image,
org.netxms.api.client.ProgressListener listener) |
void |
NXCSession.modifyObject(NXCObjectModificationData data)
Modify object (generic interface, in most cases wrapper functions should
be used instead).
|
void |
NXCSession.modifyObject(NXCObjectModificationData data,
Object userData)
Modify object (generic interface, in most cases wrapper functions should
be used instead).
|
void |
NXCSession.modifyObjectTool(ObjectToolDetails tool)
Modify object tool.
|
long |
NXCSession.modifyScript(long scriptId,
String name,
String source) |
void |
NXCSession.modifySituation(long id,
String name,
String comments)
Modify situation object.
|
void |
NXCSession.modifySnmpTrapConfiguration(SnmpTrap trap)
Modify SNMP trap configuration record.
|
void |
NXCSession.modifyUserDBObject(org.netxms.api.client.users.AbstractUserObject object) |
void |
NXCSession.modifyUserDBObject(org.netxms.api.client.users.AbstractUserObject object,
int fields) |
void |
NXCSession.moveAgentFile(long nodeId,
String oldName,
String newFileName)
Move file from agent
|
void |
NXCSession.openConsole()
Open server console.
|
DataCollectionConfiguration |
NXCSession.openDataCollectionConfiguration(long nodeId)
Open data collection configuration for given node.
|
EventProcessingPolicy |
NXCSession.openEventProcessingPolicy()
Open event processing policy for editing.
|
String |
NXCSession.openHelpdeskIssue(long alarmId)
Open issue in helpdesk system from given alarm
|
Log |
NXCSession.openServerLog(String logName)
Open server log by name.
|
void |
NXCSession.pollNode(long nodeId,
int pollType,
NodePollListener listener)
Perform a forced node poll.
|
boolean |
NXCSession.processConsoleCommand(String command)
Process console command on server.
|
void |
NXCSession.pushDciData(DciPushData[] data)
Push data to server.
|
void |
NXCSession.pushDciData(long nodeId,
long dciId,
String value)
Push value for single DCI.
|
void |
NXCSession.pushDciData(String nodeName,
String dciName,
String value)
Push value for single DCI.
|
Table |
NXCSession.queryAgentTable(long nodeId,
String name)
Query agent's table immediately.
|
NetworkMapPage |
NXCSession.queryLayer2Topology(long nodeId)
Query layer 2 topology for node
|
String |
NXCSession.queryParameter(long nodeId,
int origin,
String name)
Query parameter immediately.
|
Table |
NXCSession.receiveTable(long requestId,
int msgCode)
Receive table from server.
|
void |
NXCSession.removeClusterNode(long clusterId,
long nodeId)
Remove node from cluster.
|
void |
NXCSession.removePackage(long packageId)
Remove agent package from server
|
void |
NXCSession.removeTemplate(long templateId,
long nodeId,
boolean removeDci)
Remove data collection template from node.
|
void |
NXCSession.renameAgentFile(long nodeId,
String oldName,
String newFileName)
Rename file from agent
|
void |
NXCSession.renameScript(long scriptId,
String name) |
void |
NXCSession.resetServerComponent(int component)
Reset server's internal component (defined by SERVER_COMPONENT_xxx)
|
void |
NXCSession.resolveAlarm(long alarmId)
Resolve alarm.
|
void |
NXCSession.resolveAlarm(String helpdeskReference)
Resolve alarm by helpdesk reference.
|
String[] |
NXCSession.resolveDciNames(Collection<ConditionDciInfo> dciList)
Resolve names of given DCIs
|
String[] |
NXCSession.resolveDciNames(long[] nodeIds,
long[] dciIds)
Resolve names of given DCIs
|
void |
NXCSession.saveAgentConfig(ConfigContent conf)
Saves or creates new agent's config
|
void |
NXCSession.saveEventProcessingPolicy(EventProcessingPolicy epp)
Save event processing policy.
|
long |
NXCSession.saveGraph(GraphSettings graph,
boolean overwrite)
Checks if graph with specified name can be created/overwritten and creates/overwrites it in DB.
|
void |
NXCSession.sendEvent(long eventCode,
String[] parameters)
Convenience wrapper for sendEvent interface.
|
void |
NXCSession.sendEvent(long eventCode,
String eventName,
long objectId,
String[] parameters,
String userTag)
Send event to server.
|
void |
NXCSession.sendEvent(String eventName,
String[] parameters)
Convenience wrapper for sendEvent interface.
|
protected void |
NXCSession.sendFile(long requestId,
byte[] data,
org.netxms.api.client.ProgressListener listener)
Send block of data as binary message
|
protected void |
NXCSession.sendFile(long requestId,
File file,
org.netxms.api.client.ProgressListener listener)
Send file over CSCP
|
void |
NXCSession.sendMessage(org.netxms.base.NXCPMessage msg)
Send message to server
|
void |
NXCSession.sendSMS(String phoneNumber,
String message)
Send SMS via server.
|
void |
NXCSession.setAddressList(int listId,
List<IpAddressListElement> list)
Set content of address list.
|
void |
NXCSession.setAlarmFlowState(int state)
Changes state of alarm status flow.
|
void |
NXCSession.setAttributeForCurrentUser(String name,
String value) |
void |
NXCSession.setObjectACL(long objectId,
AccessListElement[] acl,
boolean inheritAccessRights)
Change object's ACL (wrapper for modifyObject())
|
void |
NXCSession.setObjectCustomAttributes(long objectId,
Map<String,String> attrList)
Change object's custom attributes (wrapper for modifyObject())
|
void |
NXCSession.setObjectManaged(long objectId,
boolean isManaged)
Set object's managed status.
|
void |
NXCSession.setObjectName(long objectId,
String name)
Change object's name (wrapper for modifyObject())
|
void |
NXCSession.setServerConfigClob(String name,
String value)
Set server config CLOB
|
void |
NXCSession.setServerVariable(String name,
String value) |
void |
NXCSession.setUserPassword(long id,
String newPassword,
String oldPassword) |
void |
NXCSession.snmpWalk(long nodeId,
String rootOid,
SnmpWalkListener listener)
Do SNMP walk.
|
void |
NXCSession.subscribe(int channels)
Subscribe to notification channel(s)
|
void |
NXCSession.swapAgentConfigs(long id1,
long id2)
Swaps 2 configs sequence numbers
|
void |
NXCSession.syncEventTemplates()
Synchronize event templates configuration.
|
void |
NXCSession.syncMissingObjects(long[] objects,
boolean syncComments)
Synchronize only those objects from given set which are not synchronized yet.
|
void |
NXCSession.syncMissingObjects(long[] objects,
boolean syncComments,
int options)
Synchronize only those objects from given set which are not synchronized yet.
|
void |
NXCSession.syncObjects()
Synchronizes NetXMS objects between server and client.
|
void |
NXCSession.syncObjectSet(long[] objects,
boolean syncComments)
Synchronizes selected object set with the server.
|
void |
NXCSession.syncObjectSet(long[] objects,
boolean syncComments,
int options)
Synchronizes selected object set with the server.
|
void |
NXCSession.syncUserDatabase() |
void |
NXCSession.terminateAlarm(long alarmId)
Terminate alarm.
|
void |
NXCSession.terminateAlarm(String helpdeskReference)
Terminate alarm by helpdesk reference.
|
TransformationTestResult |
NXCSession.testTransformationScript(long nodeId,
String script,
String inputValue)
Test DCI transformation script.
|
void |
NXCSession.unbindObject(long parentId,
long childId)
Unbind object.
|
void |
NXCSession.unholdServerJob(long jobId)
Put server on hold job to pending state
|
void |
NXCSession.uninstallAgentPolicy(long policyId,
long nodeId)
Uninstall policy from agent
|
void |
NXCSession.unlinkHelpdeskIssue(long alarmId)
Unlink helpdesk issue from alarm.
|
void |
NXCSession.unlinkHelpdeskIssue(String helpdeskReference)
Unlink helpdesk issue from alarm.
|
void |
NXCSession.unlockPackageDatabase()
Unlock package database
|
void |
NXCSession.unlockUserDatabase() |
void |
NXCSession.unsubscribe(int channels)
Unsubscribe from notification channel(s)
|
void |
NXCSession.updateAgentConfig(long nodeId,
String config,
boolean apply)
Update agent's master configuration file.
|
void |
NXCSession.updateAlarmComment(long alarmId,
long commentId,
String text)
Update alarm comment.
|
void |
NXCSession.updateCertificate(long id,
String comment)
Update certificate
|
void |
NXCSession.updateObjectComments(long objectId,
String comments)
Change object's comments.
|
void |
NXCSession.updateSnmpCommunities(List<String> list)
Update list of well-known SNMP community strings on server.
|
void |
NXCSession.updateSnmpUsmCredentials(List<SnmpUsmCredential> list)
Update list of well-known SNMP USM credentials on server.
|
long |
NXCSession.uploadFileToAgent(long nodeId,
String serverFileName,
String remoteFileName,
boolean jobOnHold)
Start file upload from server's file store to agent.
|
void |
NXCSession.uploadFileToServer(File localFile,
String serverFileName,
org.netxms.api.client.ProgressListener listener)
Upload local file to server's file store
|
void |
NXCSession.uploadLocalFileToAgent(File localFile,
String agentFileName,
long nodeId,
org.netxms.api.client.ProgressListener listener)
Upload local file to server's file store
|
org.netxms.base.NXCPMessage |
NXCSession.waitForMessage(int code,
long id) |
org.netxms.base.NXCPMessage |
NXCSession.waitForMessage(int code,
long id,
int timeout) |
org.netxms.base.NXCPMessage |
NXCSession.waitForRCC(long id) |
org.netxms.base.NXCPMessage |
NXCSession.waitForRCC(long id,
int timeout) |
void |
NXCSession.wakeupNode(long objectId)
Wakeup node by sending wake-on-LAN magic packet.
|
Modifier and Type | Method and Description |
---|---|
void |
DataCollectionConfiguration.clearCollectedData(long itemId)
Clear collected data for given DCI.
|
void |
DataCollectionConfiguration.close()
Close data collection configuration.
|
void |
DataCollectionConfiguration.copyObjects(long destNodeId,
long[] items)
Copy data collection objects.
|
long |
DataCollectionConfiguration.createItem()
Create new data collection item.
|
long |
DataCollectionConfiguration.createTable()
Create new data collection table.
|
void |
DataCollectionConfiguration.deleteObject(long itemId)
Delete data collection object.
|
void |
DataCollectionConfiguration.modifyObject(DataCollectionObject dco)
Modify data collection object.
|
void |
DataCollectionConfiguration.modifyObject(long dcObjectId)
Modify data collection object.
|
void |
DataCollectionConfiguration.moveObjects(long destNodeId,
long[] items)
Move data collection objects.
|
void |
DataCollectionConfiguration.open()
Open data collection configuration.
|
void |
DataCollectionConfiguration.setObjectStatus(long[] items,
int status)
Set status of data collection objects.
|
Modifier and Type | Method and Description |
---|---|
void |
Log.close()
Close log
|
void |
Log.query(LogFilter filter)
Send query to server
|
Table |
Log.retrieveData(long startRow,
long rowCount)
Retrieve log data from server.
|
Table |
Log.retrieveData(long startRow,
long rowCount,
boolean refresh)
Retrieve log data from server.
|
Constructor and Description |
---|
MibObject(org.netxms.base.NXCPDataInputStream in,
MibObject parent)
Read MIB object from compiled MIB file
|
MibTree(File file)
Create MIB tree from compiled MIB file.
|
Copyright © 2014. All rights reserved.