Uses of Class
org.netxms.client.NXCException
Package
Description
-
Uses of NXCException in org.netxms.client
Modifier and TypeMethodDescriptionvoid
NXCSession.acknowledgeAlarm
(long alarmId) Acknowledge alarm.void
NXCSession.acknowledgeAlarm
(long alarmId, boolean sticky, int time) Acknowledge alarm.void
NXCSession.acknowledgeAlarm
(String helpdeskReference) Acknowledge alarm by helpdesk reference.void
NXCSession.addClusterNode
(long clusterId, long nodeId) Add node to cluster.void
NXCSession.addRepository
(Repository r) Add repository.void
NXCSession.addScheduledTask
(ScheduledTask task) Add new scheduled taskvoid
NXCSession.addWirelessDomainController
(long wirelessDomainId, long nodeId) Add controller node to wireless domain.void
NXCSession.applyTemplate
(long templateId, long nodeId) Apply data collection template to node.void
NXCSession.bindAgentTunnel
(int tunnelId, long nodeId) Bind agent tunnel to nodevoid
NXCSession.bindObject
(long parentId, long childId) Bind object.NXCSession.bulkResolveAlarms
(List<Long> alarmIds) Bulk terminate alarms.NXCSession.bulkTerminateAlarms
(List<Long> alarmIds) Bulk terminate alarms.void
NXCSession.cancelFileMonitoring
(UUID monitorId) Cancel file monitoringlong[]
NXCSession.changeDCIStatus
(long ownerId, long[] items, int status) Change data collection objects status without opening data collection configuration.void
NXCSession.changeObjectZone
(long objectId, int zoneUIN) Move object to different zone.void
NXCSession.clearAgentDataCollectionConfiguration
(long nodeId) Clear data collection configuration on agent.void
NXCSession.clearCollectedData
(long nodeId, long dciId) Clear collected data for given DCIvoid
NXCSession.cloneNetworkMap
(long mapId, String newObjectName, String alias) Create network map clonevoid
NXCSession.closeConsole()
Close server console.void
NXCSession.closeEventProcessingPolicy()
Close event processing policy.void
NXCSession.compileMibs
(Consumer<MibCompilationLogEntry> outputCallback) Compile MIBsNXCSession.compileScript
(String source, boolean serialize) Compile NXSL script on server.void
NXCSession.connect()
Connect to NetMS server.void
NXCSession.connect
(int[] componentVersions) Connect to NetMS server.void
NXCSession.copyAgentFile
(long nodeId, String oldName, String newFileName, boolean overwrite) Copy file from agentlong
NXCSession.createAction
(String name) Create new server action.void
NXCSession.createAlarmComment
(long alarmId, String text) Create alarm comment.void
NXCSession.createAlarmComment
(String helpdeskReference, String text) Create alarm comment by helpdesk reference.void
NXCSession.createAssetAttribute
(AssetAttribute attribute) Create asset attribute (definition in asset management schema)..void
NXCSession.createFolderOnAgent
(long nodeId, String folder) Create folder on remote system via agentNXCSession.createImage
(LibraryImage image, ProgressListener listener) Create an imagevoid
NXCSession.createMaintenanceEntry
(long objectId, String description) Create new maintenance journal entry for specified objectint
NXCSession.createMappingTable
(String name, String description, int flags) Create new mapping table.void
NXCSession.createNotificationChannel
(NotificationChannel nc) Create notification channellong
NXCSession.createObject
(NXCObjectCreationData data) Create new NetXMS object.long
NXCSession.createObject
(NXCObjectCreationData data, Object userData) Create new NetXMS object.long
NXCSession.createObjectAsync
(NXCObjectCreationData data, ObjectCreationListener callback) Create new NetXMS object and run callback once it's created.NXCSession.createObjectSync
(NXCObjectCreationData data) Create new NetXMS object in synchronous mode.long
NXCSession.createSnmpTrapConfiguration()
Create new trap configuration record.long
NXCSession.createUser
(String name) Create user on servervoid
NXCSession.createUserAgentNotification
(String message, long[] objects, Date startTime, Date endTime, boolean onStartup) Create new user support application notificationsvoid
NXCSession.createUserAgentNotification
(String message, Collection<Long> objects, Date startTime, Date endTime, boolean onStartup) Create new user support application notificationslong
NXCSession.createUserGroup
(String name) Create user group on serverNXCSession.dciIdsToNames
(Collection<? extends NodeItemPair> itemList) Get names for given DCI listNXCSession.dciIdsToNames
(List<Long> nodeIds, List<Long> dciIds) Get names for given DCI listlong
NXCSession.dciNameToId
(long nodeId, String dciName) Get DCI ID for given DCI namevoid
NXCSession.delete2FAMethod
(String name) Delete two-factor authentication method.void
NXCSession.deleteAction
(long actionId) Delete server actionvoid
NXCSession.deleteAgentConfig
(long id) Delete server side agent configuration.void
NXCSession.deleteAgentFile
(long nodeId, String fileName) Delete file from agentvoid
NXCSession.deleteAlarm
(long alarmId) Delete alarm.void
NXCSession.deleteAlarmCategory
(long id) Delete alarm category in DBvoid
NXCSession.deleteAlarmComment
(long alarmId, long commentId) Delete alarm comment.void
NXCSession.deleteAssetAttribute
(String name) Delete asset attribute (definition in asset management schema).void
NXCSession.deleteAssetProperty
(long objectId, String name) Delete asset property.void
NXCSession.deleteBusinessServiceCheck
(long businessServiceid, long checkId) Delete check form businsess servicevoid
NXCSession.deleteDciEntry
(long nodeId, long dciId, long timestamp) Delete collected data entry for given DCIvoid
NXCSession.deleteDciSummaryTable
(int id) Delete DCI summary table.void
NXCSession.deleteEventTemplate
(long eventCode) Delete event template.void
NXCSession.deleteGeoArea
(int areaId, boolean forceDelete) Delete geographical area.void
NXCSession.deleteImage
(UUID guid) Delete an imagevoid
NXCSession.deleteImage
(LibraryImage image) Delete an imagevoid
NXCSession.deleteMappingTable
(int id) Delete mapping tablevoid
NXCSession.deleteMibFile
(String serverFileName) Delete custom MIB file from server's file storevoid
NXCSession.deleteNotificationChannel
(String name) Delete notification channelvoid
NXCSession.deleteObject
(long objectId) Delete objectvoid
NXCSession.deleteObjectCategory
(int categoryId, boolean forceDelete) Delete object category.void
NXCSession.deleteObjectQuery
(int queryId) Delete predefined object query.void
NXCSession.deleteObjectTool
(long toolId) Delete object tool.void
NXCSession.deletePersistentStorageValue
(String key) Delete persistent storage valuevoid
NXCSession.deletePhysicalLink
(long linkId) Delete physical link.void
NXCSession.deletePolicy
(long templateId, UUID guid) Delete policyvoid
NXCSession.deletePredefinedGraph
(long graphId) Delete predefined graph.void
NXCSession.deleteReportResult
(UUID reportId, UUID jobId) Delete report resultvoid
NXCSession.deleteRepository
(int id) Delete repository.void
NXCSession.deleteScheduledTask
(long taskId) Delete scheduled task.void
NXCSession.deleteScript
(long scriptId) Delete script from libraryvoid
NXCSession.deleteServerFile
(String serverFileName) Delete file from server's file storevoid
NXCSession.deleteServerVariable
(String name) Delete server configuration variablevoid
NXCSession.deleteSnmpTrapConfiguration
(long trapId) Delete SNMP trap configuration record from server.void
NXCSession.deleteSshKey
(int id, boolean force) Delete SSH key.void
NXCSession.deleteUserDBObject
(int id) Delete user or group on servervoid
NXCSession.deleteWebServiceDefinition
(int id) Delete web service definition.void
NXCSession.deployAgentPolicy
(long policyId, long nodeId) Deploy policy on agentvoid
NXCSession.deployPackage
(long packageId, Long[] nodeList, PackageDeploymentListener listener) Deploy agent packages onto given nodesvoid
NXCSession.detachUserFromLdap
(int userId) Detach user from LDAPNXCSession.downloadFileFromAgent
(long nodeId, String remoteFileName, boolean expandMacros, long alarmId, Map<String, String> inputValues, long maxFileSize, boolean follow, ProgressListener listener) Download file from remote host via agent.NXCSession.downloadFileFromAgent
(long nodeId, String remoteFileName, long maxFileSize, boolean follow, ProgressListener listener) Download file from remote host via agent.NXCSession.downloadFileFromServer
(String remoteFileName) Download file from server file storage.NXCSession.downloadMibFile()
Download MIB file from server.void
NXCSession.editMaintenanceEntry
(long objectId, long entryId, String description) Edit specified maintenance journal entry for specified objectNXCSession.enableAnonymousObjectAccess
(long objectId) Enable anonymous access to object.void
NXCSession.enableObjectTool
(long toolId, boolean enable) Enable or disable object tool/void
NXCSession.executeAction
(long nodeId, String action, String[] args) Execute action on remote agentvoid
NXCSession.executeAction
(long nodeId, String action, String[] args, boolean receiveOutput, TextOutputListener listener, Writer writer) Execute action on remote agentNXCSession.executeActionWithExpansion
(long nodeId, long alarmId, String action, boolean receiveOutput, Map<String, String> inputValues, List<String> maskedFields, TextOutputListener listener, Writer writer) Execute action on remote agentNXCSession.executeActionWithExpansion
(long nodeId, long alarmId, String action, Map<String, String> inputValues, List<String> maskedFields) Execute action on remote agentvoid
NXCSession.executeLibraryScript
(long objectId, long alarmId, String script, Map<String, String> inputFields, List<String> maskedFields, TextOutputListener listener) Execute library script on object.void
NXCSession.executeLibraryScript
(long nodeId, String script, Map<String, String> inputFields, List<String> maskedFields, TextOutputListener listener) Execute library script on object.NXCSession.executeReport
(ReportingJobConfiguration jobConfiguration) Execute a reportvoid
NXCSession.executeScript
(long objectId, String script, String parameters, TextOutputListener listener) Execute script.void
NXCSession.executeScript
(long objectId, String script, String parameters, TextOutputListener listener, boolean developmentMode) Execute script.void
NXCSession.executeScript
(long objectId, String script, List<String> parameterList, TextOutputListener listener) Execute script.void
NXCSession.executeScript
(long objectId, String script, List<String> parameterList, TextOutputListener listener, boolean developmentMode) Execute script.void
NXCSession.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
NXCSession.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
NXCSession.executeSimpleCommand
(int command) Execute simple commands (without arguments and only returning RCC)void
NXCSession.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 agentNXCSession.executeTableTool
(long toolId, long nodeId) Execute object tool of "table" type against given node.NXCSession.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.NXCSession.findConnectionPoint
(int zoneId, InetAddress ipAddr) Find connection point (either directly connected or most close known interface on a switch) for given IP address.NXCSession.findConnectionPoint
(long objectId) Find connection point (either directly connected or most close known interface on a switch) for given node or interface object.NXCSession.findConnectionPoint
(MacAddress macAddr) Find node and/or connection point (either directly connected or most close known interface on a switch) for given MAC address.NXCSession.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 messageNXCSession.findMatchingDCI
(long objectId, String objectName, String dciName, int flags) Find all DCIs matching given creteria.NXCSession.findNodesByHostname
(int zoneId, String hostname) Find all nodes that contain the primary hostnamelong
NXCSession.findProxyForNode
(long nodeId) Find suitable proxy for given node.void
NXCSession.forceDCIPoll
(long nodeId, long dciId) Force DCI poll for given DCIvoid
NXCSession.forcePolicyInstallation
(long templateId) Force policy installation on all nodes where template is appliedlong
NXCSession.generateEventCode()
Generate code for new event template.long
NXCSession.generateObjectToolId()
Generate unique ID for new object tool.void
NXCSession.generateSshKeys
(String name) Generate new SSH keys .NXCSession.get2FADrivers()
Get list of available two-factor authentication drivers.NXCSession.get2FAMethods()
Get list of configured two-factor authentication methods.NXCSession.getActions()
Get list of configured actions from serverNXCSession.getActiveThresholds
(List<SingleDciConfig> dciConfig) Get active thresholdsNXCSession.getAddressList
(int listId) Get address list.NXCSession.getAgentConfiguration
(long id) Get server side agent configurationNXCSession.getAgentConfigurations()
Gets the list of configuration files.(Config id, name and sequence number)NXCSession.getAgentFileFingerprint
(long nodeId, String remoteFileName) Get file fingerprint from remote host via agent.NXCSession.getAgentFileInfo
(AgentFile file) Return information about agent fileNXCSession.getAgentPolicy
(long templateId, UUID policyGUID) Get agent policy by template id and GUIDNXCSession.getAgentPolicyList
(long templateId) Returns agent policy listNXCSession.getAgentSharedSecrets()
Get agent shared secret list (global and all zones).NXCSession.getAgentSharedSecrets
(int zoneUIN) Get agent shared secret list for specific zone.NXCSession.getAgentTunnels()
Get list of agent tunnelsNXCSession.getAlarm
(long alarmId) Get information about single active alarm.NXCSession.getAlarmCategories()
Get alarm categories from serverNXCSession.getAlarmComments
(long alarmId) Get list of comments for given alarm.NXCSession.getAlarmEvents
(long alarmId) Get information about events related to single active alarm.NXCSession.getAlarms()
Get list of active alarms.NXCSession.getAllMaintenanceEntries
(long objectId, int maxEntries) Get list of maintenance journal entries for specified object and it's child objectsNXCSession.getArpCache
(long nodeId, boolean forceRead) Get ARP cache from nodeNXCSession.getAttributeForCurrentUser
(String name) Get custom attribute for currently logged in user.NXCSession.getAuthenticationTokens
(int userId) Get list of active authentication tokens for given user.NXCSession.getBackgroundTaskState
(long taskId) Get state of background task.double
NXCSession.getBusinessServiceAvailablity
(long businessServiceid, TimePeriod timePeriod) Get business service availabilityNXCSession.getBusinessServiceChecks
(long serviceId) Get list business service checksNXCSession.getBusinessServiceTickets
(long businessServiceid, TimePeriod timePeriod) Get business service ticketsNXCSession.getCollectedData
(long nodeId, long dciId, Date from, Date to, int maxRows, HistoricalDataType valueType) Get collected DCI data from server.NXCSession.getCollectedData
(long nodeId, long dciId, Date from, Date to, int maxRows, HistoricalDataType valueType, long delegateReadObject) Get collected DCI data from server.NXCSession.getCollectedTableData
(long nodeId, long dciId, String instance, String dataColumn, Date from, Date to, int maxRows) Get collected table DCI data from server.NXCSession.getCollectedTableData
(long nodeId, long dciId, String instance, String dataColumn, Date from, Date to, int maxRows, long delegateReadObject) Get collected table DCI data from server.NXCSession.getDataCollectionScripts
(long objectId) Get names of all scripts used in data collection by given node, cluster, or template object.DciValue[]
NXCSession.getDataCollectionSummary
(long nodeId, boolean objectTooltipOnly, boolean overviewOnly, boolean includeNoValueObjects) Get DCI summary for given nodeDciValue[]
NXCSession.getDataCollectionSummary
(long nodeId, long mapId, boolean objectTooltipOnly, boolean overviewOnly, boolean includeNoValueObjects) Get DCI summary for given node and mapNXCSession.getDciLastValue
(long nodeId, long dciId) Get last value for given table or single valued DCI on given nodeNXCSession.getDciMeasurementUnits
(List<Long> nodeIds, List<Long> dciIds) Get info for given DCI listNXCSession.getDciMeasurementUnits
(List<ChartDciConfig> dciList) Get measurement units for given DCI listNXCSession.getDciMeasurementUnits
(ChartDciConfig[] dciList) Get info for given DCI listNXCSession.getDciSummaryTable
(int id) Get DCI summary table configuration.NXCSession.getDependentNodes
(long nodeId) Get list of dependent nodes for given node.NXCSession.getDeviceView
(long nodeId) Get device view for node.int
NXCSession.getEffectiveRights
(long objectId) Get effective rights of currently logged in user to given object.NXCSession.getEventProcessingPolicy()
Get read-only copy of event processing policy.NXCSession.getEventReferences
(long eventCode) Get list of objects that are using specified eventNXCSession.getEventTemplates()
Get event objects from serverNXCSession.getGeoAreas()
Get configured geographical areasNXCSession.getHelpdeskIssueUrl
(long alarmId) Get URL for helpdesk issue associated with given alarmGet an image from the libraryNXCSession.getImageLibrary()
Get the whole image libraryNXCSession.getImageLibrary
(String category) Get the image library of specific categoryNXCSession.getInstalledPackages()
Get list of installed packagesDciValue[]
NXCSession.getLastValues
(long nodeId) Get last DCI values for given nodeDciValue[]
NXCSession.getLastValues
(List<SingleDciConfig> dciConfig) Get last DCI values for given Single Dci Config listDciValue[]
NXCSession.getLastValues
(Set<MapDCIInstance> mapDcis) Get last DCI values for given Map DCI Instance listNXCSession.getLocationHistory
(long objectId, Date from, Date to) Get location history for given object.NXCSession.getMappingTable
(int id) Get list of specific mapping tableNXCSession.getMibFileTimestamp()
Get timestamp of server's MIB file.NXCSession.getNetworkPath
(long node1, long node2) Get IPv4 network path between two nodes.NXCSession.getNodeHardwareComponents
(long nodeId) Get list of hardware components as reported by agent.NXCSession.getNodePhysicalComponents
(long nodeId) Get node's physical components (obtained from ENTITY-MIB).NXCSession.getNodeSoftwarePackages
(long nodeId) Get list of software packages installed on node.NXCSession.getNodeWinPerfObjects
(long nodeId) Get list of available Windows performance objects.NXCSession.getNotificationChannels()
Get server notification channelsNXCSession.getNotificationDrivers()
Get list of available notification channel drivers.NXCSession.getObjectQueries()
Get list of configured object queries.NXCSession.getObjectToolDetails
(long toolId) Get object tool detailsNXCSession.getObjectTools()
Get list of configured object toolsNXCSession.getObjectToolsAsTree()
NXCSession.getOSPFInfo
(long nodeId) Get OSPF information for given node.NXCSession.getPerfTabItems
(long nodeId) Get list of DCIs configured to be shown on performance tab in console for given node.NXCSession.getPersistentStorageList()
Get list of all values in persistent storageNXCSession.getPhysicalLinks
(long objectId, long patchPanelId) Get list of physical links filtered by provided optionsNXCSession.getPredefinedGraph
(long graphId) Get predefined graph information by graph idNXCSession.getPredefinedGraphs
(boolean graphTemplates) Get list of predefined graphs or graph templatesNXCSession.getPredefinedGraphsAsTree()
NXCSession.getPredictedData
(long nodeId, long dciId, Date from, Date to) Get predicted DCI data from server.NXCSession.getPredictionEngines()
Get list of registered prediction enginesNXCSession.getPublicServerVariable
(String name) Get server public configuration variableboolean
NXCSession.getPublicServerVariableAsBoolean
(String name) Get server public configuration variable as boolen valueint
NXCSession.getPublicServerVariableAsInt
(String name) Get server public configuration variable as a intlong[]
NXCSession.getRelatedEvents
(long objectId) Get all events used in data collection by given node, cluster, or template object.NXCSession.getReportDefinition
(UUID reportId) Get the report definitionNXCSession.getReportResults
(UUID reportId) List report resultsNXCSession.getRepositories()
Get list of configured repositoriesNXCSession.getRoutingTable
(long nodeId) Get routing table from nodeNXCSession.getScheduledReportingJobs
(UUID reportId) List scheduled jobsNXCSession.getScheduledTaskHandlers()
Get list of available scheduled task handlers.NXCSession.getScheduledTasks()
Get list of scheduled tasks.NXCSession.getScript
(long scriptId) Get script from libraryNXCSession.getScriptLibrary()
Get list of all scripts in script library.NXCSession.getServerConfigClob
(String name) Get server config CLOBNXCSession.getServerStats()
Get server stats.NXCSession.getServerVariables()
Get server configuration variablesNXCSession.getSnmpCommunities()
Get list of well-known SNMP communities configured on server.NXCSession.getSnmpCommunities
(int zoneUIN) Get list of well-known SNMP communities configured on server.NXCSession.getSnmpTrapsConfiguration()
Get list of configured SNMP trapsNXCSession.getSnmpTrapsConfigurationSummary()
Get summary of SNMP trap mapping.NXCSession.getSnmpUsmCredentials()
Get list of well-known SNMP USM (user security model) credentials configured on server.NXCSession.getSnmpUsmCredentials
(int zoneUIN) Get list of well-known SNMP USM (user security model) credentials configured on server.NXCSession.getSshCredentials()
Get SSH credentials for all zones.NXCSession.getSshCredentials
(int zoneUIN) Get SSH credentials for specific zone.NXCSession.getSshKeys
(boolean withPublicKey) Get list of SSH keylong[]
NXCSession.getSubnetAddressMap
(long subnetId) Get address map for subnet.NXCSession.getSupportedParameters
(long nodeId) Get list of parameters supported by agent running on given node.NXCSession.getSupportedParameters
(long nodeId, DataOrigin origin) Get list of parameters supported by entity defined by origin on given node.NXCSession.getSupportedTables
(long nodeId) Get list of tables supported by agent running on given node.NXCSession.getSwitchForwardingDatabase
(long nodeId) Get switch forwarding database (MAC address table) from nodeNXCSession.getTableLastValues
(long nodeId, long dciId) Get last value for given table DCI on given nodeNXCSession.getThresholds
(long nodeId, long dciId) Get list of thresholds configured for given DCINXCSession.getThresholds
(long nodeId, long dciId, long delegateReadObject) Get list of thresholds configured for given DCINXCSession.getThresholdSummary
(long objectId) Get threshold violation summary for all nodes under given parent object.NXCSession.getTooltipLastValues
(Set<Long> nodeList) Get tooltip last values for all objectsNXCSession.getUserAgentNotifications()
Get user support application notifications listNXCSession.getUserSessions
(long nodeId) Get list of user sessions on given node as reported by agent.NXCSession.getVendorByMac
(Set<MacAddress> macList) Get vendor names by OUI part of provided MAC addresses.NXCSession.getVlans
(long nodeId) Get list of VLANs configured on given nodeNXCSession.getWebServiceDefinitions()
Get configured web service definitions.NXCSession.getWellKnownPorts
(int zoneUIN, String tag) Get list of well-known ports for given zone.NXCSession.getWellKnownPorts
(String tag) Get list of well-known ports (global and all zones).NXCSession.getWirelessStations
(long objectId) Get list of wireless stations registered at given wireless controller or access point.NXCSession.importConfiguration
(File configFile, int flags) Import server configuration (events, traps, thresholds) from XML file.void
NXCSession.importConfiguration
(String config, int flags) Import server configuration (events, traps, thresholds) from XML document.long
NXCSession.installPackage
(PackageInfo info, File pkgFile, ProgressListener listener) Install (upload) package on servervoid
NXCSession.linkAsset
(long assetId, long objectId, boolean updateIdentification) Link asset object to given object.NXCSession.listAgentFiles
(AgentFile file, String fullPath, long objectId) List files on agent file store.NXCSession.listDciSummaryTables()
Get list of all configured DCI summary tablesNXCSession.listMappingTables()
Get list of all configured mapping tables.NXCSession.listMibFiles()
List custom MIB files in server's file store.NXCSession.listReports()
List reportsNXCSession.listServerFiles()
List files in server's file store.NXCSession.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
NXCSession.login
(String login, Certificate certificate, Signature signature) Login to server using certificate.void
NXCSession.login
(AuthenticationType authType, String login, String password, Certificate certificate, Signature signature, TwoFactorAuthenticationCallback twoFactorAuthenticationCallback) Login to server.void
NXCSession.modify2FAMethod
(TwoFactorAuthenticationMethod method) Modify existing two-factor authentication method or create new one.void
NXCSession.modifyAction
(ServerAction action) Modify server actionlong
NXCSession.modifyAlarmCategory
(AlarmCategory object) Add or update alarm category in DBvoid
NXCSession.modifyBusinessServiceCheck
(long businessServiceid, BusinessServiceCheck check) Modify check form businsess servicelong
NXCSession.modifyDataCollectionObject
(DataCollectionObject dcObject) Modify data collection object without opening data collection configuration.int
NXCSession.modifyDciSummaryTable
(DciSummaryTable table) Modify DCI summary table configuration.void
NXCSession.modifyEventObject
(EventTemplate tmpl) Modify event template.int
NXCSession.modifyGeoArea
(GeoArea area) Modify geographical area.void
NXCSession.modifyImage
(LibraryImage image, ProgressListener listener) Modify an imagevoid
NXCSession.modifyObject
(NXCObjectModificationData data) Modify object (generic interface, in most cases wrapper functions should be used instead).void
NXCSession.modifyObject
(NXCObjectModificationData data, Object userData) Modify object (generic interface, in most cases wrapper functions should be used instead).int
NXCSession.modifyObjectCategory
(MutableObjectCategory category) Modify object category.int
NXCSession.modifyObjectQuery
(ObjectQuery query) Modify object query.void
NXCSession.modifyObjectTool
(ObjectToolDetails tool) Modify object tool.void
NXCSession.modifyRepository
(Repository r) Modify repository.long
NXCSession.modifyScript
(long scriptId, String name, String source) Modify script.void
NXCSession.modifySnmpTrapConfiguration
(SnmpTrap trap) Modify SNMP trap configuration record.void
NXCSession.modifyUserDBObject
(AbstractUserObject object) Modify user database objectvoid
NXCSession.modifyUserDBObject
(AbstractUserObject object, int fields) Modify user database objectint
NXCSession.modifyWebServiceDefinition
(WebServiceDefinition definition) Modify (or create new) web service definition.void
NXCSession.moveAgentFile
(long nodeId, String oldName, String newFileName, boolean overwrite) Move file from agentvoid
NXCSession.onPolicyEditorClose
(long templateId) Command sent on policyEditor close to send updates to all applied nodesvoid
NXCSession.openConsole()
Open server console.NXCSession.openDataCollectionConfiguration
(long nodeId) Open data collection configuration for given node.NXCSession.openDataCollectionConfiguration
(long nodeId, RemoteChangeListener changeListener) Open data collection configuration for given node.NXCSession.openEventProcessingPolicy()
Open event processing policy for editing.NXCSession.openHelpdeskIssue
(long alarmId) Open issue in helpdesk system from given alarmNXCSession.openServerLog
(String logName) Open server log by name.void
NXCSession.pollObject
(long objectId, ObjectPollType pollType, TextOutputListener listener) Perform a forced object poll.boolean
NXCSession.processConsoleCommand
(String command) Process console command on server.void
NXCSession.pushDciData
(long nodeId, long dciId, String value) Push value for single DCI.void
NXCSession.pushDciData
(String nodeName, String dciName, String value) Push value for single DCI.void
NXCSession.pushDciData
(DciPushData[] data) Push data to server.NXCSession.queryAdHocDciSummaryTable
(long baseObjectId, List<DciSummaryTableColumn> columns, AggregationFunction function, Date periodStart, Date periodEnd, boolean multiInstance) Query ad-hoc DCI summary table.NXCSession.queryAgentTable
(long nodeId, String name) Query agent's table immediately.NXCSession.queryDciSummaryTable
(int tableId, long baseObjectId) Query DCI summary table.NXCSession.queryInternalConnectionTopology
(long nodeId) Query internal connection topology for nodeNXCSession.queryLayer2Topology
(long nodeId) Query layer 2 topology for nodeNXCSession.queryObjectDetails
(String query, long rootObjectId, List<String> properties, List<String> orderBy, Map<String, String> inputFields, long contextObjectId, boolean readAllComputedProperties, int limit, Consumer<Integer> progressCallback) Query objects on server side and read certain object properties.NXCSession.queryObjects
(String query, long rootObjectId, Consumer<Integer> progressCallback) Query objects on server side, optionally only those located below given root object.NXCSession.queryObjects
(String query, Consumer<Integer> progressCallback) Query objects on server side.NXCSession.queryOSPFTopology
(long nodeId) Query OSPF topology for nodeNXCSession.queryParameter
(long nodeId, DataOrigin origin, String name) Query parameter immediately.NXCSession.queryScript
(long nodeId, String script, List<String> parameterList, TextOutputListener listener) Execute script and get return value as map.NXCSession.readAgentConfigurationFile
(long nodeId) Get agent's master configuration file.void
NXCSession.recalculateDCIValues
(long objectId, long dciId) Start background recalculation of DCI values using preserved raw values.void
NXCSession.recallUserAgentNotification
(long id) Recall user support application notificationNXCSession.receiveTable
(long requestId, int msgCode) Receive table from server.void
NXCSession.removeClusterNode
(long clusterId, long nodeId) Remove node from cluster.void
NXCSession.removePackage
(long packageId) Remove agent package from servervoid
NXCSession.removeTemplate
(long templateId, long nodeId, boolean removeDci) Remove data collection template from node.void
NXCSession.removeWirelessDomainController
(long wirelessDomainId, long nodeId) Remove controller node from wireless domain.void
NXCSession.rename2FAMethod
(String oldName, String newName) Rename two-factor authentication methodvoid
NXCSession.renameAgentFile
(long nodeId, String oldName, String newFileName, boolean overwrite) Rename agent's filevoid
NXCSession.renameNotificationChannel
(String oldName, String newName) Rename notification channelvoid
NXCSession.renameScript
(long scriptId, String name) Rename script in script library.void
NXCSession.renameServerFile
(String oldFileName, String newFileName) Rename file in server's file storeNXCSession.renderReport
(UUID reportId, UUID jobId, ReportRenderFormat format) Render reportvoid
NXCSession.requestAuthenticationToken()
Request new ephemetral authentication token for this session from server.NXCSession.requestAuthenticationToken
(boolean persistent, int validFor, String description, int userId) Request new authentication token from server.void
NXCSession.resetServerComponent
(int component) Reset server's internal component (defined by SERVER_COMPONENT_xxx)void
NXCSession.resolveAlarm
(long alarmId) Resolve alarm.void
NXCSession.resolveAlarm
(String helpdeskReference) Resolve alarm by helpdesk reference.void
NXCSession.resyncAgentDataCollectionConfiguration
(long nodeId) Force re-synchronization of data collection configuration with agent.void
NXCSession.revokeAuthenticationToken
(int tokenId) Revoke persistent auithentication token.long
NXCSession.saveAgentConfig
(AgentConfiguration configuration) Update server side agent configurationvoid
NXCSession.saveEventProcessingPolicy
(EventProcessingPolicy epp) Save event processing policy.long
NXCSession.saveGraph
(GraphDefinition graph, boolean overwrite) Checks if graph with specified name can be created/overwritten and creates/overwrites it in DB.NXCSession.savePolicy
(long templateId, AgentPolicy policy, boolean duplicate) Saves new or updated policyvoid
TcpProxy.send
(byte[] data) Send data to destinationvoid
Convenience wrapper for sendEvent interface.void
NXCSession.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
NXCSession.sendFile
(long requestId, byte[] data, ProgressListener listener, boolean allowStreamCompression) Send block of data as binary messageprotected void
NXCSession.sendFile
(long requestId, File file, ProgressListener listener, boolean allowStreamCompression, long offset) Send file over NXCPvoid
NXCSession.sendMessage
(NXCPMessage msg) Send message to servervoid
NXCSession.sendNotification
(String channelName, String phoneNumber, String subject, String message) Send Notification via server.void
NXCSession.setAddressList
(int listId, List<InetAddressListElement> list) Set content of address list.void
NXCSession.setAlarmFlowState
(int state) Changes state of alarm status flow.void
NXCSession.setAssetProperty
(long objectId, String name, String value) Set asset property value.void
NXCSession.setAttributeForCurrentUser
(String name, String value) Set custom attribute for currently logged in user.void
NXCSession.setDefaultServerValues
(List<ServerVariable> varList) Set server configuration variables to defaultvoid
NXCSession.setObjectACL
(long objectId, Collection<AccessListElement> acl, boolean inheritAccessRights) Change object's ACL (wrapper for modifyObject())void
NXCSession.setObjectCustomAttributes
(long objectId, Map<String, CustomAttribute> attrList) Change object's custom attributes (wrapper for modifyObject())void
NXCSession.setObjectMaintenanceMode
(long objectId, boolean inMaintenance) Set maintenance mode for objectvoid
NXCSession.setObjectMaintenanceMode
(long objectId, boolean inMaintenance, String comments) Set maintenance mode for objectvoid
NXCSession.setObjectManaged
(long objectId, boolean isManaged) Set object's managed status.void
NXCSession.setObjectName
(long objectId, String name) Change object's name (wrapper for modifyObject())void
NXCSession.setPersistentStorageValue
(String key, String value) Set persistent storage value.void
NXCSession.setServerConfigClob
(String name, String value) Set server config CLOBvoid
NXCSession.setServerVariable
(String name, String value) Set server configuration variableNXCSession.setupTcpProxy
(long nodeId, int port) Setup new TCP proxy channel to given node.NXCSession.setupTcpProxy
(long proxyId, InetAddress address, int port) Setup new TCP proxy channel.void
NXCSession.setUserPassword
(int id, String newPassword, String oldPassword) Set password for uservoid
NXCSession.snmpWalk
(long nodeId, String rootOid, SnmpWalkListener listener) Do SNMP walk.void
NXCSession.startManualActiveDiscovery
(List<InetAddressListElement> ranges) Start active discovery for provided list manuallyvoid
NXCSession.stopScript
(long vmId) Stop running NXSL script.void
NXCSession.stopServerCommand
(long commandId) Stop server commandvoid
Subscribe to notification channel.void
NXCSession.subscribeToUserDBUpdates()
Subscribe to user change notificationsNXCSession.substituteMacros
(ObjectContextBase[] context, String textToExpand, Map<String, String> inputValues) Substitute macros in one string within multiple contexts.NXCSession.substituteMacros
(ObjectContextBase context, List<String> textsToExpand, Map<String, String> inputValues) Substitute macros in multiple strings within one context.void
NXCSession.swapAgentConfigs
(long id1, long id2) Swap sequence numbers of two server side agent configurations.void
NXCSession.syncAlarmCategories()
Synchronize alarm category configuration.void
NXCSession.syncAssetManagementSchema()
Synchronize asset management schema.void
NXCSession.syncChildren
(AbstractObject object) Sync children of given object.void
NXCSession.syncEventTemplates()
Synchronize event templates configuration.void
NXCSession.syncMissingObjects
(long[] objects) Synchronize only those objects from given set which are not synchronized yet.void
NXCSession.syncMissingObjects
(long[] objects, int options) Synchronize only those objects from given set which are not synchronized yet.void
NXCSession.syncMissingObjects
(long[] objects, long mapId, int options) Synchronize only those objects from given set which are not synchronized yet.void
NXCSession.syncMissingObjects
(Collection<Long> objects, int options) Synchronize only those objects from given set which are not synchronized yet.void
NXCSession.syncMissingObjects
(Collection<Long> objects, long mapId, int options) Synchronize only those objects from given set which are not synchronized yet.boolean
NXCSession.syncMissingUsers
(Set<Integer> users) Synchronize only objects that were not yet synchronizedvoid
NXCSession.syncObjectCategories()
Synchronize object categoriesvoid
NXCSession.syncObjects()
Synchronizes NetXMS objects between server and client.void
NXCSession.syncObjects
(boolean syncNodeComponents) Synchronizes NetXMS objects between server and client.void
NXCSession.syncObjectSet
(long[] objects) Synchronizes selected object set with the server.void
NXCSession.syncObjectSet
(long[] objects, int options) Synchronizes selected object set with the server.void
NXCSession.syncObjectSet
(long[] objects, long mapId, int options) Synchronizes selected object set with the server.void
NXCSession.syncObjectSet
(Collection<Long> objects, long mapId, int options) Synchronizes selected object set with the server.void
NXCSession.syncUserDatabase()
Synchronize user database and subscribe to user change notificationsvoid
NXCSession.syncUserSet
(Set<Integer> users) Synchronize users by id if does not existbyte[]
NXCSession.takeScreenshot
(long nodeId, String sessionName) Take screenshot from given node.void
NXCSession.terminateAlarm
(long alarmId) Terminate alarm.void
NXCSession.terminateAlarm
(String helpdeskReference) Terminate alarm by helpdesk reference.NXCSession.testTransformationScript
(long nodeId, String script, String inputValue, DataCollectionObject dcObject) Test DCI transformation script.void
NXCSession.unbindAgentTunnel
(long nodeId) Unbind agent tunnel to nodevoid
NXCSession.unbindObject
(long parentId, long childId) Unbind object.void
NXCSession.uninstallAgentPolicy
(long policyId, long nodeId) Uninstall policy from agentvoid
NXCSession.unlinkAsset
(long assetId) Unlink asset from object it is currently linked to.void
NXCSession.unlinkHelpdeskIssue
(long alarmId) Unlink helpdesk issue from alarm.void
NXCSession.unlinkHelpdeskIssue
(String helpdeskReference) Unlink helpdesk issue from alarm.void
NXCSession.unsubscribe
(String channel) Unsubscribe from notification channel.void
NXCSession.updateAgentSharedSecrets
(int zoneUIN, List<String> sharedSecrets) Update agent shared secret list on server.void
NXCSession.updateAlarmComment
(long alarmId, long commentId, String text) Update alarm comment.void
NXCSession.updateAssetAttribute
(AssetAttribute attribute) Update asset attribute (definition in asset management schema).int
NXCSession.updateMappingTable
(MappingTable table) Create or update mapping table.void
NXCSession.updateNetworkMapElementPosition
(long mapId, Set<NetworkMapElement> elements, Set<NetworkMapLink> links) Update network map object locationvoid
NXCSession.updateNotificationChannel
(NotificationChannel nc) Update notification channelvoid
NXCSession.updateObjectComments
(long objectId, String comments) Change object's comments.void
NXCSession.updatePackageMetadata
(PackageInfo info) Update metadata for existing package.void
NXCSession.updatePhysicalLink
(PhysicalLink link) Create new or update existing physical linkvoid
NXCSession.updateResponsibleUsers
(long objectId, List<ResponsibleUser> users) Update list of responsible users for given object.void
NXCSession.updateScheduledTask
(ScheduledTask task) Update existing scheduled task.void
NXCSession.updateSnmpCommunities
(int zoneUIN, List<String> communityStrings) Update list of well-known SNMP community strings on server.void
NXCSession.updateSnmpUsmCredentials
(int zoneUIN, List<SnmpUsmCredential> usmCredentials) Update list of well-known SNMP USM credentials on server.void
NXCSession.updateSshCredentials
(int zoneUIN, List<SSHCredentials> sshCredentials) Update list of well-known SSH credentials on the server.void
NXCSession.updateSshKey
(SshKeyPair sshCertificateData) Update or import new SSH keysvoid
NXCSession.updateWellKnownPorts
(int zoneUIN, String tag, List<Integer> ports) Update list of well-known ports.long
NXCSession.uploadFileToAgent
(long nodeId, String serverFileName, String remoteFileName) Start file upload from server's file store to agent.void
NXCSession.uploadFileToServer
(File localFile, String serverFileName, ProgressListener listener) Upload local file to server's file storevoid
NXCSession.uploadLocalFileToAgent
(long nodeId, File localFile, String remoteFileName, boolean overwrite, ProgressListener listener) Upload local file to remote node via agent.void
NXCSession.uploadMibFile
(File localFile, String serverFileName, ProgressListener listener) Upload custom MIB file to server's file storeboolean
NXCSession.validateUserPassword
(String password) Validate password for currently logged in userNXCSession.waitForMessage
(int code, long id) Wait for message with specific code and id.NXCSession.waitForMessage
(int code, long id, int timeout) Wait for message with specific code and id.NXCSession.waitForRCC
(long id) Wait for CMD_REQUEST_COMPLETED message with given id using default timeoutNXCSession.waitForRCC
(long id, int timeout) Wait for CMD_REQUEST_COMPLETED message with given idvoid
NXCSession.wakeupNode
(long objectId) Wakeup node by sending wake-on-LAN magic packet.void
NXCSession.writeAgentConfigurationFile
(long nodeId, String config, boolean apply) Update agent's master configuration file. -
Uses of NXCException in org.netxms.client.datacollection
Modifier and TypeMethodDescriptionvoid
DataCollectionConfiguration.bulkUpdateDCIs
(Collection<Long> idList, Collection<? extends BulkDciUpdateElement> fields) void
DataCollectionConfiguration.clearCollectedData
(long itemId) Clear collected data for given DCI.void
DataCollectionConfiguration.commit()
Apply user changesvoid
DataCollectionConfiguration.copyObjects
(long destNodeId, long[] items) Copy data collection objects.long
DataCollectionConfiguration.createItem
(DataCollectionObject object) Deprecated.long
DataCollectionConfiguration.createTable
(DataCollectionObject object) Deprecated.void
DataCollectionConfiguration.deleteObject
(long itemId) Delete data collection object.void
DataCollectionConfiguration.modifyObject
(long dcObjectId) Modify data collection object.long
DataCollectionConfiguration.modifyObject
(DataCollectionObject dco) Modify data collection object.void
DataCollectionConfiguration.moveObjects
(long destNodeId, long[] items) Move data collection objects.void
DataCollectionConfiguration.open
(RemoteChangeListener changeListener) Open data collection configuration.void
DataCollectionConfiguration.refreshDataCollectionList()
Force refresh DCI listvoid
DataCollectionConfiguration.setObjectStatus
(long[] items, int status) Set status of data collection objects. -
Uses of NXCException in org.netxms.client.log
Modifier and TypeMethodDescriptionvoid
Log.close()
Close logLog.getRecordDetails
(long recordId) Get details for specific log record.void
Send query to serverLog.retrieveData
(long startRow, long rowCount) Retrieve log data from server.Log.retrieveData
(long startRow, long rowCount, boolean refresh) Retrieve log data from server. -
Uses of NXCException in org.netxms.client.reporting
Modifier and TypeMethodDescriptionvoid
ReportingJob.fillMessage
(NXCPMessage msg) Fill NXCP message with job data. -
Uses of NXCException in org.netxms.client.snmp
ModifierConstructorDescriptionprotected
MibObject
(NXCPDataInputStream in, MibObject parent) Read MIB object from compiled MIB file.Create MIB tree from compiled MIB file.