Package org.netxms.client
Class NXCSession
java.lang.Object
org.netxms.client.NXCSession
Communication session with NetXMS server.
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static final class
Message subscription class -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
-
Constructor Summary
ConstructorDescriptionNXCSession
(String connAddress) Create session object that will connect to given address on default port (4701) without encryption.NXCSession
(String connAddress, int connPort) Create session object that will connect to given address on given port without encryption.NXCSession
(String connAddress, int connPort, boolean connUseEncryption, boolean enableCompression) Create session object that will connect to given address on given port. -
Method Summary
Modifier and TypeMethodDescriptionvoid
acknowledgeAlarm
(long alarmId) Acknowledge alarm.void
acknowledgeAlarm
(long alarmId, boolean sticky, int time) Acknowledge alarm.void
acknowledgeAlarm
(String helpdeskReference) Acknowledge alarm by helpdesk reference.void
addClusterNode
(long clusterId, long nodeId) Add node to cluster.void
addConsoleListener
(ServerConsoleListener listener) Add server console listenervoid
addListener
(SessionListener listener) Add notification listenervoid
addMessageSubscription
(int messageCode, long messageId, MessageHandler handler) Subscribe to specific messagesvoid
Add repository.void
Add new scheduled taskvoid
addWirelessDomainController
(long wirelessDomainId, long nodeId) Add controller node to wireless domain.void
applyTemplate
(long templateId, long nodeId) Apply data collection template to node.boolean
areChildrenSynchronized
(long id) Returns true if children are already synchronized for given object.boolean
void
bindAgentTunnel
(int tunnelId, long nodeId) Bind agent tunnel to nodevoid
bindObject
(long parentId, long childId) Bind object.bulkResolveAlarms
(List<Long> alarmIds) Bulk terminate alarms.bulkTerminateAlarms
(List<Long> alarmIds) Bulk terminate alarms.void
cancelFileMonitoring
(UUID monitorId) Cancel file monitoringvoid
cancelServerJob
(long jobId) Cancel server joblong[]
changeDCIStatus
(long ownerId, long[] items, int status) Change data collection objects status without opening data collection configuration.void
changeObjectZone
(long objectId, int zoneUIN) Move object to different zone.boolean
Send KEEPALIVE message.void
clearAgentDataCollectionConfiguration
(long nodeId) Clear data collection configuration on agent.void
clearCollectedData
(long nodeId, long dciId) Clear collected data for given DCIvoid
cloneNetworkMap
(long mapId, String newObjectName, String alias) Create network map clonevoid
Close server console.void
Close event processing policy.protected void
closeTcpProxy
(int channelId) Close TCP proxy channel.compileScript
(String source, boolean serialize) Compile NXSL script on server.void
connect()
Connect to NetMS server.void
connect
(int[] componentVersions) Connect to NetMS server.void
copyAgentFile
(long nodeId, String oldName, String newFileName, boolean overwrite) Copy file from agentlong
createAction
(String name) Create new server action.void
createAlarmComment
(long alarmId, String text) Create alarm comment.void
createAlarmComment
(String helpdeskReference, String text) Create alarm comment by helpdesk reference.void
createAssetAttribute
(AssetAttribute attribute) Create asset attribute (definition in asset management schema)..protected void
createCustomObject
(NXCObjectCreationData data, Object userData, NXCPMessage msg) Hook method to allow adding of custom object creation data to NXCP message.protected AbstractObject
createCustomObjectFromMessage
(int objectClass, NXCPMessage msg) Create custom object from NXCP message.void
createFolderOnAgent
(long nodeId, String folder) Create folder on remote system via agentstatic GraphFolder
createGraphTree
(List<GraphDefinition> graphs) Create graph tree from listcreateImage
(LibraryImage image, ProgressListener listener) Create an imagevoid
createMaintenanceEntry
(long objectId, String description) Create new maintenance journal entry for specified objectint
createMappingTable
(String name, String description, int flags) Create new mapping table.void
Create notification channellong
Create new NetXMS object.long
createObject
(NXCObjectCreationData data, Object userData) Create new NetXMS object.long
createObjectAsync
(NXCObjectCreationData data, ObjectCreationListener callback) Create new NetXMS object and run callback once it's created.Create new NetXMS object in synchronous mode.long
Create new trap configuration record.createToolTree
(List<ObjectTool> tools) Create object tool treelong
createUser
(String name) Create user on servervoid
createUserAgentNotification
(String message, long[] objects, Date startTime, Date endTime, boolean onStartup) Create new user support application notificationsvoid
createUserAgentNotification
(String message, Collection<Long> objects, Date startTime, Date endTime, boolean onStartup) Create new user support application notificationslong
createUserGroup
(String name) Create user group on serverdciIdsToNames
(Collection<? extends NodeItemPair> itemList) Get names for given DCI listdciIdsToNames
(List<Long> nodeIds, List<Long> dciIds) Get names for given DCI listlong
dciNameToId
(long nodeId, String dciName) Get DCI ID for given DCI namevoid
delete2FAMethod
(String name) Delete two-factor authentication method.void
deleteAction
(long actionId) Delete server actionvoid
deleteAgentConfig
(long id) Delete server side agent configuration.void
deleteAgentFile
(long nodeId, String fileName) Delete file from agentvoid
deleteAlarm
(long alarmId) Delete alarm.void
deleteAlarmCategory
(long id) Delete alarm category in DBvoid
deleteAlarmComment
(long alarmId, long commentId) Delete alarm comment.void
deleteAssetAttribute
(String name) Delete asset attribute (definition in asset management schema).void
deleteAssetProperty
(long objectId, String name) Delete asset property.void
deleteBusinessServiceCheck
(long businessServiceid, long checkId) Delete check form businsess servicevoid
deleteDciEntry
(long nodeId, long dciId, long timestamp) Delete collected data entry for given DCIvoid
deleteDciSummaryTable
(int id) Delete DCI summary table.void
deleteEventTemplate
(long eventCode) Delete event template.void
deleteGeoArea
(int areaId, boolean forceDelete) Delete geographical area.void
deleteImage
(UUID guid) Delete an imagevoid
deleteImage
(LibraryImage image) Delete an imagevoid
deleteMappingTable
(int id) Delete mapping tablevoid
Delete notification channelvoid
deleteObject
(long objectId) Delete objectvoid
deleteObjectCategory
(int categoryId, boolean forceDelete) Delete object category.void
deleteObjectQuery
(int queryId) Delete predefined object query.void
deleteObjectTool
(long toolId) Delete object tool.void
Delete persistent storage valuevoid
deletePhysicalLink
(long linkId) Delete physical link.void
deletePolicy
(long templateId, UUID guid) Delete policyvoid
deletePredefinedGraph
(long graphId) Delete predefined graph.void
deleteReportResult
(UUID reportId, UUID jobId) Delete report resultvoid
deleteRepository
(int id) Delete repository.void
deleteScheduledTask
(long taskId) Delete scheduled task.void
deleteScript
(long scriptId) Delete script from libraryvoid
deleteServerFile
(String serverFileName) Delete file from server's file storevoid
deleteServerVariable
(String name) Delete server configuration variablevoid
deleteSnmpTrapConfiguration
(long trapId) Delete SNMP trap configuration record from server.void
deleteSshKey
(int id, boolean force) Delete SSH key.void
deleteUserDBObject
(int id) Delete user or group on servervoid
deleteWebServiceDefinition
(int id) Delete web service definition.void
deployAgentPolicy
(long policyId, long nodeId) Deploy policy on agentvoid
deployPackage
(long packageId, Long[] nodeList, PackageDeploymentListener listener) Deploy agent packages onto given nodesvoid
detachUserFromLdap
(int userId) Detach user from LDAPvoid
Disconnect from server.downloadFileFromAgent
(long nodeId, String remoteFileName, boolean expandMacros, long alarmId, Map<String, String> inputValues, long maxFileSize, boolean follow, ProgressListener listener, ServerJobIdUpdater updateServerJobId) Download file from remote host via agent.downloadFileFromAgent
(long nodeId, String remoteFileName, long maxFileSize, boolean follow, ProgressListener listener, ServerJobIdUpdater updateServerJobId) Download file from remote host via agent.downloadFileFromServer
(String remoteFileName) Download file from server file storage.Download MIB file from server.void
editMaintenanceEntry
(long objectId, long entryId, String description) Edit specified maintenance journal entry for specified objectenableAnonymousObjectAccess
(long objectId) Enable anonymous access to object.void
enableObjectTool
(long toolId, boolean enable) Enable or disable object tool/void
enableReconnect
(boolean enable) Enable or disable background reconnect.void
executeAction
(long nodeId, String action, String[] args) Execute action on remote agentvoid
executeAction
(long nodeId, String action, String[] args, boolean receiveOutput, TextOutputListener listener, Writer writer) Execute action on remote agentexecuteActionWithExpansion
(long nodeId, long alarmId, String action, boolean receiveOutput, Map<String, String> inputValues, List<String> maskedFields, TextOutputListener listener, Writer writer) Execute action on remote agentexecuteActionWithExpansion
(long nodeId, long alarmId, String action, Map<String, String> inputValues, List<String> maskedFields) Execute action on remote agentvoid
executeLibraryScript
(long objectId, long alarmId, String script, Map<String, String> inputFields, List<String> maskedFields, TextOutputListener listener) Execute library script on object.void
executeLibraryScript
(long nodeId, String script, Map<String, String> inputFields, List<String> maskedFields, TextOutputListener listener) Execute library script on object.executeReport
(ReportingJobConfiguration jobConfiguration) Execute a reportvoid
executeScript
(long objectId, String script, String parameters, TextOutputListener listener) Execute script.void
executeScript
(long objectId, String script, String parameters, TextOutputListener listener, boolean developmentMode) Execute script.void
executeScript
(long objectId, String script, List<String> parameterList, TextOutputListener listener) Execute script.void
executeScript
(long objectId, String script, List<String> parameterList, TextOutputListener listener, boolean developmentMode) Execute script.void
executeServerCommand
(long objectId, long alarmId, String command, Map<String, String> inputFields, List<String> maskedFields) Execute server command related to given object (usually defined as object tool)void
executeServerCommand
(long objectId, long alarmId, String command, Map<String, String> inputFields, List<String> maskedFields, boolean receiveOutput, TextOutputListener listener, Writer writer) Execute server command related to given object (usually defined as object tool)protected void
executeSimpleCommand
(int command) Execute simple commands (without arguments and only returning RCC)void
executeSshCommand
(long nodeId, long alarmId, String command, Map<String, String> inputFields, List<String> maskedFields, boolean receiveOutput, TextOutputListener listener, Writer writer) Execute SSH command on remote agentexecuteTableTool
(long toolId, long nodeId) Execute object tool of "table" type against given node.exportConfiguration
(String description, long[] events, long[] traps, long[] templates, UUID[] rules, long[] scripts, long[] objectTools, long[] dciSummaryTables, long[] actions, long[] webServices, String[] assetAttributes) Export server configuration.filterObjects
(ObjectFilter filter) Find all objects matching given filter.findAlarmCategoryById
(long id) Find alarm category by id in alarm category database internally maintained by session object.Find alarm category by name in alarm category database internally maintained by session object.findConnectionPoint
(int zoneId, InetAddress ipAddr) Find connection point (either directly connected or most close known interface on a switch) for given IP address.findConnectionPoint
(long objectId) Find connection point (either directly connected or most close known interface on a switch) for given node or interface object.findConnectionPoint
(MacAddress macAddr) Find node and/or connection point (either directly connected or most close known interface on a switch) for given MAC address.findConnectionPoints
(byte[] pattern, int searchLimit) Find nodes and/or connection points (either directly connected or most close known interface on a switch) for all MAC addresses that match given MAC address pattern.DciValue[]
Send request for last values using prepared messagefindEventTemplateByCode
(long code) Find event template by code in event template database internally maintained by session object.Find event template by name in event template database internally maintained by session object.org.netxms.client.FutureObject
findFutureObjectById
(long id) Find NetXMS object by it's identifier or return wait an object to wait onfindMatchingDCI
(long objectId, String objectName, String dciName, int flags) Find all DCIs matching given creteria.Find multiple alarm categories by category id`s in alarm category database internally maintained by session object.findMultipleEventTemplates
(long[] codes) Find multiple event templates by event codes in event template database internally maintained by session object.findMultipleEventTemplates
(Collection<Long> codes) Find multiple event templates by event codes in event template database internally maintained by session object.findMultipleObjects
(long[] idList, boolean returnUnknown) Find multiple NetXMS objects by identifiersfindMultipleObjects
(long[] idList, Class<? extends AbstractObject> classFilter, boolean returnUnknown) Find multiple NetXMS objects by identifiersfindMultipleObjects
(Collection<Long> idList, boolean returnUnknown) Find multiple NetXMS objects by identifiersfindMultipleObjects
(Collection<Long> idList, Class<? extends AbstractObject> classFilter, boolean returnUnknown) Find multiple NetXMS objects by identifiersfindNodesByHostname
(int zoneId, String hostname) Find all nodes that contain the primary hostnamefindObject
(ObjectFilter filter) Generic object find using filter.void
findObjectAsync
(long id, ObjectCreationListener callback) Find NetXMS object by it's identifier and execute provided callback once foundfindObjectByGUID
(UUID guid) Find NetXMS object by it's GUID.<T extends AbstractObject>
TfindObjectByGUID
(UUID guid, Class<T> requiredClass) Find NetXMS object by it's GUID with additional class checking.findObjectById
(long id) Find NetXMS object by it's identifier.findObjectById
(long id, boolean allowPartial) Find NetXMS object by it's identifier as full object or as partial object<T> T
findObjectById
(long id, Class<T> requiredClass) Find NetXMS object by it's identifier with additional class checking.findObjectByName
(String name) Find object by name.findObjectByName
(String name, ObjectFilter filter) Find object by name with object filter.findObjectByNamePattern
(String pattern) Find object by name using regular expression.findObjectByRegex
(String regex) Find object by regexlong
findProxyForNode
(long nodeId) Find suitable proxy for given node.findUserDBObjectByGUID
(UUID guid) Find user or group by GUIDfindUserDBObjectById
(int id, Runnable callback) Find user or group by ID.Find multiple users by list of IDsfindZone
(int zoneUIN) Find zone object by zone UIN (unique identification number).void
forceDCIPoll
(long nodeId, long dciId) Force DCI poll for given DCIvoid
forcePolicyInstallation
(long templateId) Force policy installation on all nodes where template is appliedlong
Generate code for new event template.long
Generate unique ID for new object tool.void
generateSshKeys
(String name) Generate new SSH keys .Get list of available two-factor authentication drivers.Get list of configured two-factor authentication methods.Get list of configured actions from servergetActiveThresholds
(List<SingleDciConfig> dciConfig) Get active thresholdsgetAddressList
(int listId) Get address list.getAgentConfiguration
(long id) Get server side agent configurationGets the list of configuration files.(Config id, name and sequence number)getAgentFileFingerprint
(long nodeId, String remoteFileName) Get file fingerprint from remote host via agent.getAgentFileInfo
(AgentFile file) Return information about agent filegetAgentPolicy
(long templateId, UUID policyGUID) Get agent policy by template id and GUIDgetAgentPolicyList
(long templateId) Returns agent policy listGet agent shared secret list (global and all zones).getAgentSharedSecrets
(int zoneUIN) Get agent shared secret list for specific zone.Get list of agent tunnelsgetAlarm
(long alarmId) Get information about single active alarm.Get alarm categories from servergetAlarmComments
(long alarmId) Get list of comments for given alarm.getAlarmEvents
(long alarmId) Get information about events related to single active alarm.int
Get maximum number of records allowed to be displayed in alarm listGet list of active alarms.getAllMaintenanceEntries
(long objectId, int maxEntries) Get list of maintenance journal entries for specified object and it's child objectsGet list of all objectsGet all accessible zone objectsgetArpCache
(long nodeId, boolean forceRead) Get ARP cache from nodeGet asset management schema from client-side cache.int
Get size of asset management schema (number of defined attributes).Get custom attribute for currently logged in user.Get the current authentication methodgetAuthenticationTokens
(int userId) Get list of active authentication tokens for given user.getBackgroundTaskState
(long taskId) Get state of background task.double
getBusinessServiceAvailablity
(long businessServiceid, TimePeriod timePeriod) Get business service availabilitygetBusinessServiceChecks
(long serviceId) Get list business service checksgetBusinessServiceTickets
(long businessServiceid, TimePeriod timePeriod) Get business service ticketsGet cached list event templatesGet client configuration hint as stringgetClientConfigurationHint
(String name, String defaultValue) Get client configuration hint as stringboolean
getClientConfigurationHintAsBoolean
(String name, boolean defaultValue) Get client configuration hint as booleanint
getClientConfigurationHintAsInt
(String name, int defaultValue) Get client configuration hint as integerGet client information stringGet the client`s languageint
getCollectedData
(long nodeId, long dciId, Date from, Date to, int maxRows, HistoricalDataType valueType) Get collected DCI data from server.getCollectedTableData
(long nodeId, long dciId, String instance, String dataColumn, Date from, Date to, int maxRows) Get collected table DCI data from server.getDataCollectionScripts
(long objectId) Get names of all scripts used in data collection by given node, cluster, or template object.Get default date format provided by servergetDciLastValue
(long nodeId, long dciId) Get last value for given table or single valued DCI on given nodegetDciMeasurementUnits
(List<Long> nodeIds, List<Long> dciIds) Get info for given DCI listgetDciMeasurementUnits
(List<ChartDciConfig> dciList) Get measurement units for given DCI listgetDciMeasurementUnits
(ChartDciConfig[] dciList) Get info for given DCI listgetDciSummaryTable
(int id) Get DCI summary table configuration.final int
Get the default DCI polling intervalfinal int
Get the default DCI retention timeint
Get default receiver buffer size.getDependentNodes
(long nodeId) Get list of dependent nodes for given node.getDeviceView
(long nodeId) Get device view for node.int
getEffectiveRights
(long objectId) Get effective rights of currently logged in user to given object.getEventName
(long code) Get event name from event codeGet read-only copy of event processing policy.getEventReferences
(long eventCode) Get list of objects that are using specified eventGet event objects from serverGet configured geographical areasint
Get number of remaining grace loginsgetHelpdeskIssueUrl
(long alarmId) Get URL for helpdesk issue associated with given alarmGet an image from the libraryGet the whole image librarygetImageLibrary
(String category) Get the image library of specific categoryGet list of installed packagesDciValue[]
getLastValues
(long nodeId) Get last DCI values for given nodeDciValue[]
getLastValues
(long nodeId, boolean objectTooltipOnly, boolean overviewOnly, boolean includeNoValueObjects) Get last DCI values for given nodeDciValue[]
getLastValues
(long nodeId, long mapId, boolean objectTooltipOnly, boolean overviewOnly, boolean includeNoValueObjects) Get last DCI values for given nodeDciValue[]
getLastValues
(List<SingleDciConfig> dciConfig) Get last DCI values for given Single Dci Config listDciValue[]
getLastValues
(Set<MapDCIInstance> mapDcis) Get last DCI values for given Map DCI Instance listGet list of license problems reported by server.getLocationHistory
(long objectId, Date from, Date to) Get location history for given object.getMappingTable
(int id) Get list of specific mapping tableint
Get max receiver buffer size.Get message of the day if server config is setGet timestamp of server's MIB file.int
Get the minimal view refresh intervalint
int
getNetworkPath
(long node1, long node2) Get IPv4 network path between two nodes.getNodeHardwareComponents
(long nodeId) Get list of hardware components as reported by agent.getNodePhysicalComponents
(long nodeId) Get node's physical components (obtained from ENTITY-MIB).getNodeSoftwarePackages
(long nodeId) Get list of software packages installed on node.getNodeWinPerfObjects
(long nodeId) Get list of available Windows performance objects.Get server notification channelsGet list of available notification channel drivers.Get all object categories.getObjectCategory
(int categoryId) Get object category by IDgetObjectName
(long objectId) Get object name by ID.getObjectNameWithAlias
(long objectId) Get object name with alias by ID.Get list of configured object queries.getObjectToolDetails
(long toolId) Get object tool detailsGet list of configured object toolsgetOSPFInfo
(long nodeId) Get OSPF information for given node.getPerfTabItems
(long nodeId) Get list of DCIs configured to be shown on performance tab in console for given node.Get list of all values in persistent storagegetPhysicalLinks
(long objectId, long patchPanelId) Get list of physical links filtered by provided optionsgetPredefinedGraph
(long graphId) Get predefined graph information by graph idgetPredefinedGraphs
(boolean graphTemplates) Get list of predefined graphs or graph templatesgetPredictedData
(long nodeId, long dciId, Date from, Date to) Get predicted DCI data from server.Get list of registered prediction enginesGet server public configuration variableboolean
Get server public configuration variable as boolen valueint
Get server public configuration variable as a intString[]
Get list of registered server componentslong[]
getRelatedEvents
(long objectId) Get all events used in data collection by given node, cluster, or template object.getReportDefinition
(UUID reportId) Get the report definitiongetReportResults
(UUID reportId) List report resultsGet list of configured repositoriesGet allowed tags for responsible users.getRoutingTable
(long nodeId) Get routing table from nodegetScheduledReportingJobs
(UUID reportId) List scheduled jobsGet list of available scheduled task handlers.Get list of scheduled tasks.getScript
(long scriptId) Get script from libraryGet list of all scripts in script library.Get server addressGet NetXMS server build information.byte[]
Get server identification colourgetServerConfigClob
(String name) Get server config CLOBlong
Get NetXMS server UID.Get list of server jobsGet server nameGet server stats.long
Get server timeGet server time zone.Get server configuration variablesGet NetXMS server version.int
Get this session's ID on server.Get time format for short form (usually without seconds).Get list of well-known SNMP communities configured on server.getSnmpCommunities
(int zoneUIN) Get list of well-known SNMP communities configured on server.Get list of configured SNMP trapsGet summary of SNMP trap mapping.Get list of well-known SNMP USM (user security model) credentials configured on server.getSnmpUsmCredentials
(int zoneUIN) Get list of well-known SNMP USM (user security model) credentials configured on server.Get SSH credentials for all zones.getSshCredentials
(int zoneUIN) Get SSH credentials for specific zone.getSshKeys
(boolean withPublicKey) Get list of SSH keylong[]
getSubnetAddressMap
(long subnetId) Get address map for subnet.getSupportedParameters
(long nodeId) Get list of parameters supported by agent running on given node.getSupportedParameters
(long nodeId, DataOrigin origin) Get list of parameters supported by entity defined by origin on given node.getSupportedTables
(long nodeId) Get list of tables supported by agent running on given node.getSwitchForwardingDatabase
(long nodeId) Get switch forwarding database (MAC address table) from nodegetTableLastValues
(long nodeId, long dciId) Get last value for given table DCI on given nodegetThresholds
(long nodeId, long dciId) Get list of thresholds configured for given DCIgetThresholdSummary
(long objectId) Get threshold violation summary for all nodes under given parent object.Get server URLGet default time format provided by servergetTooltipLastValues
(Set<Long> nodeList) Get tooltip last values for all objectsGet list of top-level objects.getTopLevelObjects
(Set<Integer> classFilter) Get list of top-level objects matching given class filter.getTopLevelObjects
(ObjectFilter objectFilter) Get list of top-level objects matching given object filter.Get user support application notifications listGet list of all user database objectsint
Get identifier of logged in user.Get the current user namegetUserSessions
(long nodeId) Get list of user sessions on given node as reported by agent.long
Get system-wide rights of currently logged in user.getVendorByMac
(Set<MacAddress> macList) Get vendor names by OUI part of provided MAC addresses.getVendorByMac
(MacAddress mac, Runnable callback) Get vendor name by OUI part of MAC address.getVlans
(long nodeId) Get list of VLANs configured on given nodeGet configured web service definitions.getWellKnownPorts
(int zoneUIN, String tag) Get list of well-known ports for given zone.getWellKnownPorts
(String tag) Get list of well-known ports (global and all zones).getWirelessStations
(long objectId) Get list of wireless stations registered at given wireless controller or access point.getZoneName
(int zoneUIN) Get zone name by UINvoid
handover
(NXCSession target) Handover object cache to new session.boolean
Check if server has any license problems.void
holdServerJob
(long jobId) Put server job on holdimportConfiguration
(File configFile, int flags) Import server configuration (events, traps, thresholds) from XML file.void
importConfiguration
(String config, int flags) Import server configuration (events, traps, thresholds) from XML document.long
installPackage
(PackageInfo info, File pkgFile, ProgressListener listener) Install (upload) package on serverboolean
Check if alarm categories are synchronized.boolean
isAssetAttributeUnique
(String newName) Check if asset management attribute name is uniqueboolean
Get connection stateboolean
Get encryption state for current session.boolean
Check if event configuratrion objects are synchronized.boolean
Get status of helpdesk integration module on server.boolean
Get the state of protocol version checkboolean
Check if password is expired for currently logged in user.boolean
Check if background reconnect is enabled.boolean
isServerComponentRegistered
(String componentId) Check if server component with given id is registeredboolean
final boolean
Get the state of alarm status flowboolean
boolean
Check if user database is synchronized with clientboolean
Get the state of zoningvoid
linkAsset
(long assetId, long objectId, boolean updateIdentification) Link asset object to given object.listAgentFiles
(AgentFile file, String fullPath, long objectId) List files on agent file store.Get list of all configured DCI summary tablesGet list of all configured mapping tables.List reportsList files in server's file store.listServerFiles
(String[] filter) List files in server's file store.void
Login to server using authentication token.void
Login to server using login name and password.void
login
(String login, Certificate certificate, Signature signature) Login to server using certificate.void
login
(AuthenticationType authType, String login, String password, Certificate certificate, Signature signature, TwoFactorAuthenticationCallback twoFactorAuthenticationCallback) Login to server.void
Modify existing two-factor authentication method or create new one.void
modifyAction
(ServerAction action) Modify server actionlong
modifyAlarmCategory
(AlarmCategory object) Add or update alarm category in DBvoid
modifyBusinessServiceCheck
(long businessServiceid, BusinessServiceCheck check) Modify check form businsess serviceprotected void
modifyCustomObject
(NXCObjectModificationData data, Object userData, NXCPMessage msg) Hook method to populate NXCP message with custom object's data on object modification.long
Modify data collection object without opening data collection configuration.int
Modify DCI summary table configuration.void
Modify event template.int
modifyGeoArea
(GeoArea area) Modify geographical area.void
modifyImage
(LibraryImage image, ProgressListener listener) Modify an imagevoid
Modify object (generic interface, in most cases wrapper functions should be used instead).void
modifyObject
(NXCObjectModificationData data, Object userData) Modify object (generic interface, in most cases wrapper functions should be used instead).int
modifyObjectCategory
(MutableObjectCategory category) Modify object category.int
modifyObjectQuery
(ObjectQuery query) Modify object query.void
Modify object tool.void
Modify repository.long
modifyScript
(long scriptId, String name, String source) Modify script.void
Modify SNMP trap configuration record.void
modifyUserDBObject
(AbstractUserObject object) Modify user database objectvoid
modifyUserDBObject
(AbstractUserObject object, int fields) Modify user database objectint
modifyWebServiceDefinition
(WebServiceDefinition definition) Modify (or create new) web service definition.void
moveAgentFile
(long nodeId, String oldName, String newFileName, boolean overwrite) Move file from agentfinal NXCPMessage
newMessage
(int code) Create new NXCP message with unique idvoid
onPolicyEditorClose
(long templateId) Command sent on policyEditor close to send updates to all applied nodesvoid
Open server console.openDataCollectionConfiguration
(long nodeId) Open data collection configuration for given node.openDataCollectionConfiguration
(long nodeId, RemoteChangeListener changeListener) Open data collection configuration for given node.Open event processing policy for editing.openHelpdeskIssue
(long alarmId) Open issue in helpdesk system from given alarmopenServerLog
(String logName) Open server log by name.int
parseDataRows
(byte[] input, DciData data) Parse data from raw message CMD_DCI_DATA.void
pollObject
(long objectId, ObjectPollType pollType, TextOutputListener listener) Perform a forced object poll.boolean
processConsoleCommand
(String command) Process console command on server.void
pushDciData
(long nodeId, long dciId, String value) Push value for single DCI.void
pushDciData
(String nodeName, String dciName, String value) Push value for single DCI.void
pushDciData
(DciPushData[] data) Push data to server.queryAdHocDciSummaryTable
(long baseObjectId, List<DciSummaryTableColumn> columns, AggregationFunction function, Date periodStart, Date periodEnd, boolean multiInstance) Query ad-hoc DCI summary table.queryAgentTable
(long nodeId, String name) Query agent's table immediately.queryDciSummaryTable
(int tableId, long baseObjectId) Query DCI summary table.queryInternalConnectionTopology
(long nodeId) Query internal connection topology for nodequeryLayer2Topology
(long nodeId) Query layer 2 topology for nodequeryObjectDetails
(String query, long rootObjectId, List<String> properties, List<String> orderBy, Map<String, String> inputFields, long contextObjectId, boolean readAllComputedProperties, int limit) Query objects on server side and read certain object properties.queryObjects
(String query) Query objects on server sidequeryObjects
(String query, long rootObjectId) Query objects on server side, optionally only those located below given root object.queryOSPFTopology
(long nodeId) Query OSPF topology for nodequeryParameter
(long nodeId, DataOrigin origin, String name) Query parameter immediately.queryScript
(long nodeId, String script, List<String> parameterList, TextOutputListener listener) Execute script and get return value as map.readAgentConfigurationFile
(long nodeId) Get agent's master configuration file.long
recalculateDCIValues
(long objectId, long dciId) Start recalculation of DCI values using preserver raw values.void
recallUserAgentNotification
(long id) Recall user support application notificationreceiveTable
(long requestId, int msgCode) Receive table from server.void
removeClusterNode
(long clusterId, long nodeId) Remove node from cluster.void
removeConsoleListener
(ServerConsoleListener listener) Remove server console listenervoid
removeListener
(SessionListener listener) Remove notification listenervoid
removeMessageSubscription
(int messageCode, long messageId) Remove message subscriptionvoid
removePackage
(long packageId) Remove agent package from servervoid
removeTemplate
(long templateId, long nodeId, boolean removeDci) Remove data collection template from node.void
removeWirelessDomainController
(long wirelessDomainId, long nodeId) Remove controller node from wireless domain.void
rename2FAMethod
(String oldName, String newName) Rename two-factor authentication methodvoid
renameAgentFile
(long nodeId, String oldName, String newFileName, boolean overwrite) Rename agent's filevoid
renameNotificationChannel
(String oldName, String newName) Rename notification channelvoid
renameScript
(long scriptId, String name) Rename script in script library.void
renameServerFile
(String oldFileName, String newFileName) Rename file in server's file storerenderReport
(UUID reportId, UUID jobId, ReportRenderFormat format) Render reportvoid
Request new ephemetral authentication token for this session from server.requestAuthenticationToken
(boolean persistent, int validFor, String description, int userId) Request new authentication token from server.void
resetServerComponent
(int component) Reset server's internal component (defined by SERVER_COMPONENT_xxx)void
resolveAlarm
(long alarmId) Resolve alarm.void
resolveAlarm
(String helpdeskReference) Resolve alarm by helpdesk reference.void
resyncAgentDataCollectionConfiguration
(long nodeId) Force re-synchronization of data collection configuration with agent.void
revokeAuthenticationToken
(int tokenId) Revoke persistent auithentication token.long
saveAgentConfig
(AgentConfiguration configuration) Update server side agent configurationvoid
Save event processing policy.long
saveGraph
(GraphDefinition graph, boolean overwrite) Checks if graph with specified name can be created/overwritten and creates/overwrites it in DB.savePolicy
(long templateId, AgentPolicy policy, boolean duplicate) Saves new or updated policyvoid
Convenience wrapper for sendEvent interface.void
sendEvent
(long eventCode, String eventName, long objectId, String[] parameters, String userTag, Date originTimestamp) Send event to server.void
Convenience wrapper for sendEvent interface.protected void
sendFile
(long requestId, byte[] data, ProgressListener listener, boolean allowStreamCompression) Send block of data as binary messageprotected void
sendFile
(long requestId, File file, ProgressListener listener, boolean allowStreamCompression, long offset) Send file over NXCPvoid
sendMessage
(NXCPMessage msg) Send message to servervoid
sendNotification
(String channelName, String phoneNumber, String subject, String message) Send Notification via server.protected void
Call notification handlers on all registered listenersvoid
setAddressList
(int listId, List<InetAddressListElement> list) Set content of address list.void
setAlarmFlowState
(int state) Changes state of alarm status flow.void
setAssetProperty
(long objectId, String name, String value) Set asset property value.void
setAttributeForCurrentUser
(String name, String value) Set custom attribute for currently logged in user.void
setClientAddress
(String clientAddress) Set the client addressvoid
setClientInfo
(String connClientInfo) Set client information stringvoid
setClientLanguage
(String clientLanguage) Set client`s languagevoid
setClientType
(int clientType) Set client type.void
setCommandTimeout
(int commandTimeout) Set command execution timeout.void
setConnectTimeout
(int connectTimeout) Set connect call timeout (must be set before connect call)void
setDefaultServerValues
(List<ServerVariable> varList) Set server configuration variables to defaultvoid
setIgnoreProtocolVersion
(boolean ignoreProtocolVersion) If set to true, protocol version is not checked at connect.void
setObjectACL
(long objectId, Collection<AccessListElement> acl, boolean inheritAccessRights) Change object's ACL (wrapper for modifyObject())void
setObjectCustomAttributes
(long objectId, Map<String, CustomAttribute> attrList) Change object's custom attributes (wrapper for modifyObject())void
setObjectMaintenanceMode
(long objectId, boolean inMaintenance) Set maintenance mode for objectvoid
setObjectMaintenanceMode
(long objectId, boolean inMaintenance, String comments) Set maintenance mode for objectvoid
setObjectManaged
(long objectId, boolean isManaged) Set object's managed status.void
setObjectName
(long objectId, String name) Change object's name (wrapper for modifyObject())void
setPersistentStorageValue
(String key, String value) Set persistent storage value.void
setRecvBufferSize
(int defaultBufferSize, int maxBufferSize) Set receiver buffer size.void
setServerConfigClob
(String name, String value) Set server config CLOBvoid
setServerVariable
(String name, String value) Set server configuration variablesetupTcpProxy
(long nodeId, int port) Setup new TCP proxy channel to given node.setupTcpProxy
(long proxyId, InetAddress address, int port) Setup new TCP proxy channel.void
setUserPassword
(int id, String newPassword, String oldPassword) Set password for uservoid
snmpWalk
(long nodeId, String rootOid, SnmpWalkListener listener) Do SNMP walk.void
Start active discovery for provided list manuallyvoid
stopScript
(long vmId) Stop running NXSL script.void
stopServerCommand
(long commandId) Stop server commandvoid
Subscribe to notification channel.void
Subscribe to user change notificationssubstituteMacros
(ObjectContextBase[] context, String textToExpand, Map<String, String> inputValues) Substitute macros in one string within multiple contexts.substituteMacros
(ObjectContextBase context, List<String> textsToExpand, Map<String, String> inputValues) Substitute macros in multiple strings within one context.void
swapAgentConfigs
(long id1, long id2) Swap sequence numbers of two server side agent configurations.void
Synchronize alarm category configuration.void
Synchronize asset management schema.void
syncChildren
(AbstractObject object) Sync children of given object.void
Synchronize event templates configuration.void
syncMissingObjects
(long[] objects) Synchronize only those objects from given set which are not synchronized yet.void
syncMissingObjects
(long[] objects, int options) Synchronize only those objects from given set which are not synchronized yet.void
syncMissingObjects
(long[] objects, long mapId, int options) Synchronize only those objects from given set which are not synchronized yet.void
syncMissingObjects
(Collection<Long> objects, int options) Synchronize only those objects from given set which are not synchronized yet.void
syncMissingObjects
(Collection<Long> objects, long mapId, int options) Synchronize only those objects from given set which are not synchronized yet.boolean
syncMissingUsers
(Set<Integer> users) Synchronize only objects that were not yet synchronizedvoid
Synchronize object categoriesvoid
Synchronizes NetXMS objects between server and client.void
syncObjects
(boolean syncNodeComponents) Synchronizes NetXMS objects between server and client.void
syncObjectSet
(long[] objects) Synchronizes selected object set with the server.void
syncObjectSet
(long[] objects, int options) Synchronizes selected object set with the server.void
syncObjectSet
(long[] objects, long mapId, int options) Synchronizes selected object set with the server.void
syncObjectSet
(Collection<Long> objects, long mapId, int options) Synchronizes selected object set with the server.void
Synchronize user database and subscribe to user change notificationsvoid
syncUserSet
(Set<Integer> users) Synchronize users by id if does not existbyte[]
takeScreenshot
(long nodeId, String sessionName) Take screenshot from given node.void
terminateAlarm
(long alarmId) Terminate alarm.void
terminateAlarm
(String helpdeskReference) Terminate alarm by helpdesk reference.testTransformationScript
(long nodeId, String script, String inputValue, DataCollectionObject dcObject) Test DCI transformation script.void
unbindAgentTunnel
(long nodeId) Unbind agent tunnel to nodevoid
unbindObject
(long parentId, long childId) Unbind object.void
unholdServerJob
(long jobId) Put server on hold job to pending statevoid
uninstallAgentPolicy
(long policyId, long nodeId) Uninstall policy from agentvoid
unlinkAsset
(long assetId) Unlink asset from object it is currently linked to.void
unlinkHelpdeskIssue
(long alarmId) Unlink helpdesk issue from alarm.void
unlinkHelpdeskIssue
(String helpdeskReference) Unlink helpdesk issue from alarm.void
unsubscribe
(String channel) Unsubscribe from notification channel.void
updateAgentSharedSecrets
(int zoneUIN, List<String> sharedSecrets) Update agent shared secret list on server.void
updateAlarmComment
(long alarmId, long commentId, String text) Update alarm comment.void
updateAssetAttribute
(AssetAttribute attribute) Update asset attribute (definition in asset management schema).int
updateMappingTable
(MappingTable table) Create or update mapping table.void
updateNetworkMapElementPosition
(long mapId, Set<NetworkMapElement> elements, Set<NetworkMapLink> links) Update network map object locationvoid
Update notification channelvoid
updateObjectComments
(long objectId, String comments) Change object's comments.void
Update metadata for existing package.void
Create new or update existing physical linkvoid
updateResponsibleUsers
(long objectId, List<ResponsibleUser> users) Update list of responsible users for given object.void
Update existing scheduled task.void
updateSnmpCommunities
(int zoneUIN, List<String> communityStrings) Update list of well-known SNMP community strings on server.void
updateSnmpUsmCredentials
(int zoneUIN, List<SnmpUsmCredential> usmCredentials) Update list of well-known SNMP USM credentials on server.void
updateSshCredentials
(int zoneUIN, List<SSHCredentials> sshCredentials) Update list of well-known SSH credentials on the server.void
updateSshKey
(SshKeyPair sshCertificateData) Update or import new SSH keysvoid
updateWellKnownPorts
(int zoneUIN, String tag, List<Integer> ports) Update list of well-known ports.long
uploadFileToAgent
(long nodeId, String serverFileName, String remoteFileName, boolean jobOnHold) Start file upload from server's file store to agent.void
uploadFileToServer
(File localFile, String serverFileName, ProgressListener listener) Upload local file to server's file storevoid
uploadLocalFileToAgent
(long nodeId, File localFile, String remoteFileName, boolean overwrite, ProgressListener listener) Upload local file to remote node via agent.boolean
validateProtocolVersions
(int[] versions) Validate protocol versionsboolean
validateUserPassword
(String password) Validate password for currently logged in userboolean
waitForAgentTunnel
(long nodeId, long timeout) Wait for bound tunnel for given node to appear.waitForFile
(long id, int timeout) Wait for specific file to arrivewaitForFileUpdate
(UUID monitorId, int timeout) Wait for update from specific file monitor.waitForMessage
(int code, long id) Wait for message with specific code and id.waitForMessage
(int code, long id, int timeout) Wait for message with specific code and id.waitForRCC
(long id) Wait for CMD_REQUEST_COMPLETED message with given id using default timeoutwaitForRCC
(long id, int timeout) Wait for CMD_REQUEST_COMPLETED message with given idvoid
wakeupNode
(long objectId) Wakeup node by sending wake-on-LAN magic packet.void
writeAgentConfigurationFile
(long nodeId, String config, boolean apply) Update agent's master configuration file.
-
Field Details
-
DCI_RES_SEARCH_NAME
public static final int DCI_RES_SEARCH_NAME- See Also:
-
DEFAULT_CONN_PORT
public static final int DEFAULT_CONN_PORT- See Also:
-
CHANNEL_AGENT_TUNNELS
- See Also:
-
CHANNEL_ALARMS
- See Also:
-
CHANNEL_AUDIT_LOG
- See Also:
-
CHANNEL_DC_THRESHOLDS
- See Also:
-
CHANNEL_GEO_AREAS
- See Also:
-
CHANNEL_EVENTS
- See Also:
-
CHANNEL_OBJECTS
- See Also:
-
CHANNEL_SNMP_TRAPS
- See Also:
-
CHANNEL_SYSLOG
- See Also:
-
CHANNEL_USERDB
- See Also:
-
OBJECT_SYNC_NOTIFY
public static final int OBJECT_SYNC_NOTIFY- See Also:
-
OBJECT_SYNC_WAIT
public static final int OBJECT_SYNC_WAIT- See Also:
-
OBJECT_SYNC_ALLOW_PARTIAL
public static final int OBJECT_SYNC_ALLOW_PARTIAL- See Also:
-
CFG_IMPORT_REPLACE_EVENTS
public static final int CFG_IMPORT_REPLACE_EVENTS- See Also:
-
CFG_IMPORT_REPLACE_ACTIONS
public static final int CFG_IMPORT_REPLACE_ACTIONS- See Also:
-
CFG_IMPORT_REPLACE_TEMPLATES
public static final int CFG_IMPORT_REPLACE_TEMPLATES- See Also:
-
CFG_IMPORT_REPLACE_TRAPS
public static final int CFG_IMPORT_REPLACE_TRAPS- See Also:
-
CFG_IMPORT_REPLACE_SCRIPTS
public static final int CFG_IMPORT_REPLACE_SCRIPTS- See Also:
-
CFG_IMPORT_REPLACE_SUMMARY_TABLES
public static final int CFG_IMPORT_REPLACE_SUMMARY_TABLES- See Also:
-
CFG_IMPORT_REPLACE_OBJECT_TOOLS
public static final int CFG_IMPORT_REPLACE_OBJECT_TOOLS- See Also:
-
CFG_IMPORT_REPLACE_EPP_RULES
public static final int CFG_IMPORT_REPLACE_EPP_RULES- See Also:
-
CFG_IMPORT_REPLACE_TEMPLATE_NAMES_LOCATIONS
public static final int CFG_IMPORT_REPLACE_TEMPLATE_NAMES_LOCATIONS- See Also:
-
CFG_IMPORT_DELETE_EMPTY_TEMPLATE_GROUPS
public static final int CFG_IMPORT_DELETE_EMPTY_TEMPLATE_GROUPS- See Also:
-
CFG_IMPORT_REPLACE_WEB_SVCERVICE_DEFINITIONS
public static final int CFG_IMPORT_REPLACE_WEB_SVCERVICE_DEFINITIONS- See Also:
-
CFG_IMPORT_REPLACE_AM_DEFINITIONS
public static final int CFG_IMPORT_REPLACE_AM_DEFINITIONS- See Also:
-
ADDRESS_LIST_DISCOVERY_TARGETS
public static final int ADDRESS_LIST_DISCOVERY_TARGETS- See Also:
-
ADDRESS_LIST_DISCOVERY_FILTER
public static final int ADDRESS_LIST_DISCOVERY_FILTER- See Also:
-
SERVER_COMPONENT_DISCOVERY_MANAGER
public static final int SERVER_COMPONENT_DISCOVERY_MANAGER- See Also:
-
DESKTOP_CLIENT
public static final int DESKTOP_CLIENT- See Also:
-
WEB_CLIENT
public static final int WEB_CLIENT- See Also:
-
MOBILE_CLIENT
public static final int MOBILE_CLIENT- See Also:
-
TABLET_CLIENT
public static final int TABLET_CLIENT- See Also:
-
APPLICATION_CLIENT
public static final int APPLICATION_CLIENT- See Also:
-
-
Constructor Details
-
NXCSession
Create session object that will connect to given address on default port (4701) without encryption.- Parameters:
connAddress
- server host name or IP address
-
NXCSession
Create session object that will connect to given address on given port without encryption.- Parameters:
connAddress
- server host name or IP addressconnPort
- TCP port
-
NXCSession
public NXCSession(String connAddress, int connPort, boolean connUseEncryption, boolean enableCompression) Create session object that will connect to given address on given port.- Parameters:
connAddress
- server host name or IP addressconnPort
- TCP portconnUseEncryption
- setup encrypted session if true
-
-
Method Details
-
createCustomObjectFromMessage
Create custom object from NXCP message. May be overridden by derived classes to create custom NetXMS objects. This method called before standard object creation, so it can be used for overriding standard object classes. If this method returns null, standard object creation mechanism will be used. Default implementation will always return null.- Parameters:
objectClass
- NetXMS object class IDmsg
- Source NXCP message- Returns:
- NetXMS object or null if object cannot be created
-
addListener
Add notification listener- Parameters:
listener
- Listener to add
-
removeListener
Remove notification listener- Parameters:
listener
- Listener to remove
-
addConsoleListener
Add server console listener- Parameters:
listener
- The ServerConsoleListener to add
-
removeConsoleListener
Remove server console listener- Parameters:
listener
- The ServerConsoleListener to remove
-
addMessageSubscription
Subscribe to specific messages- Parameters:
messageCode
- The message codemessageId
- The message IDhandler
- The message handler
-
removeMessageSubscription
public void removeMessageSubscription(int messageCode, long messageId) Remove message subscription- Parameters:
messageCode
- The message codemessageId
- The message ID
-
sendNotification
Call notification handlers on all registered listeners- Parameters:
n
- Notification object
-
sendMessage
Send message to server- Parameters:
msg
- Message to sent- Throws:
IOException
- in case of socket communication failureNXCException
- in case of encryption error
-
sendFile
protected void sendFile(long requestId, File file, ProgressListener listener, boolean allowStreamCompression, long offset) throws IOException, NXCException Send file over NXCP- Parameters:
requestId
- request IDfile
- source file to be sentlistener
- progress listenerallowStreamCompression
- true if data stream compression is allowedoffset
- offset to start data send or 0 if from the start- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
sendFile
protected void sendFile(long requestId, byte[] data, ProgressListener listener, boolean allowStreamCompression) throws IOException, NXCException Send block of data as binary message- Parameters:
requestId
- request IDdata
- file datalistener
- progress listenerallowStreamCompression
- true if data stream compression is allowed- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
waitForMessage
Wait for message with specific code and id.- Parameters:
code
- Message codeid
- Message idtimeout
- Wait timeout in milliseconds- Returns:
- Message object
- Throws:
NXCException
- if message was not arrived within timeout interval
-
waitForMessage
Wait for message with specific code and id.- Parameters:
code
- Message codeid
- Message id- Returns:
- Message object
- Throws:
NXCException
- if message was not arrived within timeout interval
-
waitForRCC
Wait for CMD_REQUEST_COMPLETED message with given id using default timeout- Parameters:
id
- Message id- Returns:
- received message
- Throws:
NXCException
- if message was not arrived within timeout interval or contains RCC other than RCC.SUCCESS
-
waitForRCC
Wait for CMD_REQUEST_COMPLETED message with given id- Parameters:
id
- Message idtimeout
- Timeout in milliseconds- Returns:
- received message
- Throws:
NXCException
- if message was not arrived within timeout interval or contains RCC other than RCC.SUCCESS
-
newMessage
Create new NXCP message with unique id- Parameters:
code
- Message code- Returns:
- New message object
-
waitForFile
Wait for specific file to arrive- Parameters:
id
- Message IDtimeout
- Timeout (since arrival of last received file part) in milliseconds to consider file transfer as timed out- Returns:
- Received file or null in case of failure
-
waitForFileUpdate
Wait for update from specific file monitor.- Parameters:
monitorId
- file monitor ID (previously returned bydownloadFileFromAgent
timeout
- Wait timeout in milliseconds- Returns:
- Received tail string or null in case of failure
-
executeSimpleCommand
Execute simple commands (without arguments and only returning RCC)- Parameters:
command
- Command code- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
receiveTable
Receive table from server.- Parameters:
requestId
- request IDmsgCode
- Message code- Returns:
- Received table
- Throws:
NXCException
- if operation was timed out
-
connect
Connect to NetMS server. Establish connection with the server and set up encryption if required. Only base protocol version check will be performed. Login must be performed before using session after successful connect.- Throws:
IOException
- if socket I/O error occursUnknownHostException
- if the host is unknownNXCException
- if NetXMS server returns an error or operation was timed outIllegalStateException
- if the state is illegal
-
connect
public void connect(int[] componentVersions) throws IOException, UnknownHostException, NXCException, IllegalStateException Connect to NetMS server. Establish connection with the server and set up encryption if required. Versions of protocol components given in *componentVersions* will be validated. Login must be performed before using session after successful connect.- Parameters:
componentVersions
- The versions of the components- Throws:
IOException
- if socket I/O error occursUnknownHostException
- if the host is unknownNXCException
- if NetXMS server returns an error or operation was timed outIllegalStateException
- if the state is illegal
-
login
public void login(String login, String password) throws NXCException, IOException, IllegalStateException Login to server using login name and password.- Parameters:
login
- login namepassword
- password- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed outIllegalStateException
- if the state is illegal
-
login
Login to server using authentication token.- Parameters:
token
- authentication token- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed outIllegalStateException
- if the state is illegal
-
login
public void login(String login, Certificate certificate, Signature signature) throws NXCException, IOException, IllegalStateException Login to server using certificate.- Parameters:
login
- login namecertificate
- user's certificatesignature
- user's digital signature- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed outIllegalStateException
- if the state is illegal
-
login
public void login(AuthenticationType authType, String login, String password, Certificate certificate, Signature signature, TwoFactorAuthenticationCallback twoFactorAuthenticationCallback) throws NXCException, IOException, IllegalStateException Login to server.- Parameters:
authType
- authentication typelogin
- login namepassword
- passwordcertificate
- user's certificatesignature
- user's digital signaturetwoFactorAuthenticationCallback
- callback for handling two-factor authentication if requested by server- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed outIllegalStateException
- if the state is illegal
-
requestAuthenticationToken
Request new ephemetral authentication token for this session from server.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
requestAuthenticationToken
public AuthenticationToken requestAuthenticationToken(boolean persistent, int validFor, String description, int userId) throws IOException, NXCException Request new authentication token from server.- Parameters:
persistent
- true to request persistent tokenvalidFor
- token validity time in secondsdescription
- optional token description (can be null)userId
- user ID to issue token for (0 to indicate currently logged in user)- Returns:
- token ID for persistent tokens or 0 for ephemeral
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
revokeAuthenticationToken
Revoke persistent auithentication token.- Parameters:
tokenId
- token ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAuthenticationTokens
public List<AuthenticationToken> getAuthenticationTokens(int userId) throws IOException, NXCException Get list of active authentication tokens for given user.- Parameters:
userId
- user ID to get token list for (0 to indicate currently logged in user)- Returns:
- list of tokens
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
disconnect
public void disconnect()Disconnect from server. -
isReconnectEnabled
public boolean isReconnectEnabled()Check if background reconnect is enabled.- Returns:
- true if background reconnect is enabled
-
enableReconnect
public void enableReconnect(boolean enable) Enable or disable background reconnect.- Parameters:
enable
- true to enable background session reconnect
-
isConnected
public boolean isConnected()Get connection state- Returns:
- connection state
-
isEncrypted
public boolean isEncrypted()Get encryption state for current session.- Returns:
- true if session is encrypted
-
isIgnoreProtocolVersion
public boolean isIgnoreProtocolVersion()Get the state of protocol version check- Returns:
- true if protocol version should not be checked
-
setIgnoreProtocolVersion
public void setIgnoreProtocolVersion(boolean ignoreProtocolVersion) If set to true, protocol version is not checked at connect.- Parameters:
ignoreProtocolVersion
- true if protocol version should not be checked
-
validateProtocolVersions
public boolean validateProtocolVersions(int[] versions) Validate protocol versions- Parameters:
versions
- the protocol versions- Returns:
- true if protocol versions are valid
-
getDefaultRecvBufferSize
public int getDefaultRecvBufferSize()Get default receiver buffer size.- Returns:
- Default receiver buffer size in bytes.
-
getMaxRecvBufferSize
public int getMaxRecvBufferSize()Get max receiver buffer size.- Returns:
- Max receiver buffer size in bytes.
-
setRecvBufferSize
public void setRecvBufferSize(int defaultBufferSize, int maxBufferSize) Set receiver buffer size. This method should be called before connect(). It will not have any effect after connect().- Parameters:
defaultBufferSize
- default size of receiver buffer in bytes.maxBufferSize
- max size of receiver buffer in bytes.
-
getServerAddress
Get server address- Returns:
- Server address
-
getServerVersion
Get NetXMS server version.- Returns:
- Server version
-
getServerBuild
Get NetXMS server build information.- Returns:
- Server version
-
getServerId
public long getServerId()Get NetXMS server UID.- Returns:
- Server UID
-
getServerTimeZone
Get server time zone.- Returns:
- server's time zone string
-
getServerName
Get server name- Returns:
- the serverName
-
getServerColor
Get server identification colour- Returns:
- the serverColor
-
getServerTime
public long getServerTime()Get server time- Returns:
- the serverTime
-
getObjectMaintenancePredefinedPeriods
- Returns:
- the objectMaintenancePredefinedPeriods
-
getServerChallenge
public byte[] getServerChallenge()- Returns:
- the serverChallenge
-
isServerComponentRegistered
Check if server component with given id is registered- Parameters:
componentId
- The component ID- Returns:
- true if server component is registered
-
getRegisteredServerComponents
Get list of registered server components- Returns:
- Array of registered server components
-
getTileServerURL
Get server URL- Returns:
- the tileServerURL
-
isZoningEnabled
public boolean isZoningEnabled()Get the state of zoning- Returns:
- true if zoning is enabled
-
isHelpdeskLinkActive
public boolean isHelpdeskLinkActive()Get status of helpdesk integration module on server.- Returns:
- true if helpdesk integration module loaded on server
-
getClientInfo
Get client information string- Returns:
- The client information
-
setClientInfo
Set client information string- Parameters:
connClientInfo
- The client info to set
-
setCommandTimeout
public void setCommandTimeout(int commandTimeout) Set command execution timeout.- Parameters:
commandTimeout
- New command timeout
-
setConnectTimeout
public void setConnectTimeout(int connectTimeout) Set connect call timeout (must be set before connect call)- Parameters:
connectTimeout
- connect timeout in milliseconds
-
getUserId
public int getUserId()Get identifier of logged in user.- Returns:
- Identifier of logged in user
-
getUserName
Get the current user name- Returns:
- the userName
-
getAuthenticationMethod
Get the current authentication method- Returns:
- the authenticationMethod
-
getUserSystemRights
public long getUserSystemRights()Get system-wide rights of currently logged in user.- Returns:
- System-wide rights of currently logged in user
-
getMessageOfTheDay
Get message of the day if server config is set- Returns:
- Message of the day
-
getLicenseProblems
Get list of license problems reported by server. This method will always return null for community edition server.- Returns:
- list of license problems reported by server or null if there are none
-
hasLicenseProblems
public boolean hasLicenseProblems()Check if server has any license problems.- Returns:
- true if server has any license problems
-
isPasswordExpired
public boolean isPasswordExpired()Check if password is expired for currently logged in user.- Returns:
- true if password is expired
-
getGraceLogins
public int getGraceLogins()Get number of remaining grace logins- Returns:
- number of remaining grace logins
-
getAlarmListDisplayLimit
public int getAlarmListDisplayLimit()Get maximum number of records allowed to be displayed in alarm list- Returns:
- The limit of alarms displayed
-
getClientConfigurationHint
Get client configuration hint as string- Parameters:
name
- hint namedefaultValue
- default value (returned if given hint was not provided by server)- Returns:
- hint value as provided by server or default value
-
getClientConfigurationHint
Get client configuration hint as string- Parameters:
name
- hint name- Returns:
- hint value as provided by server or null
-
getClientConfigurationHintAsInt
Get client configuration hint as integer- Parameters:
name
- hint namedefaultValue
- default value (returned if given hint was not provided by server or is not valid integer)- Returns:
- hint value as provided by server or default value
-
getClientConfigurationHintAsBoolean
Get client configuration hint as boolean- Parameters:
name
- hint namedefaultValue
- default value (returned if given hint was not provided by server or is not valid boolean)- Returns:
- hint value as provided by server or default value
-
getResponsibleUserTags
Get allowed tags for responsible users.- Returns:
- allowed tags for responsible users
-
syncObjectCategories
Synchronize object categories- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getObjectCategory
Get object category by ID- Parameters:
categoryId
- object category ID- Returns:
- object category or null
-
getObjectCategories
Get all object categories.- Returns:
- all object categories
-
modifyObjectCategory
Modify object category.- Parameters:
category
- updated category object- Returns:
- ID of category object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteObjectCategory
public void deleteObjectCategory(int categoryId, boolean forceDelete) throws IOException, NXCException Delete object category. This method will fail if category is in use (set to at least one object) unless forceDelete parameter set to true.- Parameters:
categoryId
- category IDforceDelete
- force deletion flag - if set to true category will be deleted even if in use- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncObjects
Synchronizes NetXMS objects between server and client. After successful sync, subscribe client to object change notifications.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncObjects
Synchronizes NetXMS objects between server and client. After successful sync, subscribe client to object change notifications.- Parameters:
syncNodeComponents
- defines if node components should be synced- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncObjectSet
Synchronizes selected object set with the server.- Parameters:
objects
- identifiers of objects need to be synchronized- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncObjectSet
Synchronizes selected object set with the server. The following options are accepted:
OBJECT_SYNC_NOTIFY
- send object update notification for each received object
OBJECT_SYNC_WAIT
- wait until all requested objects received- Parameters:
objects
- identifiers of objects need to be synchronizedoptions
- sync options (see above)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncObjectSet
Synchronizes selected object set with the server. The following options are accepted:
OBJECT_SYNC_NOTIFY
- send object update notification for each received object
OBJECT_SYNC_WAIT
- wait until all requested objects received
OBJECT_SYNC_ALLOW_PARTIAL
- allow reading partial object information (map ID should be set to get partial access to objects)- Parameters:
objects
- identifiers of objects need to be synchronizedmapId
- ID of map object to be used as reference if OBJECT_SYNC_ALLOW_PARTIAL is setoptions
- sync options (see above)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncObjectSet
public void syncObjectSet(Collection<Long> objects, long mapId, int options) throws IOException, NXCException Synchronizes selected object set with the server. The following options are accepted:
OBJECT_SYNC_NOTIFY
- send object update notification for each received object
OBJECT_SYNC_WAIT
- wait until all requested objects received
OBJECT_SYNC_ALLOW_PARTIAL
- allow reading partial object information (map ID should be set to get partial access to objects)- Parameters:
objects
- identifiers of objects need to be synchronizedmapId
- ID of map object to be used as reference if OBJECT_SYNC_ALLOW_PARTIAL is setoptions
- sync options (see above)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncMissingObjects
Synchronize only those objects from given set which are not synchronized yet.- Parameters:
objects
- identifiers of objects need to be synchronized- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncMissingObjects
Synchronize only those objects from given set which are not synchronized yet. Accepts all options which are valid for syncObjectSet.- Parameters:
objects
- identifiers of objects need to be synchronizedoptions
- sync options (see comments for syncObjectSet)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncMissingObjects
public void syncMissingObjects(long[] objects, long mapId, int options) throws IOException, NXCException Synchronize only those objects from given set which are not synchronized yet. Accepts all options which are valid for syncObjectSet.- Parameters:
objects
- identifiers of objects need to be synchronizedmapId
- ID of map object to be used as reference if OBJECT_SYNC_ALLOW_PARTIAL is setoptions
- sync options (see comments for syncObjectSet)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncMissingObjects
public void syncMissingObjects(Collection<Long> objects, int options) throws IOException, NXCException Synchronize only those objects from given set which are not synchronized yet. Accepts all options which are valid for syncObjectSet.- Parameters:
objects
- identifiers of objects need to be synchronizedoptions
- sync options (see comments for syncObjectSet)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncMissingObjects
public void syncMissingObjects(Collection<Long> objects, long mapId, int options) throws IOException, NXCException Synchronize only those objects from given set which are not synchronized yet. Accepts all options which are valid for syncObjectSet.- Parameters:
objects
- identifiers of objects need to be synchronizedmapId
- ID of map object to be used as reference if OBJECT_SYNC_ALLOW_PARTIAL is setoptions
- sync options (see comments for syncObjectSet)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncChildren
Sync children of given object.- Parameters:
object
- parent object- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
areChildrenSynchronized
public boolean areChildrenSynchronized(long id) Returns true if children are already synchronized for given object.- Parameters:
id
- object id- Returns:
- true if children are synchronized
-
findObjectByRegex
Find object by regex- Parameters:
regex
- for object name- Returns:
- list of matching objects
-
findObjectById
Find NetXMS object by it's identifier.- Parameters:
id
- Object identifier- Returns:
- Object with given ID or null if object cannot be found
-
findObjectById
Find NetXMS object by it's identifier as full object or as partial object- Parameters:
id
- Object identifierallowPartial
- true to allow returning objects with partial data- Returns:
- Object with given ID or null if object cannot be found
-
findFutureObjectById
public org.netxms.client.FutureObject findFutureObjectById(long id) Find NetXMS object by it's identifier or return wait an object to wait on- Parameters:
id
- Object identifier- Returns:
- Object to wait on if object not found. If object is found it will be already set inside
-
findObjectAsync
Find NetXMS object by it's identifier and execute provided callback once found- Parameters:
id
- Object identifiercallback
- callback to be called when object is found
-
findObjectById
Find NetXMS object by it's identifier with additional class checking.- Type Parameters:
T
- Object- Parameters:
id
- object identifierrequiredClass
- required object class- Returns:
- Object with given ID or null if object cannot be found or is not an instance of required class
-
findMultipleObjects
Find multiple NetXMS objects by identifiers- Parameters:
idList
- array of object identifiersreturnUnknown
- if true, this method will return UnknownObject placeholders for unknown object identifiers- Returns:
- list of found objects
-
findMultipleObjects
public List<AbstractObject> findMultipleObjects(long[] idList, Class<? extends AbstractObject> classFilter, boolean returnUnknown) Find multiple NetXMS objects by identifiers- Parameters:
idList
- array of object identifiersclassFilter
- class filter for objects, or null to disable filteringreturnUnknown
- if true, this method will return UnknownObject placeholders for unknown object identifiers- Returns:
- list of found objects
-
findMultipleObjects
Find multiple NetXMS objects by identifiers- Parameters:
idList
- collection of object identifiersreturnUnknown
- if true, this method will return UnknownObject placeholders for unknown object identifiers- Returns:
- array of found objects
-
findMultipleObjects
public List<AbstractObject> findMultipleObjects(Collection<Long> idList, Class<? extends AbstractObject> classFilter, boolean returnUnknown) Find multiple NetXMS objects by identifiers- Parameters:
idList
- collection of object identifiersclassFilter
- class filter for objects, or null to disable filteringreturnUnknown
- if true, this method will return UnknownObject placeholders for unknown object identifiers- Returns:
- array of found objects
-
findObjectByGUID
Find NetXMS object by it's GUID.- Parameters:
guid
- Object GUID- Returns:
- Object with given ID or null if object cannot be found
-
findObjectByGUID
Find NetXMS object by it's GUID with additional class checking.- Type Parameters:
T
- Object- Parameters:
guid
- object GUIDrequiredClass
- required object class- Returns:
- Object with given ID or null if object cannot be found or is not an instance of required class
-
findZone
Find zone object by zone UIN (unique identification number).- Parameters:
zoneUIN
- zone UIN to find- Returns:
- zone object or null
-
getAllZones
Get all accessible zone objects- Returns:
- list of all accessible zone objects
-
findObjectByName
Find object by name. If multiple objects with same name exist, it is not determined what object will be returned. Name comparison is case-insensitive.- Parameters:
name
- object name to find- Returns:
- object with matching name or null
-
findObjectByName
Find object by name with object filter. Name comparison is case-insensitive.- Parameters:
name
- object name to findfilter
- TODO- Returns:
- object with matching name or null
-
findObjectByNamePattern
Find object by name using regular expression. If multiple objects with same name exist, it is not determined what object will be returned. Name comparison is case-insensitive.- Parameters:
pattern
- regular expression for matching object name- Returns:
- object with matching name or null
-
findObject
Generic object find using filter. WIll return first object matching given filter.- Parameters:
filter
- ObjectFilter to filter the result- Returns:
- first matching object or null
-
filterObjects
Find all objects matching given filter.- Parameters:
filter
- ObjectFilter to filter the result- Returns:
- list of matching objects (empty list if nothing found)
-
getTopLevelObjects
Get list of top-level objects matching given object filter. Filter may be null.- Parameters:
objectFilter
- filter for objects- Returns:
- List of all top matching level objects (either without parents or with inaccessible parents)
-
getTopLevelObjects
Get list of top-level objects matching given class filter. Class filter may be null to ignore object class.- Parameters:
classFilter
- To filter the classes- Returns:
- List of all top matching level objects (either without parents or with inaccessible parents)
-
getTopLevelObjects
Get list of top-level objects.- Returns:
- List of all top level objects (either without parents or with inaccessible parents)
-
getAllObjects
Get list of all objects- Returns:
- List of all objects
-
getObjectName
Get object name by ID.- Parameters:
objectId
- object ID- Returns:
- object name if object is known, or string in form [<object_id>] for unknown objects
-
getObjectNameWithAlias
Get object name with alias by ID.- Parameters:
objectId
- object ID- Returns:
- object name with alias if object is known, or string in form [<object_id>] for unknown objects
-
getZoneName
Get zone name by UIN- Parameters:
zoneUIN
- zone UIN- Returns:
- zone name
-
queryObjects
public List<AbstractObject> queryObjects(String query, long rootObjectId) throws IOException, NXCException Query objects on server side, optionally only those located below given root object.- Parameters:
query
- query to executerootObjectId
- root object ID or 0 to query all objects- Returns:
- list of matching objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryObjects
Query objects on server side- Parameters:
query
- query to execute- Returns:
- list of matching objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryObjectDetails
public List<ObjectQueryResult> queryObjectDetails(String query, long rootObjectId, List<String> properties, List<String> orderBy, Map<String, String> inputFields, long contextObjectId, boolean readAllComputedProperties, int limit) throws IOException, NXCExceptionQuery objects on server side and read certain object properties. Available properties are the same as in corresponding NXSL objects or computed properties set using "with" statement in query. IfreadAllComputedProperties
is set totrue
then all computed properties will be retrieved in addition to those explicitly listed. Set of queried objects can be limited to child objects of certain object.- Parameters:
query
- query to executerootObjectId
- ID of root object or 0 to query all objectsproperties
- object properties to readorderBy
- list of properties for ordering result set (can be null)inputFields
- set of input fields provided by user (can be null)contextObjectId
- ID of context object (will be available in query via global variable $context), 0 if nonereadAllComputedProperties
- if set totrue
, query will return all computed properties in addition to properties explicitly listed inproperties
parameterlimit
- limit number of records (0 for unlimited)- Returns:
- list of matching objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getObjectQueries
Get list of configured object queries.- Returns:
- list of configured object queries
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyObjectQuery
Modify object query. If query ID is 0 new query object will be created and assigned ID will be returned.- Parameters:
query
- query to create or modify- Returns:
- assigned query ID
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteObjectQuery
Delete predefined object query.- Parameters:
queryId
- query ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAlarms
Get list of active alarms. For accessing terminated alarms log view API should be used.- Returns:
- Hash map containing alarms
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAlarm
Get information about single active alarm. Terminated alarms cannot be accessed with this call.- Parameters:
alarmId
- alarm ID- Returns:
- alarm object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAlarmEvents
Get information about events related to single active alarm. Information for terminated alarms cannot be accessed with this call. User must have "view alarms" permission on alarm's source node and "view event log" system-wide access.- Parameters:
alarmId
- alarm ID- Returns:
- list of related events
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
acknowledgeAlarm
public void acknowledgeAlarm(long alarmId, boolean sticky, int time) throws IOException, NXCException Acknowledge alarm.- Parameters:
alarmId
- Identifier of alarm to be acknowledged.sticky
- if set to true, acknowledged state will be made "sticky" (duplicate alarms with same key will not revert it back to outstanding)time
- timeout for sticky acknowledge in seconds (0 for infinite)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
acknowledgeAlarm
Acknowledge alarm.- Parameters:
alarmId
- Identifier of alarm to be acknowledged.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
acknowledgeAlarm
Acknowledge alarm by helpdesk reference.- Parameters:
helpdeskReference
- Helpdesk issue reference (e.g. JIRA issue key)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
resolveAlarm
Resolve alarm.- Parameters:
alarmId
- Identifier of alarm to be resolved.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
resolveAlarm
Resolve alarm by helpdesk reference.- Parameters:
helpdeskReference
- Identifier of alarm to be resolved.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
terminateAlarm
Terminate alarm.- Parameters:
alarmId
- Identifier of alarm to be terminated.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
terminateAlarm
Terminate alarm by helpdesk reference.- Parameters:
helpdeskReference
- Identifier of alarm to be resolved.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
bulkResolveAlarms
Bulk terminate alarms.- Parameters:
alarmIds
- Identifiers of alarms to be terminated.- Returns:
- true if all alarms were terminated, false if some, or all, were not terminated
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
bulkTerminateAlarms
Bulk terminate alarms.- Parameters:
alarmIds
- Identifiers of alarms to be terminated.- Returns:
- true if all alarms were terminated, false if some, or all, were not terminated
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteAlarm
Delete alarm.- Parameters:
alarmId
- Identifier of alarm to be deleted.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
openHelpdeskIssue
Open issue in helpdesk system from given alarm- Parameters:
alarmId
- alarm identifier- Returns:
- helpdesk issue identifier
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getHelpdeskIssueUrl
Get URL for helpdesk issue associated with given alarm- Parameters:
alarmId
- The ID of alarm- Returns:
- URL of helpdesk issue
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
unlinkHelpdeskIssue
Unlink helpdesk issue from alarm. User must have OBJECT_ACCESS_UPDATE_ALARMS access right on alarm's source object and SYSTEM_ACCESS_UNLINK_ISSUES system wide access right.- Parameters:
helpdeskReference
- The helpdesk reference- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
unlinkHelpdeskIssue
Unlink helpdesk issue from alarm. User must have OBJECT_ACCESS_UPDATE_ALARMS access right on alarm's source object and SYSTEM_ACCESS_UNLINK_ISSUES system wide access right.- Parameters:
alarmId
- alarm id- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAlarmComments
Get list of comments for given alarm.- Parameters:
alarmId
- alarm ID- Returns:
- list of alarm comments
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteAlarmComment
Delete alarm comment.- Parameters:
alarmId
- alarm IDcommentId
- comment ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createAlarmComment
Create alarm comment.- Parameters:
alarmId
- The alarm IDtext
- The comment text- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createAlarmComment
public void createAlarmComment(String helpdeskReference, String text) throws IOException, NXCException Create alarm comment by helpdesk reference.- Parameters:
helpdeskReference
- The helpdesk referencetext
- The reference text- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateAlarmComment
public void updateAlarmComment(long alarmId, long commentId, String text) throws IOException, NXCException Update alarm comment. If alarmId == 0 — new comment will be created.- Parameters:
alarmId
- alarm IDcommentId
- comment ID or 0 for creating new commenttext
- message text- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setAlarmFlowState
Changes state of alarm status flow. Strict or not - terminate state can be set only after resolve state or after any state.- Parameters:
state
- state of alarm status flow - strict or not (1 or 0)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getServerVariables
Get server configuration variables- Returns:
- The server variables
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPublicServerVariable
Get server public configuration variable- Parameters:
name
- configuration variable name- Returns:
- value of requested configuration variable
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPublicServerVariableAsInt
Get server public configuration variable as a int- Parameters:
name
- configuration variable name- Returns:
- value of requested configuration variable
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPublicServerVariableAsBoolean
Get server public configuration variable as boolen value- Parameters:
name
- configuration variable name- Returns:
- value of requested configuration variable
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setServerVariable
Set server configuration variable- Parameters:
name
- The name of the variablevalue
- The value of the variable- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteServerVariable
Delete server configuration variable- Parameters:
name
- The name of the variable- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setDefaultServerValues
Set server configuration variables to default- Parameters:
varList
- The list of variables- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getServerConfigClob
Get server config CLOB- Parameters:
name
- The name of the config- Returns:
- The config CLOB
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setServerConfigClob
Set server config CLOB- Parameters:
name
- The name to setvalue
- The value to set- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
subscribe
Subscribe to notification channel. Each subscribe call should be matched by unsubscribe call. Calling subscribe on already subscribed channel will increase internal counter, and subscription will be cancelled when this counter returns back to 0.- Parameters:
channel
- Notification channel to subscribe to.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
unsubscribe
Unsubscribe from notification channel.- Parameters:
channel
- Notification channel to unsubscribe from.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncUserDatabase
Synchronize user database and subscribe to user change notifications- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
subscribeToUserDBUpdates
Subscribe to user change notifications- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncUserSet
Synchronize users by id if does not exist- Parameters:
users
- list of user id's to synchronize- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncMissingUsers
Synchronize only objects that were not yet synchronized- Parameters:
users
- set of user IDs to sync- Returns:
- true if synchronization was completed and false if synchronization is not needed
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
isUserDatabaseSynchronized
public boolean isUserDatabaseSynchronized()Check if user database is synchronized with client- Returns:
- true if user database is synchronized with client
-
findUserDBObjectsByIds
Find multiple users by list of IDs- Parameters:
ids
- of user DBObjects to find- Returns:
- list of found users
-
findUserDBObjectById
Find user or group by ID. If full user database synchronization was not done this method may return null for existing user that is not yet synchronized with the client. In such case client library will initiate background synchronization of that user object. If provided callback is not null it will be executed when synchronization is complete.- Parameters:
id
- The user database object IDcallback
- synchronization completion callback (may be null)- Returns:
- User object with given ID or null if such user does not exist or not synchronized with client.
-
findUserDBObjectByGUID
Find user or group by GUID- Parameters:
guid
- The user DBObject GUID- Returns:
- User object with given GUID or null if such user does not exist
-
getUserDatabaseObjects
Get list of all user database objects- Returns:
- List of all user database objects
-
createUser
Create user on server- Parameters:
name
- Login name for new user- Returns:
- ID assigned to newly created user
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createUserGroup
Create user group on server- Parameters:
name
- Name for new user group- Returns:
- ID assigned to newly created user group
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteUserDBObject
Delete user or group on server- Parameters:
id
- User or group ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setUserPassword
public void setUserPassword(int id, String newPassword, String oldPassword) throws IOException, NXCException Set password for user- Parameters:
id
- User IDnewPassword
- New passwordoldPassword
- Old password- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
validateUserPassword
Validate password for currently logged in user- Parameters:
password
- password to validate- Returns:
- true if password is valid
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyUserDBObject
public void modifyUserDBObject(AbstractUserObject object, int fields) throws IOException, NXCException Modify user database object- Parameters:
object
- User datafields
- bit mask indicating fields to modify- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyUserDBObject
Modify user database object- Parameters:
object
- User data- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
detachUserFromLdap
Detach user from LDAP- Parameters:
userId
- user ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setAttributeForCurrentUser
Set custom attribute for currently logged in user. Server will allow to change only attributes whose name starts with dot.- Parameters:
name
- Attribute's namevalue
- New attribute's value- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAttributeForCurrentUser
Get custom attribute for currently logged in user. If attribute is not set, empty string will be returned.- Parameters:
name
- Attribute's name- Returns:
- Attribute's value
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
findMatchingDCI
public List<DciValue> findMatchingDCI(long objectId, String objectName, String dciName, int flags) throws IOException, NXCException Find all DCIs matching given creteria.- Parameters:
objectId
- if specific object needed (set to 0 if match by object name is needed)objectName
- regular expression to match object name (not used if object ID is not 0)dciName
- regular expression to match DCI nameflags
- find flags- Returns:
- list of all found DCIs and their last values
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getLastValues
public DciValue[] getLastValues(long nodeId, boolean objectTooltipOnly, boolean overviewOnly, boolean includeNoValueObjects) throws IOException, NXCException Get last DCI values for given node- Parameters:
nodeId
- ID of the node to get DCI values forobjectTooltipOnly
- if set to true, only DCIs with DCF_SHOW_ON_OBJECT_TOOLTIP flag set are returnedoverviewOnly
- if set to true, only DCIs with DCF_SHOW_IN_OBJECT_OVERVIEW flag set are returnedincludeNoValueObjects
- if set to true, objects with no value (like instance discovery DCIs) will be returned as well- Returns:
- List of DCI values
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getLastValues
public DciValue[] getLastValues(long nodeId, long mapId, boolean objectTooltipOnly, boolean overviewOnly, boolean includeNoValueObjects) throws IOException, NXCException Get last DCI values for given node- Parameters:
nodeId
- ID of the node to get DCI values forobjectTooltipOnly
- if set to true, only DCIs with DCF_SHOW_ON_OBJECT_TOOLTIP flag set are returnedoverviewOnly
- if set to true, only DCIs with DCF_SHOW_IN_OBJECT_OVERVIEW flag set are returnedincludeNoValueObjects
- if set to true, objects with no value (like instance discovery DCIs) will be returned as well- Returns:
- List of DCI values
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getLastValues
Get last DCI values for given node- Parameters:
nodeId
- ID of the node to get DCI values for- Returns:
- List of DCI values
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getTooltipLastValues
public Map<Long,DciValue[]> getTooltipLastValues(Set<Long> nodeList) throws IOException, NXCException Get tooltip last values for all objects- Parameters:
nodeList
- list of node IDs- Returns:
- map with node id to DCI last values
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getLastValues
Get last DCI values for given Map DCI Instance list- Parameters:
mapDcis
- List with Map DCI Instances- Returns:
- List of DCI values
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getLastValues
Get last DCI values for given Single Dci Config list- Parameters:
dciConfig
- List with Single Dci Configs- Returns:
- List of DCI values
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getActiveThresholds
public List<Threshold> getActiveThresholds(List<SingleDciConfig> dciConfig) throws IOException, NXCException Get active thresholds- Parameters:
dciConfig
- Dci config- Returns:
- list of active thresholds
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getTableLastValues
Get last value for given table DCI on given node- Parameters:
nodeId
- ID of the node to get DCI values fordciId
- DCI ID- Returns:
- Table object with last values for table DCI
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDciLastValue
Get last value for given table or single valued DCI on given node- Parameters:
nodeId
- ID of the node to get DCI values fordciId
- DCI ID- Returns:
- Last value object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPerfTabItems
Get list of DCIs configured to be shown on performance tab in console for given node.- Parameters:
nodeId
- Node object ID- Returns:
- List of performance tab DCIs
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getThresholdSummary
public List<ThresholdViolationSummary> getThresholdSummary(long objectId) throws IOException, NXCException Get threshold violation summary for all nodes under given parent object. Parent object could be container, subnet, zone, entire network, or infrastructure service root.- Parameters:
objectId
- parent object ID- Returns:
- list of threshold violation summary objects for all nodes below given root
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
parseDataRows
Parse data from raw message CMD_DCI_DATA. This method is intended for calling by client internal methods only. It made public to allow access from client extensions.- Parameters:
input
- Raw datadata
- Data object to add rows to- Returns:
- number of received data rows
-
getCollectedData
public DciData getCollectedData(long nodeId, long dciId, Date from, Date to, int maxRows, HistoricalDataType valueType) throws IOException, NXCException Get collected DCI data from server. Please note that you should specify either row count limit or time from/to limit.- Parameters:
nodeId
- Node IDdciId
- DCI IDfrom
- Start of time range or null for no limitto
- End of time range or null for no limitmaxRows
- Maximum number of rows to retrieve or 0 for no limitvalueType
- TODO- Returns:
- DCI data set
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getCollectedTableData
public DciData getCollectedTableData(long nodeId, long dciId, String instance, String dataColumn, Date from, Date to, int maxRows) throws IOException, NXCException Get collected table DCI data from server. Please note that you should specify either row count limit or time from/to limit.- Parameters:
nodeId
- Node IDdciId
- DCI IDinstance
- instance valuedataColumn
- name of column to retrieve data fromfrom
- Start of time range or null for no limitto
- End of time range or null for no limitmaxRows
- Maximum number of rows to retrieve or 0 for no limit- Returns:
- DCI data set
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
clearCollectedData
Clear collected data for given DCI- Parameters:
nodeId
- Node object IDdciId
- DCI ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteDciEntry
public void deleteDciEntry(long nodeId, long dciId, long timestamp) throws IOException, NXCException Delete collected data entry for given DCI- Parameters:
nodeId
- Node object IDdciId
- DCI IDtimestamp
- timestamp of entry- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
recalculateDCIValues
Start recalculation of DCI values using preserver raw values.- Parameters:
objectId
- object IDdciId
- DCI ID- Returns:
- assigned job ID
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
forceDCIPoll
Force DCI poll for given DCI- Parameters:
nodeId
- Node object IDdciId
- DCI ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getThresholds
Get list of thresholds configured for given DCI- Parameters:
nodeId
- Node object IDdciId
- DCI ID- Returns:
- List of configured thresholds
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
dciIdsToNames
public Map<Long,DciInfo> dciIdsToNames(List<Long> nodeIds, List<Long> dciIds) throws IOException, NXCException Get names for given DCI list- Parameters:
nodeIds
- node identifiersdciIds
- DCI identifiers (length must match length of node identifiers list)- Returns:
- array of resolved DCI names
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
dciIdsToNames
public Map<Long,DciInfo> dciIdsToNames(Collection<? extends NodeItemPair> itemList) throws IOException, NXCException Get names for given DCI list- Parameters:
itemList
- list of items to resolved- Returns:
- map of DCI id to DCI description
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
dciNameToId
Get DCI ID for given DCI name- Parameters:
nodeId
- node object identifierdciName
- DCI name- Returns:
- id of DCI with given name
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryParameter
public String queryParameter(long nodeId, DataOrigin origin, String name) throws IOException, NXCException Query parameter immediately. This call will cause server to do actual call to managed node and will return current value for given parameter. Result is not cached.- Parameters:
nodeId
- node object IDorigin
- parameter's origin (NetXMS agent, SNMP, etc.)name
- parameter's name- Returns:
- current parameter's value
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryAgentTable
Query agent's table immediately. This call will cause server to do actual call to managed node and will return current value for given table. Result is not cached.- Parameters:
nodeId
- node object IDname
- table's name- Returns:
- current table's value
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createCustomObject
Hook method to allow adding of custom object creation data to NXCP message. Default implementation does nothing.- Parameters:
data
- object creation data passed to createObjectuserData
- user-defined data for object creation passed to createObjectmsg
- NXCP message that will be sent to server
-
createObject
public long createObject(NXCObjectCreationData data, Object userData) throws IOException, NXCException Create new NetXMS object.- Parameters:
data
- Object creation datauserData
- User-defined data for custom object creation- Returns:
- ID of new object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createObject
Create new NetXMS object. Equivalent of calling createObject(data, null).- Parameters:
data
- Object creation data- Returns:
- ID of new object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createObjectSync
Create new NetXMS object in synchronous mode.- Parameters:
data
- Object creation data- Returns:
- newly created AbstractObject
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createObjectAsync
public long createObjectAsync(NXCObjectCreationData data, ObjectCreationListener callback) throws IOException, NXCException Create new NetXMS object and run callback once it's created.- Parameters:
data
- Object creation datacallback
- callback to run on object creation- Returns:
- ID of new object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteObject
Delete object- Parameters:
objectId
- ID of an object which should be deleted- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyCustomObject
Hook method to populate NXCP message with custom object's data on object modification. Default implementation does nothing.- Parameters:
data
- object modification data passed to modifyObjectuserData
- user-defined data passed to modifyObjectmsg
- NXCP message to be sent to server
-
modifyObject
public void modifyObject(NXCObjectModificationData data, Object userData) throws IOException, NXCException Modify object (generic interface, in most cases wrapper functions should be used instead).- Parameters:
data
- Object modification datauserData
- user-defined data for custom object modification- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyObject
Modify object (generic interface, in most cases wrapper functions should be used instead). Equivalent of calling modifyObject(data, null).- Parameters:
data
- Object modification data- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setObjectName
Change object's name (wrapper for modifyObject())- Parameters:
objectId
- ID of object to be changedname
- New object's name- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setObjectCustomAttributes
public void setObjectCustomAttributes(long objectId, Map<String, CustomAttribute> attrList) throws IOException, NXCExceptionChange object's custom attributes (wrapper for modifyObject())- Parameters:
objectId
- The object IDattrList
- The attribute list- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setObjectACL
public void setObjectACL(long objectId, Collection<AccessListElement> acl, boolean inheritAccessRights) throws IOException, NXCException Change object's ACL (wrapper for modifyObject())- Parameters:
objectId
- The object idacl
- The AccessListElementsinheritAccessRights
- true if access rights should be inherited- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
enableAnonymousObjectAccess
Enable anonymous access to object. Server will add read access right for user "anonymous" and issue authentication token for that user. Authentication token will be returned by this call and can be used for anonymous login.- Parameters:
objectId
- object ID- Returns:
- authentication token for anonymous access
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
changeObjectZone
Move object to different zone. Only nodes and clusters can be moved between zones.- Parameters:
objectId
- Node or cluster object IDzoneUIN
- The zone UIN (unique identification number)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateObjectComments
Change object's comments.- Parameters:
objectId
- Object's IDcomments
- New comments- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateResponsibleUsers
public void updateResponsibleUsers(long objectId, List<ResponsibleUser> users) throws IOException, NXCException Update list of responsible users for given object.- Parameters:
objectId
- Object's IDusers
- New list of responsible users- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setObjectManaged
Set object's managed status.- Parameters:
objectId
- object's identifierisManaged
- object's managed status- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getEffectiveRights
Get effective rights of currently logged in user to given object.- Parameters:
objectId
- The object ID- Returns:
- The effective rights
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
bindObject
Bind object.- Parameters:
parentId
- parent object's identifierchildId
- Child object's identifier- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
unbindObject
Unbind object.- Parameters:
parentId
- parent object's identifierchildId
- Child object's identifier- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
removeTemplate
public void removeTemplate(long templateId, long nodeId, boolean removeDci) throws IOException, NXCException Remove data collection template from node.- Parameters:
templateId
- template object identifiernodeId
- node object identifierremoveDci
- true if DCIs created from this template should be removed- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
applyTemplate
Apply data collection template to node.- Parameters:
templateId
- template object IDnodeId
- node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
addClusterNode
Add node to cluster.- Parameters:
clusterId
- cluster object IDnodeId
- node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
removeClusterNode
Remove node from cluster.- Parameters:
clusterId
- cluster object IDnodeId
- node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryLayer2Topology
Query layer 2 topology for node- Parameters:
nodeId
- The node ID- Returns:
- network map page representing layer 2 topology
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryOSPFTopology
Query OSPF topology for node- Parameters:
nodeId
- The node ID- Returns:
- network map page representing OSPF topology
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryInternalConnectionTopology
Query internal connection topology for node- Parameters:
nodeId
- The node ID- Returns:
- network map page representing internal communication topology
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeActionWithExpansion
public String executeActionWithExpansion(long nodeId, long alarmId, String action, Map<String, String> inputValues, List<String> maskedFields) throws IOException, NXCExceptionExecute action on remote agent- Parameters:
nodeId
- Node object IDalarmId
- Alarm ID (used for macro expansion)action
- Action with all arguments, that will be expanded and splitted on server sideinputValues
- Input values provided by user for expansionmaskedFields
- List if input fields whose content should be masked (can be null)- Returns:
- Expanded action name
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeActionWithExpansion
public String executeActionWithExpansion(long nodeId, long alarmId, String action, boolean receiveOutput, Map<String, String> inputValues, List<String> maskedFields, TextOutputListener listener, Writer writer) throws IOException, NXCExceptionExecute action on remote agent- Parameters:
nodeId
- Node object IDalarmId
- Alarm ID (used for macro expansion)action
- Action with all arguments, that will be expanded and splitted on server sideinputValues
- Input values provided by user for expansionmaskedFields
- List if input fields whose content should be masked (can be null)receiveOutput
- true if action's output has to be readlistener
- listener for action's output or nullwriter
- writer for action's output or null- Returns:
- Expanded action name
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeAction
public void executeAction(long nodeId, String action, String[] args) throws IOException, NXCException Execute action on remote agent- Parameters:
nodeId
- Node object IDaction
- Action nameargs
- Action arguments- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeAction
public void executeAction(long nodeId, String action, String[] args, boolean receiveOutput, TextOutputListener listener, Writer writer) throws IOException, NXCException Execute action on remote agent- Parameters:
nodeId
- Node object IDaction
- Action nameargs
- Action argumentsreceiveOutput
- true if action's output has to be readlistener
- listener for action's output or nullwriter
- writer for action's output or null- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeSshCommand
public void executeSshCommand(long nodeId, long alarmId, String command, Map<String, String> inputFields, List<String> maskedFields, boolean receiveOutput, TextOutputListener listener, Writer writer) throws IOException, NXCExceptionExecute SSH command on remote agent- Parameters:
nodeId
- Node object IDalarmId
- Alarm ID (0 if not executed in alarm context)command
- Command to executeinputFields
- Input fields provided by user or nullmaskedFields
- List of input field names for which values should be masked (can be null)receiveOutput
- true if command's output has to be readlistener
- listener for command's output or nullwriter
- writer for command's output or null- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
wakeupNode
Wakeup node by sending wake-on-LAN magic packet. Either node ID or interface ID may be given. If node ID is given, system will send wakeup packets to all active interfaces with IP address.- Parameters:
objectId
- node or interface ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNodePhysicalComponents
Get node's physical components (obtained from ENTITY-MIB).- Parameters:
nodeId
- node object identifier- Returns:
- root component
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDeviceView
Get device view for node.- Parameters:
nodeId
- node object identifier- Returns:
- device view object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNodeWinPerfObjects
Get list of available Windows performance objects. Returns empty list if node does is not a Windows node or does not have WinPerf subagent installed.- Parameters:
nodeId
- node object ID- Returns:
- list of available Windows performance objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNodeSoftwarePackages
Get list of software packages installed on node.- Parameters:
nodeId
- node object identifier- Returns:
- root component
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNodeHardwareComponents
public List<HardwareComponent> getNodeHardwareComponents(long nodeId) throws IOException, NXCException Get list of hardware components as reported by agent.- Parameters:
nodeId
- node object identifier- Returns:
- list of hardware components
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getUserSessions
Get list of user sessions on given node as reported by agent.- Parameters:
nodeId
- node object identifier- Returns:
- list of user sessions
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDependentNodes
Get list of dependent nodes for given node. Node is considered dependent if it use given node as any type of proxy or as data collection source for at least one DCI.- Parameters:
nodeId
- node object ID- Returns:
- list of dependent node descriptors
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getServerJobList
Get list of server jobs- Returns:
- list of server jobs
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
cancelServerJob
Cancel server job- Parameters:
jobId
- Job ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
holdServerJob
Put server job on hold- Parameters:
jobId
- Job ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
unholdServerJob
Put server on hold job to pending state- Parameters:
jobId
- Job ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getBackgroundTaskState
Get state of background task.- Parameters:
taskId
- Task ID- Returns:
- state of background task
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deployAgentPolicy
Deploy policy on agent- Parameters:
policyId
- Policy object IDnodeId
- Node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
uninstallAgentPolicy
Uninstall policy from agent- Parameters:
policyId
- Policy object IDnodeId
- Node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getEventProcessingPolicy
Get read-only copy of event processing policy.- Returns:
- Event processing policy
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
openEventProcessingPolicy
Open event processing policy for editing. This call will lock event processing policy on server until closeEventProcessingPolicy called or session terminated.- Returns:
- Event processing policy
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
saveEventProcessingPolicy
Save event processing policy. If policy was not previously open by current session exception will be thrown.- Parameters:
epp
- Modified event processing policy- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
closeEventProcessingPolicy
Close event processing policy. This call will unlock event processing policy on server. If policy was not previously open by current session exception will be thrown.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
openDataCollectionConfiguration
public DataCollectionConfiguration openDataCollectionConfiguration(long nodeId) throws IOException, NXCException Open data collection configuration for given node. You must call DataCollectionConfiguration.close() to close data collection configuration when it is no longer needed.- Parameters:
nodeId
- Node object identifier- Returns:
- Data collection configuration object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
openDataCollectionConfiguration
public DataCollectionConfiguration openDataCollectionConfiguration(long nodeId, RemoteChangeListener changeListener) throws IOException, NXCException Open data collection configuration for given node. You must call DataCollectionConfiguration.close() to close data collection configuration when it is no longer needed.- Parameters:
nodeId
- Node object identifierchangeListener
- callback that will be called when DCO object is changed by server notification- Returns:
- Data collection configuration object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyDataCollectionObject
public long modifyDataCollectionObject(DataCollectionObject dcObject) throws IOException, NXCException Modify data collection object without opening data collection configuration.- Parameters:
dcObject
- dcObject collection object- Returns:
- Identifier assigned to newly created object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
clearAgentDataCollectionConfiguration
Clear data collection configuration on agent. Will wipe out all configuration and collected data.- Parameters:
nodeId
- node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
changeDCIStatus
public long[] changeDCIStatus(long ownerId, long[] items, int status) throws IOException, NXCException Change data collection objects status without opening data collection configuration.- Parameters:
ownerId
- DCI owneritems
- items to changestatus
- new status- Returns:
- return code for each DCI
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
resyncAgentDataCollectionConfiguration
Force re-synchronization of data collection configuration with agent.- Parameters:
nodeId
- node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
testTransformationScript
public TransformationTestResult testTransformationScript(long nodeId, String script, String inputValue, DataCollectionObject dcObject) throws IOException, NXCException Test DCI transformation script.- Parameters:
nodeId
- ID of the node object to test script onscript
- script source codeinputValue
- input value for the scriptdcObject
- optional data collection object data (for $dci variable in script)- Returns:
- test execution results
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeLibraryScript
public void executeLibraryScript(long nodeId, String script, Map<String, String> inputFields, List<String> maskedFields, TextOutputListener listener) throws IOException, NXCExceptionExecute library script on object. Script name interpreted as command line with server-side macro substitution. Map inputValues can be used to pass data for %() macros.- Parameters:
nodeId
- node ID to execute script onscript
- script name and parametersinputFields
- input values map for %() macro substitution (can be null)maskedFields
- List of input field names for which values should be masked (can be null)listener
- script output listener- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeLibraryScript
public void executeLibraryScript(long objectId, long alarmId, String script, Map<String, String> inputFields, List<String> maskedFields, TextOutputListener listener) throws IOException, NXCExceptionExecute library script on object. Script name interpreted as command line with server-side macro substitution. Map inputValues can be used to pass data for %() macros.- Parameters:
objectId
- ID of the object to execute script onalarmId
- alarm ID to use for expansionscript
- script name and parametersinputFields
- input values map for %() macro substitution (can be null)maskedFields
- List of input field names for which values should be masked (can be null)listener
- script output listener- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeScript
public void executeScript(long objectId, String script, String parameters, TextOutputListener listener) throws IOException, NXCException Execute script.- Parameters:
objectId
- ID of the object to execute script onscript
- script source codelistener
- script output listenerparameters
- script parameter list (can be null)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeScript
public void executeScript(long objectId, String script, String parameters, TextOutputListener listener, boolean developmentMode) throws IOException, NXCException Execute script.- Parameters:
objectId
- ID of the object to execute script onscript
- script source codelistener
- script output listenerparameters
- script parameter list (can be null)developmentMode
- true if script should be run in development mode- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeScript
public void executeScript(long objectId, String script, List<String> parameterList, TextOutputListener listener) throws IOException, NXCException Execute script.- Parameters:
objectId
- ID of the object to execute script onscript
- script source codeparameterList
- script parameter list (can be null)listener
- script output listener- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeScript
public void executeScript(long objectId, String script, List<String> parameterList, TextOutputListener listener, boolean developmentMode) throws IOException, NXCException Execute script.- Parameters:
objectId
- ID of the object to execute script onscript
- script source codeparameterList
- script parameter list (can be null)listener
- script output listenerdevelopmentMode
- true if script should be run in development mode- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
stopScript
Stop running NXSL script. VM identifier is provided via output listener's methodsetStreamId
.- Parameters:
vmId
- NXSL VM identifier- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryScript
public Map<String,String> queryScript(long nodeId, String script, List<String> parameterList, TextOutputListener listener) throws IOException, NXCException Execute script and get return value as map. Content of returned map depends on actual data type of script return value:- For hash map matching map will be returned;
- For array all elements will be returned as values and keys will be element positions starting as 1;
- For all other types map will consist of single element with key "1" and script return value as value.
- Parameters:
nodeId
- ID of the node object to test script onscript
- script source codeparameterList
- script parameter list can be nulllistener
- script output listener- Returns:
- script return value as a map
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
compileScript
public ScriptCompilationResult compileScript(String source, boolean serialize) throws IOException, NXCException Compile NXSL script on server. Field *success* in compilation result object will indicate compilation status. If compilation fails, field *errorMessage* will contain compilation error message.- Parameters:
source
- script sourceserialize
- flag to indicate if compiled script should be serialized and sent back to client- Returns:
- script compilation result object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
openServerLog
Open server log by name.- Parameters:
logName
- Log name- Returns:
- Log object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAlarmCategories
Get alarm categories from server- Returns:
- List of configured alarm categories
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyAlarmCategory
Add or update alarm category in DB- Parameters:
object
- alarm category- Returns:
- The ID of the category
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteAlarmCategory
Delete alarm category in DB- Parameters:
id
- of alarm category- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncAlarmCategories
Synchronize alarm category configuration. After call to this method session object will maintain internal list of configured alarm categories- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
isAlarmCategoriesSynchronized
public boolean isAlarmCategoriesSynchronized()Check if alarm categories are synchronized.- Returns:
- true if if alarm categories are synchronized
-
findAlarmCategoryById
Find alarm category by id in alarm category database internally maintained by session object. You must call NXCSession.syncAlarmCategories() first to make local copy of event template database.- Parameters:
id
- alarm category id- Returns:
- Event template object or null if not found
-
findAlarmCategoryByName
Find alarm category by name in alarm category database internally maintained by session object. You must call NXCSession.syncAlarmCategories() first to make local copy of event template database.- Parameters:
name
- alarm category name- Returns:
- alarm category with given name or null if not found
-
findMultipleAlarmCategories
Find multiple alarm categories by category id`s in alarm category database internally maintained by session object. You must call NXCSession.syncAlarmCategories() first to make local copy of alarm category database.- Parameters:
ids
- List of alarm category id`s- Returns:
- List of found alarm categories
-
isEventObjectsSynchronized
public boolean isEventObjectsSynchronized()Check if event configuratrion objects are synchronized.- Returns:
- true if event configuratrion objects are synchronized
-
syncEventTemplates
Synchronize event templates configuration. After call to this method session object will maintain internal list of configured event templates.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getCachedEventTemplates
Get cached list event templates- Returns:
- List of event templates cached by client library
-
findEventTemplateByName
Find event template by name in event template database internally maintained by session object. You must call NXCSession.syncEventObjects() first to make local copy of event template database.- Parameters:
name
- Event name- Returns:
- Event template object or null if not found
-
getEventName
Get event name from event code- Parameters:
code
- event code- Returns:
- event name or event code as string if event not found
-
findEventTemplateByCode
Find event template by code in event template database internally maintained by session object. You must call NXCSession.syncEventObjects() first to make local copy of event template database.- Parameters:
code
- Event code- Returns:
- Event template object or null if not found
-
findMultipleEventTemplates
Find multiple event templates by event codes in event template database internally maintained by session object. You must callNXCSession.syncEventObjects()
first to make local copy of event template database.- Parameters:
codes
- set of event codes- Returns:
- List of found event templates
-
findMultipleEventTemplates
Find multiple event templates by event codes in event template database internally maintained by session object. You must call NXCSession.syncEventObjects() first to make local copy of event template database.- Parameters:
codes
- List of event codes- Returns:
- List of found event templates
-
getEventTemplates
Get event objects from server- Returns:
- List of configured event objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
generateEventCode
Generate code for new event template.- Returns:
- Code for new event template
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteEventTemplate
Delete event template.- Parameters:
eventCode
- Event code- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyEventObject
Modify event template.- Parameters:
tmpl
- Event template- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
sendEvent
public void sendEvent(long eventCode, String eventName, long objectId, String[] parameters, String userTag, Date originTimestamp) throws IOException, NXCException Send event to server. Event can be identified either by event code or event name. If event name is given, event code will be ignored.Node: sending events by name supported by server version 1.1.8 and higher.
- Parameters:
eventCode
- event code. Ignored if event name is not null.eventName
- event name. Must be set to null if event identified by code.objectId
- Object ID to send event on behalf of. If set to 0, server will determine object ID by client IP address.parameters
- event's parametersuserTag
- event's user tagoriginTimestamp
- origin timestamp or null- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
sendEvent
Convenience wrapper for sendEvent interface.- Parameters:
eventCode
- event codeparameters
- event's parameters- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
sendEvent
Convenience wrapper for sendEvent interface.- Parameters:
eventName
- event nameparameters
- event's parameters- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSnmpCommunities
Get list of well-known SNMP communities configured on server.- Returns:
- map of SNMP community strings
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSnmpCommunities
Get list of well-known SNMP communities configured on server.- Parameters:
zoneUIN
- Zone UIN (unique identification number)- Returns:
- list of SNMP community strings
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateSnmpCommunities
public void updateSnmpCommunities(int zoneUIN, List<String> communityStrings) throws IOException, NXCException Update list of well-known SNMP community strings on server. Existing list will be replaced by provided one.- Parameters:
zoneUIN
- Zone UIN (unique identification number)communityStrings
- New list of SNMP community strings- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSnmpUsmCredentials
public Map<Integer,List<SnmpUsmCredential>> getSnmpUsmCredentials() throws IOException, NXCExceptionGet list of well-known SNMP USM (user security model) credentials configured on server.- Returns:
- Map of SNMP USM credentials
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSnmpUsmCredentials
Get list of well-known SNMP USM (user security model) credentials configured on server.- Parameters:
zoneUIN
- Zone UIN (unique identification number)- Returns:
- List of configured SNMP USM credentials
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateSnmpUsmCredentials
public void updateSnmpUsmCredentials(int zoneUIN, List<SnmpUsmCredential> usmCredentials) throws IOException, NXCException Update list of well-known SNMP USM credentials on server. Existing list will be replaced by provided one.- Parameters:
zoneUIN
- Zone UIN (unique identification number)usmCredentials
- List of SNMP credentials- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSshCredentials
Get SSH credentials for all zones.- Returns:
- list of SSH credentials for all zones
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSshCredentials
Get SSH credentials for specific zone.- Parameters:
zoneUIN
- zone UIN- Returns:
- list of SSH credentials for specific zone
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateSshCredentials
public void updateSshCredentials(int zoneUIN, List<SSHCredentials> sshCredentials) throws IOException, NXCException Update list of well-known SSH credentials on the server. Existing list will be replaced by the provided one.- Parameters:
zoneUIN
- Zone UIN (unique identification number)sshCredentials
- List of SSH credentials- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
readAgentConfigurationFile
Get agent's master configuration file.- Parameters:
nodeId
- Node ID- Returns:
- Master configuration file of agent running on given node
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
writeAgentConfigurationFile
public void writeAgentConfigurationFile(long nodeId, String config, boolean apply) throws IOException, NXCException Update agent's master configuration file.- Parameters:
nodeId
- Node IDconfig
- New configuration file contentapply
- Apply flag - if set to true, agent will restart automatically to apply changes- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSupportedParameters
public List<AgentParameter> getSupportedParameters(long nodeId, DataOrigin origin) throws IOException, NXCException Get list of parameters supported by entity defined by origin on given node.- Parameters:
nodeId
- Node IDorigin
- data origin (agent, driver, etc.)- Returns:
- List of parameters supported by agent
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSupportedParameters
Get list of parameters supported by agent running on given node.- Parameters:
nodeId
- Node ID- Returns:
- List of parameters supported by agent
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSupportedTables
Get list of tables supported by agent running on given node.- Parameters:
nodeId
- Node ID- Returns:
- List of tables supported by agent
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getRelatedEvents
Get all events used in data collection by given node, cluster, or template object.- Parameters:
objectId
- node, cluster, or template object ID- Returns:
- list of used event codes
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDataCollectionScripts
Get names of all scripts used in data collection by given node, cluster, or template object.- Parameters:
objectId
- node, cluster, or template object ID- Returns:
- list of used library scripts
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
exportConfiguration
public String exportConfiguration(String description, long[] events, long[] traps, long[] templates, UUID[] rules, long[] scripts, long[] objectTools, long[] dciSummaryTables, long[] actions, long[] webServices, String[] assetAttributes) throws IOException, NXCException Export server configuration. Returns requested configuration elements exported into XML.- Parameters:
description
- Description of exported configurationevents
- List of event codestraps
- List of trap identifierstemplates
- List of template object identifiersrules
- List of event processing rule GUIDsscripts
- List of library script identifiersobjectTools
- List of object tool identifiersdciSummaryTables
- List of DCI summary table identifiersactions
- List of action codeswebServices
- List of web service definition id'sassetAttributes
- List of asset management atributes to be exported- Returns:
- resulting XML document
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
importConfiguration
Import server configuration (events, traps, thresholds) from XML document.- Parameters:
config
- Configuration in XML formatflags
- Import flags- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
importConfiguration
Import server configuration (events, traps, thresholds) from XML file.- Parameters:
configFile
- Configuration file in XML formatflags
- Import flags- Returns:
- Import output messages
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getServerStats
Get server stats. Returns set of named properties. The following properties could be found in result set: String: VERSION Integer: UPTIME, SESSION_COUNT, DCI_COUNT, OBJECT_COUNT, NODE_COUNT, PHYSICAL_MEMORY_USED, VIRTUAL_MEMORY_USED, QSIZE_CONDITION_POLLER, QSIZE_CONF_POLLER, QSIZE_DCI_POLLER, QSIZE_DBWRITER, QSIZE_EVENT, QSIZE_DISCOVERY, QSIZE_NODE_POLLER, QSIZE_ROUTE_POLLER, QSIZE_STATUS_POLLER, QSIZE_DCI_CACHE_LOADER, ALARM_COUNT long[]: ALARMS_BY_SEVERITY- Returns:
- Server stats as set of named properties.
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getActions
Get list of configured actions from server- Returns:
- List of configured actions
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createAction
Create new server action.- Parameters:
name
- action name- Returns:
- ID assigned to new action
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyAction
Modify server action- Parameters:
action
- Action object- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteAction
Delete server action- Parameters:
actionId
- Action ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getObjectTools
Get list of configured object tools- Returns:
- List of object tools
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createToolTree
Create object tool tree- Parameters:
tools
- list of object tools- Returns:
- the root folder of the tree
-
getObjectToolsAsTree
- Returns:
- root object tool folder
- Throws:
IOException
- if socker or file I/O error occoursNXCException
- if NetXMS server returns an error or operation was timed out
-
getObjectToolDetails
Get object tool details- Parameters:
toolId
- Tool ID- Returns:
- Object tool details
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
generateObjectToolId
Generate unique ID for new object tool.- Returns:
- Unique ID for object tool
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyObjectTool
Modify object tool.- Parameters:
tool
- Object tool- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteObjectTool
Delete object tool.- Parameters:
toolId
- Object tool ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
enableObjectTool
Enable or disable object tool/- Parameters:
toolId
- Object tool IDenable
- true if object tool should be enabled, false if it should be disabled- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeTableTool
Execute object tool of "table" type against given node.- Parameters:
toolId
- Tool IDnodeId
- Node object ID- Returns:
- Table with tool execution results
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeServerCommand
public void executeServerCommand(long objectId, long alarmId, String command, Map<String, String> inputFields, List<String> maskedFields) throws IOException, NXCExceptionExecute server command related to given object (usually defined as object tool)- Parameters:
objectId
- object IDalarmId
- Alarm ID (0 if executed outside alarm context)command
- commandinputFields
- values for input fields (can be null)maskedFields
- List if input fields whose content should be masked (can be null)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeServerCommand
public void executeServerCommand(long objectId, long alarmId, String command, Map<String, String> inputFields, List<String> maskedFields, boolean receiveOutput, TextOutputListener listener, Writer writer) throws IOException, NXCExceptionExecute server command related to given object (usually defined as object tool)- Parameters:
objectId
- object IDalarmId
- Alarm ID (0 if executed outside alarm context)command
- commandinputFields
- values for input fields (can be null)maskedFields
- List if input fields whose content should be masked (can be null)receiveOutput
- true if command's output has to be readlistener
- listener for command's output or nullwriter
- writer for command's output or null- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
stopServerCommand
Stop server command- Parameters:
commandId
- The command ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSnmpTrapsConfigurationSummary
Get summary of SNMP trap mapping. Trap configurations returned without parameter mapping.- Returns:
- List of SnmpTrap objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSnmpTrapsConfiguration
Get list of configured SNMP traps- Returns:
- List of configured SNMP traps.
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createSnmpTrapConfiguration
Create new trap configuration record.- Returns:
- ID of new record
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteSnmpTrapConfiguration
Delete SNMP trap configuration record from server.- Parameters:
trapId
- Trap configuration record ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifySnmpTrapConfiguration
Modify SNMP trap configuration record.- Parameters:
trap
- Modified trap configuration record- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getMibFileTimestamp
Get timestamp of server's MIB file.- Returns:
- Timestamp of server's MIB file
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
downloadMibFile
Download MIB file from server.- Returns:
- file handle for temporary file on local file system
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPredefinedGraph
Get predefined graph information by graph id- Parameters:
graphId
- graph id- Returns:
- predefined chart object
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPredefinedGraphs
public List<GraphDefinition> getPredefinedGraphs(boolean graphTemplates) throws IOException, NXCException Get list of predefined graphs or graph templates- Parameters:
graphTemplates
- defines if non template or template graph list should re requested- Returns:
- message with predefined graphs or with template graphs
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createGraphTree
Create graph tree from list- Parameters:
graphs
- list of predefined graphs- Returns:
- graph tree
-
getPredefinedGraphsAsTree
- Returns:
- root graph folder
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
saveGraph
Checks if graph with specified name can be created/overwritten and creates/overwrites it in DB. If graph id is set to 0 it checks if graph with the same name exists, and if yes checks overwrite parameter. If it is set to false, then function returns error that graph with this name already exists. If there is no graph with the same name it just creates a new one. If id is set it checks that provided name is assigned only to this graph and overwrites it or throws error is the same name was already used. Also check if user have permissions to overwrite graph.If it can, then it returns 1. If graph with this name already exists, but can be overwritten by current user function returns 2. If graph with this name already exists, but can not be overwritten by current user function returns 0.
- Parameters:
graph
- predefined graph configurationoverwrite
- defines if existing graph should be overwritten- Returns:
- ID of predefined graph object
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deletePredefinedGraph
Delete predefined graph.- Parameters:
graphId
- predefined graph object ID- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getScriptLibrary
Get list of all scripts in script library.- Returns:
- ID/name pairs for scripts in script library
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getScript
Get script from library- Parameters:
scriptId
- script ID- Returns:
- script source code
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyScript
public long modifyScript(long scriptId, String name, String source) throws IOException, NXCException Modify script. If scriptId is 0, new script will be created in library.- Parameters:
scriptId
- script IDname
- script namesource
- script source code- Returns:
- script ID (newly assigned if new script was created)
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
renameScript
Rename script in script library.- Parameters:
scriptId
- script IDname
- new script name- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteScript
Delete script from library- Parameters:
scriptId
- script ID- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
findConnectionPoint
Find connection point (either directly connected or most close known interface on a switch) for given node or interface object. Will return null if connection point information cannot be found.- Parameters:
objectId
- Node or interface object ID- Returns:
- connection point information or null
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
findConnectionPoint
Find node and/or connection point (either directly connected or most close known interface on a switch) for given MAC address. Will return null if no information can be found.- Parameters:
macAddr
- MAC address- Returns:
- connection point information or null
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
findConnectionPoints
public List<ConnectionPoint> findConnectionPoints(byte[] pattern, int searchLimit) throws IOException, NXCException Find nodes and/or connection points (either directly connected or most close known interface on a switch) for all MAC addresses that match given MAC address pattern. Will return empty list if no information can be found.- Parameters:
pattern
- MAC address pattern (1-6 bytes)searchLimit
- limits count of elements in output list- Returns:
- list of connection point information
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
findConnectionPoint
public ConnectionPoint findConnectionPoint(int zoneId, InetAddress ipAddr) throws IOException, NXCException Find connection point (either directly connected or most close known interface on a switch) for given IP address. Will return null if connection point information cannot be found.- Parameters:
zoneId
- zone IDipAddr
- IP address to find- Returns:
- connection point information or null
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
findNodesByHostname
public List<AbstractNode> findNodesByHostname(int zoneId, String hostname) throws IOException, NXCException Find all nodes that contain the primary hostname- Parameters:
zoneId
- zone IDhostname
- Hostname to find- Returns:
- List of nodes found
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
checkConnection
public boolean checkConnection()Send KEEPALIVE message. Return true is connection is fine and false otherwise. If connection is broken, session notification with code CONNECTION_BROKEN will be sent to all subscribers. Note that this function will not throw exception in case of error.- Returns:
- true if connection is fine
-
getImageLibrary
Get the whole image library- Returns:
- List of library images
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getImageLibrary
Get the image library of specific category- Parameters:
category
- The name of the category- Returns:
- List of library images
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getImage
Get an image from the library- Parameters:
guid
- UUID of the image- Returns:
- The image
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createImage
public LibraryImage createImage(LibraryImage image, ProgressListener listener) throws IOException, NXCException Create an image- Parameters:
image
- The Imagelistener
- The ProgressListener- Returns:
- The image created
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteImage
Delete an image- Parameters:
image
- The image to delete- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteImage
Delete an image- Parameters:
guid
- ID of image to delete- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyImage
public void modifyImage(LibraryImage image, ProgressListener listener) throws IOException, NXCException Modify an image- Parameters:
image
- The image to modifylistener
- The ProgressListener- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
pollObject
public void pollObject(long objectId, ObjectPollType pollType, TextOutputListener listener) throws IOException, NXCException Perform a forced object poll. This method will not return until poll is complete, so it's advised to run it from separate thread. For each message received from poller listener's method onPollerMessage will be called.- Parameters:
objectId
- object IDpollType
- poll typelistener
- text output listener (can be null)- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPersistentStorageList
Get list of all values in persistent storage- Returns:
- Hash map wit persistent storage key, value
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setPersistentStorageValue
Set persistent storage value. Will create new or update existing- Parameters:
key
- unique key of persistent storage valuevalue
- value- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deletePersistentStorageValue
Delete persistent storage value- Parameters:
key
- unique key of persistent storage value- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
listServerFiles
List files in server's file store.- Returns:
- list of files in server's file store
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
listServerFiles
List files in server's file store.- Parameters:
filter
- array with required extension. Will be used as file filter. Give empty array or null if no filter should be applyed.- Returns:
- list of files in server's file store
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
listAgentFiles
public List<AgentFile> listAgentFiles(AgentFile file, String fullPath, long objectId) throws IOException, NXCException List files on agent file store.- Parameters:
file
- parent of new coomming listfullPath
- path that will be used on an agent to get list of subfilesobjectId
- the ID of the node- Returns:
- will return the list of sub files or the list of allowed folders if full path is set to "/"
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAgentFileInfo
Return information about agent file- Parameters:
file
- The AgentFile in question- Returns:
- AgentFileInfo object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
uploadFileToAgent
public long uploadFileToAgent(long nodeId, String serverFileName, String remoteFileName, boolean jobOnHold) throws IOException, NXCException Start file upload from server's file store to agent. Returns ID of upload job.- Parameters:
nodeId
- node object IDserverFileName
- file name in server's file storeremoteFileName
- fully qualified file name on target system or null to upload file to agent's file storejobOnHold
- if true, upload job will be created in "hold" status- Returns:
- ID of upload job
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
uploadFileToServer
public void uploadFileToServer(File localFile, String serverFileName, ProgressListener listener) throws IOException, NXCException Upload local file to server's file store- Parameters:
localFile
- local fileserverFileName
- name under which file will be stored on serverlistener
- The ProgressListener to set- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
uploadLocalFileToAgent
public void uploadLocalFileToAgent(long nodeId, File localFile, String remoteFileName, boolean overwrite, ProgressListener listener) throws IOException, NXCException Upload local file to remote node via agent. If remote file name is not provided local file name will be used.- Parameters:
nodeId
- node object IDlocalFile
- local fileremoteFileName
- remote file name (can be null or empty)overwrite
- "allow overwrite" flag (if set to true, agent will overwrite existing file)listener
- progress listener (can be null)- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createFolderOnAgent
Create folder on remote system via agent- Parameters:
nodeId
- node object IDfolder
- folder name- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
downloadFileFromAgent
public AgentFileData downloadFileFromAgent(long nodeId, String remoteFileName, long maxFileSize, boolean follow, ProgressListener listener, ServerJobIdUpdater updateServerJobId) throws IOException, NXCException Download file from remote host via agent. IfmaxFileSize
is set to non-zero value then lastmaxFileSize
bytes will be retrieved.- Parameters:
nodeId
- node object IDremoteFileName
- fully qualified file name on remote systemmaxFileSize
- maximum download size, 0 == UNLIMITEDfollow
- if set to true, server will send file updates as they appear (like for tail -f command)listener
- The ProgressListener to setupdateServerJobId
- callback for updating server job ID- Returns:
- agent file handle which contains server assigned ID and handle for local file
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
downloadFileFromAgent
public AgentFileData downloadFileFromAgent(long nodeId, String remoteFileName, boolean expandMacros, long alarmId, Map<String, String> inputValues, long maxFileSize, boolean follow, ProgressListener listener, ServerJobIdUpdater updateServerJobId) throws IOException, NXCExceptionDownload file from remote host via agent. IfmaxFileSize
is set to non-zero value then lastmaxFileSize
bytes will be retrieved.- Parameters:
nodeId
- node object IDremoteFileName
- fully qualified file name on remote systemexpandMacros
- if true, macros in remote file name will be expanded on server sidealarmId
- alarm ID used for macro expansioninputValues
- input field values for macro expansion (can be null if none provided)maxFileSize
- maximum download size, 0 == UNLIMITEDfollow
- if set to true, server will send file updates as they appear (like for tail -f command)listener
- The ProgressListener to setupdateServerJobId
- callback for updating server job ID- Returns:
- agent file handle which contains server assigned ID and handle for local file
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
downloadFileFromServer
Download file from server file storage.- Parameters:
remoteFileName
- fully qualified file name on remote system- Returns:
- The downloaded file
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
cancelFileMonitoring
Cancel file monitoring- Parameters:
monitorId
- file monitor ID (previously returned bydownloadFileFromAgent
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAgentFileFingerprint
public AgentFileFingerprint getAgentFileFingerprint(long nodeId, String remoteFileName) throws IOException, NXCException Get file fingerprint from remote host via agent.- Parameters:
nodeId
- node object IDremoteFileName
- fully qualified file name on remote system- Returns:
- agent file fingerprint which contains size, hashes and partial data for the file
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
renameServerFile
public void renameServerFile(String oldFileName, String newFileName) throws IOException, NXCException Rename file in server's file store- Parameters:
oldFileName
- name of existing server filenewFileName
- new name for selected file- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteServerFile
Delete file from server's file store- Parameters:
serverFileName
- name of server file- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteAgentFile
Delete file from agent- Parameters:
nodeId
- node idfileName
- full path to file- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
renameAgentFile
public void renameAgentFile(long nodeId, String oldName, String newFileName, boolean overwrite) throws IOException, NXCException Rename agent's file- Parameters:
nodeId
- node idoldName
- old file pathnewFileName
- new file pathoverwrite
- should the file in destination be overwritten- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
moveAgentFile
public void moveAgentFile(long nodeId, String oldName, String newFileName, boolean overwrite) throws IOException, NXCException Move file from agent- Parameters:
nodeId
- node idoldName
- old file pathnewFileName
- new file pathoverwrite
- should the file in destination be overwritten- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
copyAgentFile
public void copyAgentFile(long nodeId, String oldName, String newFileName, boolean overwrite) throws IOException, NXCException Copy file from agent- Parameters:
nodeId
- node idoldName
- old file pathnewFileName
- new file pathoverwrite
- should the file in destination be overwritten- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
openConsole
Open server console.- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
closeConsole
Close server console.- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
processConsoleCommand
Process console command on server. Output of the command delivered via console listener.- Parameters:
command
- command to process- Returns:
- true if console should be closed (usually after "exit" command)
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
isServerConsoleConnected
public boolean isServerConsoleConnected()- Returns:
- the serverConsoleConnected
-
snmpWalk
public void snmpWalk(long nodeId, String rootOid, SnmpWalkListener listener) throws IOException, NXCException Do SNMP walk. Operation will start at given root object, and callback will be called one or more times as data will come from server. This method will exit only when walk operation is complete.- Parameters:
nodeId
- node object IDrootOid
- root SNMP object ID (as text)listener
- listener- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getVlans
Get list of VLANs configured on given node- Parameters:
nodeId
- node object ID- Returns:
- list of VLANs
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
areObjectsSynchronized
public boolean areObjectsSynchronized()- Returns:
- the objectsSynchronized
-
getAddressList
Get address list.- Parameters:
listId
- list identifier (defined in NXCSession as ADDRESS_LIST_xxx)- Returns:
- address list
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setAddressList
public void setAddressList(int listId, List<InetAddressListElement> list) throws IOException, NXCException Set content of address list.- Parameters:
listId
- list IDlist
- new list content- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
resetServerComponent
Reset server's internal component (defined by SERVER_COMPONENT_xxx)- Parameters:
component
- component id- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNetworkPath
Get IPv4 network path between two nodes. Server will return path based on cached routing table information. Network path object may be incomplete if server does not have enough information to build full path. In this case, no exception thrown, and completness of path can be checked by calling NetworkPath.isComplete().- Parameters:
node1
- source nodenode2
- destination node- Returns:
- network path object
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getRoutingTable
Get routing table from node- Parameters:
nodeId
- node object ID- Returns:
- list of routing table entries
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getArpCache
public List<ArpCacheEntry> getArpCache(long nodeId, boolean forceRead) throws IOException, NXCException Get ARP cache from node- Parameters:
nodeId
- node object IDforceRead
- if true, ARP cache will be read from node, otherwise cached version may be returned- Returns:
- list of ARP cache entries
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getOSPFInfo
Get OSPF information for given node.- Parameters:
nodeId
- node object ID- Returns:
- OSPF information
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSwitchForwardingDatabase
Get switch forwarding database (MAC address table) from node- Parameters:
nodeId
- node object ID- Returns:
- list of switch forwarding database entries
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getWirelessStations
Get list of wireless stations registered at given wireless controller or access point.- Parameters:
objectId
- controller node ID or access point ID- Returns:
- list of wireless stations
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
addWirelessDomainController
public void addWirelessDomainController(long wirelessDomainId, long nodeId) throws IOException, NXCException Add controller node to wireless domain.- Parameters:
wirelessDomainId
- wireless domain object IDnodeId
- node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
removeWirelessDomainController
public void removeWirelessDomainController(long wirelessDomainId, long nodeId) throws IOException, NXCException Remove controller node from wireless domain.- Parameters:
wirelessDomainId
- wireless domain object IDnodeId
- node object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
removePackage
Remove agent package from server- Parameters:
packageId
- The package ID- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
installPackage
public long installPackage(PackageInfo info, File pkgFile, ProgressListener listener) throws IOException, NXCException Install (upload) package on server- Parameters:
info
- package informationpkgFile
- package filelistener
- progress listener (may be null)- Returns:
- unique ID assigned to package
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updatePackageMetadata
Update metadata for existing package.- Parameters:
info
- package information (file name field will be ignored)- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getInstalledPackages
Get list of installed packages- Returns:
- List of PackageInfo objects
- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deployPackage
public void deployPackage(long packageId, Long[] nodeList, PackageDeploymentListener listener) throws IOException, NXCException Deploy agent packages onto given nodes- Parameters:
packageId
- package IDnodeList
- list of nodeslistener
- deployment progress listener (may be null)- Throws:
IOException
- if socket or file I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
sendNotification
public void sendNotification(String channelName, String phoneNumber, String subject, String message) throws IOException, NXCException Send Notification via server. User should have appropriate rights to execute this command.- Parameters:
channelName
- channel namephoneNumber
- target phone numbersubject
- message subjectmessage
- message text- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
pushDciData
Push data to server.- Parameters:
data
- push data- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
pushDciData
Push value for single DCI.- Parameters:
nodeId
- node IDdciId
- DCI IDvalue
- value to push- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
pushDciData
public void pushDciData(String nodeName, String dciName, String value) throws IOException, NXCException Push value for single DCI.- Parameters:
nodeName
- node namedciName
- DCI namevalue
- value to push- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getClientType
public int getClientType()- Returns:
- the clientType
-
setClientType
public void setClientType(int clientType) Set client type. Can be one of the following: DESKTOP_CLIENT WEB_CLIENT MOBILE_CLIENT TABLET_CLIENT APPLICATION_CLIENT Must be called before connect(), otherwise will not have any effect. Ignored by servers prior to 1.2.2.- Parameters:
clientType
- the clientType to set
-
getDateFormat
Get default date format provided by server- Returns:
- The current date format
-
getTimeFormat
Get default time format provided by server- Returns:
- The current time format
-
getShortTimeFormat
Get time format for short form (usually without seconds).- Returns:
- The current short time format
-
handover
Handover object cache to new session. After call to this method, object cache of this session invalidated and should not be used.- Parameters:
target
- target session object
-
getSessionId
public int getSessionId()Get this session's ID on server.- Returns:
- the sessionId
-
listMappingTables
Get list of all configured mapping tables.- Returns:
- List of MappingTableDescriptor objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getMappingTable
Get list of specific mapping table- Parameters:
id
- The ID of mapping table- Returns:
- The MappingTable
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createMappingTable
public int createMappingTable(String name, String description, int flags) throws IOException, NXCException Create new mapping table.- Parameters:
name
- name of new tabledescription
- description for new tableflags
- flags for new table- Returns:
- ID of new table object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateMappingTable
Create or update mapping table. If table ID is 0, new table will be created on server.- Parameters:
table
- mapping table- Returns:
- ID of new table object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteMappingTable
Delete mapping table- Parameters:
id
- mapping table ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDefaultDciRetentionTime
public final int getDefaultDciRetentionTime()Get the default DCI retention time- Returns:
- the default DCI retention time in days
-
getDefaultDciPollingInterval
public final int getDefaultDciPollingInterval()Get the default DCI polling interval- Returns:
- the default DCI polling interval in seconds
-
getMinViewRefreshInterval
public int getMinViewRefreshInterval()Get the minimal view refresh interval- Returns:
- the minViewRefreshInterval
-
isStrictAlarmStatusFlow
public final boolean isStrictAlarmStatusFlow()Get the state of alarm status flow- Returns:
- true if alarm status flow set to "strict" mode
-
isTimedAlarmAckEnabled
public boolean isTimedAlarmAckEnabled()- Returns:
- true if timed alarm acknowledgement is enabled
-
listDciSummaryTables
Get list of all configured DCI summary tables- Returns:
- List of DciSummaryTableDescriptor objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDciSummaryTable
Get DCI summary table configuration.- Parameters:
id
- DCI summary table ID.- Returns:
- The DciSummaryTable object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyDciSummaryTable
Modify DCI summary table configuration. Will create new table object if id is 0.- Parameters:
table
- DCI summary table configuration- Returns:
- assigned summary table ID
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteDciSummaryTable
Delete DCI summary table.- Parameters:
id
- The ID of the summary table- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryDciSummaryTable
Query DCI summary table.- Parameters:
tableId
- DCI summary table IDbaseObjectId
- base container object ID- Returns:
- table with last values data for all nodes under given base container
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
queryAdHocDciSummaryTable
public Table queryAdHocDciSummaryTable(long baseObjectId, List<DciSummaryTableColumn> columns, AggregationFunction function, Date periodStart, Date periodEnd, boolean multiInstance) throws IOException, NXCException Query ad-hoc DCI summary table.- Parameters:
baseObjectId
- base container object IDcolumns
- columns for resulting tablefunction
- data aggregation functionperiodStart
- start of query periodperiodEnd
- end of query periodmultiInstance
- The multiInstance flag- Returns:
- table with last values data for all nodes under given base container
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
listReports
List reports- Returns:
- List of report UUIDs
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getReportDefinition
Get the report definition- Parameters:
reportId
- The UUID of the report- Returns:
- The ReportDefinition object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
executeReport
public UUID executeReport(ReportingJobConfiguration jobConfiguration) throws NXCException, IOException Execute a report- Parameters:
jobConfiguration
- The parameters to set- Returns:
- the UUID of the report
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getReportResults
List report results- Parameters:
reportId
- The report UUID- Returns:
- List of ReportResult objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteReportResult
Delete report result- Parameters:
reportId
- The report UUIDjobId
- The job UUID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
renderReport
public File renderReport(UUID reportId, UUID jobId, ReportRenderFormat format) throws NXCException, IOException Render report- Parameters:
reportId
- The report UUIDjobId
- The job UUIDformat
- The format of the render- Returns:
- The render of the report
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getScheduledReportingJobs
List scheduled jobs- Parameters:
reportId
- The report UUID- Returns:
- List of ReportingJob objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setClientAddress
Set the client address- Parameters:
clientAddress
- the clientAddress to set
-
getClientLanguage
Get the client`s language- Returns:
- the clientLanguage
-
setClientLanguage
Set client`s language- Parameters:
clientLanguage
- the clientLanguage to set
-
getSubnetAddressMap
Get address map for subnet. Returned array contains one entry for each IP address in a subnet. Element value could be eithet ID of the node with that IP address, 0 for unused addresses, and 0xFFFFFFFF for subnet and broadcast addresses.- Parameters:
subnetId
- The subnet ID- Returns:
- Address map
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAgentConfigurations
Gets the list of configuration files.(Config id, name and sequence number)- Returns:
- the list of configuration files in correct sequence
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAgentConfiguration
Get server side agent configuration- Parameters:
id
- configuration object ID- Returns:
- agent configuration object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
saveAgentConfig
Update server side agent configuration- Parameters:
configuration
- agent configuration object- Returns:
- configuration ID (possibly newly assigned)
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteAgentConfig
Delete server side agent configuration. This call will not change sequence numbers of other configurations.- Parameters:
id
- agent configuration ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
swapAgentConfigs
Swap sequence numbers of two server side agent configurations.- Parameters:
id1
- first agent configuration IDid2
- second agent configuration ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getLocationHistory
public List<GeoLocation> getLocationHistory(long objectId, Date from, Date to) throws NXCException, IOException Get location history for given object.- Parameters:
objectId
- The object IDfrom
- The date fromto
- The date to- Returns:
- List of location history
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
takeScreenshot
Take screenshot from given node. Session to take screenshot from can be identified either by ID or name. If ID is used name must be set to null.- Parameters:
nodeId
- node object IDsessionName
- session name for session to take screenshot from- Returns:
- Screenshot as PNG image
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getScheduledTaskHandlers
Get list of available scheduled task handlers.- Returns:
- list of available scheduled task handlers.
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getScheduledTasks
Get list of scheduled tasks.- Returns:
- list of scheduled tasks
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
addScheduledTask
Add new scheduled task- Parameters:
task
- new scheduled task- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateScheduledTask
Update existing scheduled task.- Parameters:
task
- updated scheduled task- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteScheduledTask
Delete scheduled task.- Parameters:
taskId
- scheduled task ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setObjectMaintenanceMode
public void setObjectMaintenanceMode(long objectId, boolean inMaintenance, String comments) throws NXCException, IOException Set maintenance mode for object- Parameters:
objectId
- object IDinMaintenance
- new maintenance mode setting (true = on, false = off)comments
- comments for entering maintenance- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setObjectMaintenanceMode
public void setObjectMaintenanceMode(long objectId, boolean inMaintenance) throws NXCException, IOException Set maintenance mode for object- Parameters:
objectId
- object IDinMaintenance
- new maintenance mode setting (true = on, false = off)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getRepositories
Get list of configured repositories- Returns:
- list of configured repositories
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
addRepository
Add repository. Will update given repository object with assigned ID.- Parameters:
r
- The repository- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyRepository
Modify repository.- Parameters:
r
- The repository- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteRepository
Delete repository.- Parameters:
id
- The id- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPredictionEngines
Get list of registered prediction engines- Returns:
- List of PredictionEngine objects
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPredictedData
public DciData getPredictedData(long nodeId, long dciId, Date from, Date to) throws IOException, NXCException Get predicted DCI data from server.- Parameters:
nodeId
- Node IDdciId
- DCI IDfrom
- Start of time rangeto
- End of time range- Returns:
- DCI data set
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAgentTunnels
Get list of agent tunnels- Returns:
- list of agent tunnels
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
waitForAgentTunnel
public boolean waitForAgentTunnel(long nodeId, long timeout) Wait for bound tunnel for given node to appear. This method will not throw usual exceptions on communication or server errors but will return false instead.- Parameters:
nodeId
- node IDtimeout
- waiting timeout in milliseconds- Returns:
- true if bound tunnel for given node exist
-
bindAgentTunnel
Bind agent tunnel to node- Parameters:
tunnelId
- tunnel IDnodeId
- node ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
unbindAgentTunnel
Unbind agent tunnel to node- Parameters:
nodeId
- node ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
substituteMacros
public List<String> substituteMacros(ObjectContextBase context, List<String> textsToExpand, Map<String, String> inputValues) throws IOException, NXCExceptionSubstitute macros in multiple strings within one context.- Parameters:
context
- expansion contexttextsToExpand
- texts to be expandedinputValues
- input values provided by used used for %() expansion- Returns:
- same count and order of strings already expanded
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
substituteMacros
public List<String> substituteMacros(ObjectContextBase[] context, String textToExpand, Map<String, String> inputValues) throws IOException, NXCExceptionSubstitute macros in one string within multiple contexts.- Parameters:
context
- expansion contextstextToExpand
- text to be expandedinputValues
- input values provided by used used for %() expansion- Returns:
- same count and order of strings already expanded
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setupTcpProxy
public TcpProxy setupTcpProxy(long proxyId, InetAddress address, int port) throws IOException, NXCException Setup new TCP proxy channel. Proxy object should be disposed with TcpProxy.close() call when no longer needed. If zone object ID passed as proxyId then server will select most suitable proxy node from zone's proxy node list.- Parameters:
proxyId
- proxy node ID (node that will initiate TCP connection to target) or zone object IDaddress
- target IP addressport
- target TCP port- Returns:
- TCP proxy object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
setupTcpProxy
Setup new TCP proxy channel to given node. Server will select appropriate proxy node. Proxy object should be disposed with TcpProxy.close() call when no longer needed.- Parameters:
nodeId
- target node IDport
- target TCP port- Returns:
- TCP proxy object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
closeTcpProxy
protected void closeTcpProxy(int channelId) Close TCP proxy channel.- Parameters:
channelId
- proxy channel ID
-
getAgentPolicy
public AgentPolicy getAgentPolicy(long templateId, UUID policyGUID) throws IOException, NXCException Get agent policy by template id and GUID- Parameters:
templateId
- template id policy is inpolicyGUID
- policy GUID- Returns:
- agent policy
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAgentPolicyList
public HashMap<UUID,AgentPolicy> getAgentPolicyList(long templateId) throws IOException, NXCException Returns agent policy list- Parameters:
templateId
- id of the template where policy are defined- Returns:
- hash map of policy UUID to policy
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
savePolicy
public UUID savePolicy(long templateId, AgentPolicy policy, boolean duplicate) throws NXCException, IOException Saves new or updated policy- Parameters:
templateId
- id of template where policy is definedpolicy
- policy data to be updated or created. For new policy GUID should be nullduplicate
- if set to true server will make copy of existing policy instead of updating existing one- Returns:
- UUID of saved policy
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deletePolicy
Delete policy- Parameters:
templateId
- id of template where policy is definedguid
- guid of the policy that should be deleted- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
onPolicyEditorClose
Command sent on policyEditor close to send updates to all applied nodes- Parameters:
templateId
- id of the closed template- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
forcePolicyInstallation
Force policy installation on all nodes where template is applied- Parameters:
templateId
- template id- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getUserAgentNotifications
Get user support application notifications list- Returns:
- list of user support application notifications
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
recallUserAgentNotification
Recall user support application notification- Parameters:
id
- recall id- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createUserAgentNotification
public void createUserAgentNotification(String message, long[] objects, Date startTime, Date endTime, boolean onStartup) throws NXCException, IOException Create new user support application notifications- Parameters:
message
- notification messageobjects
- objects to show notifications onstartTime
- notification's activation timeendTime
- notificaiton's display end timeonStartup
- true if notification should be shown only after user agent startup (usually immediately after user login)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createUserAgentNotification
public void createUserAgentNotification(String message, Collection<Long> objects, Date startTime, Date endTime, boolean onStartup) throws NXCException, IOException Create new user support application notifications- Parameters:
message
- notification messageobjects
- objects to show notifications onstartTime
- notification's activation timeendTime
- notificaiton's display end timeonStartup
- true if notification should be shown only after user agent startup (usually immediately after user login)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNotificationChannels
Get server notification channels- Returns:
- list of server notifications channels
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createNotificationChannel
Create notification channel- Parameters:
nc
- new notification channel- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateNotificationChannel
Update notification channel- Parameters:
nc
- update notification channel- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteNotificationChannel
Delete notification channel- Parameters:
name
- name of notification channel to be deleted- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
renameNotificationChannel
public void renameNotificationChannel(String oldName, String newName) throws NXCException, IOException Rename notification channel- Parameters:
oldName
- old notification channel namenewName
- new notification channel name- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNotificationDrivers
Get list of available notification channel drivers.- Returns:
- list of available notification channel drivers
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
startManualActiveDiscovery
public void startManualActiveDiscovery(List<InetAddressListElement> ranges) throws NXCException, IOException Start active discovery for provided list manually- Parameters:
ranges
- IP address ranges to scan- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getPhysicalLinks
public List<PhysicalLink> getPhysicalLinks(long objectId, long patchPanelId) throws NXCException, IOException Get list of physical links filtered by provided options- Parameters:
objectId
- node id or rack id to filter out physical linkspatchPanelId
- patch panel id to filter out it's physical links (first parameter should be rack id)- Returns:
- list of physical links
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updatePhysicalLink
Create new or update existing physical link- Parameters:
link
- link to be created with ID 0 or link to be updated with correct ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deletePhysicalLink
Delete physical link.- Parameters:
linkId
- physical link ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getWebServiceDefinitions
Get configured web service definitions.- Returns:
- list of configured web service definitions
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyWebServiceDefinition
public int modifyWebServiceDefinition(WebServiceDefinition definition) throws NXCException, IOException Modify (or create new) web service definition. New definition will be created if ID of provided definition object set to 0.- Parameters:
definition
- web service definition to create or modify- Returns:
- assigned ID of web service definition (same as provided if modifying existing definition)
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteWebServiceDefinition
Delete web service definition.- Parameters:
id
- web service definition ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getWellKnownPorts
Get list of well-known ports (global and all zones).- Parameters:
tag
- port list tag- Returns:
- list of well-known ports
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getWellKnownPorts
Get list of well-known ports for given zone.- Parameters:
zoneUIN
- zone UIN (-1 for global port list)tag
- port list tag- Returns:
- list of well-known ports
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateWellKnownPorts
public void updateWellKnownPorts(int zoneUIN, String tag, List<Integer> ports) throws IOException, NXCException Update list of well-known ports.- Parameters:
zoneUIN
- zone UIN for which port list should be updated (-1 for global port list)tag
- port list tagports
- new port list- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getGeoAreas
Get configured geographical areas- Returns:
- list of configured geographical areas
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyGeoArea
Modify geographical area.- Parameters:
area
- updated geographical area object- Returns:
- ID of geographical area object
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteGeoArea
Delete geographical area. This method will fail if area is in use (set to at least one object) unless forceDelete parameter set to true.- Parameters:
areaId
- area IDforceDelete
- force deletion flag - if set to true area will be deleted even if in use- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
findProxyForNode
Find suitable proxy for given node.- Parameters:
nodeId
- node object ID- Returns:
- proxy node object ID or 0 if proxy cannot be found
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getSshKeys
Get list of SSH key- Parameters:
withPublicKey
- true if ssh data should be returned with public key- Returns:
- list of SSH keys
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteSshKey
Delete SSH key.- Parameters:
id
- key IDforce
- if set to true key will be deleted even if it is in use- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateSshKey
Update or import new SSH keys- Parameters:
sshCertificateData
- ssh key information- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
generateSshKeys
Generate new SSH keys .- Parameters:
name
- for new keys- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
get2FADrivers
Get list of available two-factor authentication drivers.- Returns:
- list of available two-factor authentication drivers
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
get2FAMethods
Get list of configured two-factor authentication methods. Depending on user access method configuration may not be returned.- Returns:
- list of configured two-factor authentication methods
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modify2FAMethod
Modify existing two-factor authentication method or create new one.- Parameters:
method
- method definition- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
rename2FAMethod
Rename two-factor authentication method- Parameters:
oldName
- old method namenewName
- new method name- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
delete2FAMethod
Delete two-factor authentication method.- Parameters:
name
- method name- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getBusinessServiceChecks
public Map<Long,BusinessServiceCheck> getBusinessServiceChecks(long serviceId) throws NXCException, IOException Get list business service checks- Parameters:
serviceId
- business service id- Returns:
- list of business service checks
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteBusinessServiceCheck
public void deleteBusinessServiceCheck(long businessServiceid, long checkId) throws NXCException, IOException Delete check form businsess service- Parameters:
businessServiceid
- business service idcheckId
- cehck id- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
modifyBusinessServiceCheck
public void modifyBusinessServiceCheck(long businessServiceid, BusinessServiceCheck check) throws NXCException, IOException Modify check form businsess service- Parameters:
businessServiceid
- business service idcheck
- cehck id- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getBusinessServiceAvailablity
public double getBusinessServiceAvailablity(long businessServiceid, TimePeriod timePeriod) throws NXCException, IOException Get business service availability- Parameters:
businessServiceid
- business service idtimePeriod
- time period- Returns:
- uptime for selected period
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getBusinessServiceTickets
public List<BusinessServiceTicket> getBusinessServiceTickets(long businessServiceid, TimePeriod timePeriod) throws NXCException, IOException Get business service tickets- Parameters:
businessServiceid
- business service idtimePeriod
- time period- Returns:
- list of tickets for business service
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
findDCI
Send request for last values using prepared message- Parameters:
rootObjectId
- root object idquery
- qury string- Returns:
- The DCI values
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getEventReferences
Get list of objects that are using specified event- Parameters:
eventCode
- code of the event- Returns:
- list of event references
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAllMaintenanceEntries
public List<MaintenanceJournalEntry> getAllMaintenanceEntries(long objectId, int maxEntries) throws IOException, NXCException Get list of maintenance journal entries for specified object and it's child objects- Parameters:
objectId
- journal owner object IDmaxEntries
- upper entries count limit. No limit used if set to 0- Returns:
- list of maintenance journal entries
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
createMaintenanceEntry
public void createMaintenanceEntry(long objectId, String description) throws IOException, NXCException Create new maintenance journal entry for specified object- Parameters:
objectId
- journal owner object IDdescription
- journal entry description- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
editMaintenanceEntry
public void editMaintenanceEntry(long objectId, long entryId, String description) throws IOException, NXCException Edit specified maintenance journal entry for specified object- Parameters:
objectId
- journal owner object IDentryId
- journal entry IDdescription
- journal entry description- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDciMeasurementUnits
public Map<Long,MeasurementUnit> getDciMeasurementUnits(List<Long> nodeIds, List<Long> dciIds) throws IOException, NXCException Get info for given DCI list- Parameters:
nodeIds
- node identifiersdciIds
- DCI identifiers (length must match length of node identifiers list)- Returns:
- map with DCI information
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDciMeasurementUnits
public Map<Long,MeasurementUnit> getDciMeasurementUnits(List<ChartDciConfig> dciList) throws IOException, NXCException Get measurement units for given DCI list- Parameters:
dciList
- list of DCI chart configurations- Returns:
- map with DCI information
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getDciMeasurementUnits
public Map<Long,MeasurementUnit> getDciMeasurementUnits(ChartDciConfig[] dciList) throws IOException, NXCException Get info for given DCI list- Parameters:
dciList
- list of DCI chart configurations- Returns:
- map with DCI information
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
cloneNetworkMap
public void cloneNetworkMap(long mapId, String newObjectName, String alias) throws IOException, NXCException Create network map clone- Parameters:
mapId
- map id to clonenewObjectName
- name of the new objectalias
- new object alias- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getVendorByMac
Get vendor name by OUI part of MAC address. Local cache is checked first, and only if OUI is not found in local cache request to server is made. If server request is made method will return null and queue background request to the server, and if completion callback is provided it will be called after local cache is populated, so next request togetVendorByMac
will complete without request to the server.- Parameters:
mac
- MAC addresscallback
- request completion callback- Returns:
- vendor name, could be null or empty string if OUI is not known (yet)
-
getVendorByMac
public Map<MacAddress,String> getVendorByMac(Set<MacAddress> macList) throws IOException, NXCException Get vendor names by OUI part of provided MAC addresses. Resulting map will contain all unique OUIs extracted from provided MAC addresses.- Parameters:
macList
- list of MAC addresses- Returns:
- OUI to vendor map
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
syncAssetManagementSchema
Synchronize asset management schema.- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getAssetManagementSchema
Get asset management schema from client-side cache.- Returns:
- asset management attributes
-
getAssetManagementSchemaSize
public int getAssetManagementSchemaSize()Get size of asset management schema (number of defined attributes).- Returns:
- size of asset management schema
-
createAssetAttribute
Create asset attribute (definition in asset management schema)..- Parameters:
attribute
- attribute to create- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateAssetAttribute
Update asset attribute (definition in asset management schema).- Parameters:
attribute
- attribute to update- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteAssetAttribute
Delete asset attribute (definition in asset management schema).- Parameters:
name
- name of attribute to be deleted- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
isAssetAttributeUnique
Check if asset management attribute name is unique- Parameters:
newName
- new attribute name- Returns:
- true if it is unique
-
setAssetProperty
public void setAssetProperty(long objectId, String name, String value) throws IOException, NXCException Set asset property value.- Parameters:
objectId
- object idname
- property namevalue
- new value- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
deleteAssetProperty
Delete asset property.- Parameters:
objectId
- object idname
- property name- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
linkAsset
public void linkAsset(long assetId, long objectId, boolean updateIdentification) throws IOException, NXCException Link asset object to given object. If asset is already linked to another object, that link will be removed.- Parameters:
assetId
- asset object IDobjectId
- other object IDupdateIdentification
- if identification filed (serial or MAC address should be updated on link)- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
unlinkAsset
Unlink asset from object it is currently linked to. Will do nothing if asset is not linked.- Parameters:
assetId
- asset object ID- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
updateNetworkMapElementPosition
public void updateNetworkMapElementPosition(long mapId, Set<NetworkMapElement> elements, Set<NetworkMapLink> links) throws IOException, NXCException Update network map object location- Parameters:
mapId
- network map idelements
- element list to be updatedlinks
- link list to be updated- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNetworkMapDefaultWidth
public int getNetworkMapDefaultWidth()- Returns:
- the networkMapDefaultWidth
-
getNetworkMapDefaultHeight
public int getNetworkMapDefaultHeight()- Returns:
- the networkMapDefaultHeight
-