UNPKG

@itentialopensource/adapter-tcpwave

Version:

This adapter integrates with system described as: tcpwaveRestapiStore.

1,035 lines (1,022 loc) 303 kB
## Using this Adapter The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls. ### Generic Adapter Calls These are adapter methods that Itential Platform or you might use. There are some other methods not shown here that might be used for internal adapter functionality. <table border="1" class="bordered-table"> <tr> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th> </tr> <tr> <td style="padding:15px">connect()</td> <td style="padding:15px">This call is run when the Adapter is first loaded by the Itential Platform. It validates the properties have been provided correctly.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">healthCheck(callback)</td> <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for TCPWave. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">refreshProperties(properties)</td> <td style="padding:15px">This call provides the adapter the ability to accept property changes without having to restart the adapter.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">encryptProperty(property, technique, callback)</td> <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for TCPWave.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td> <td style="padding:15px">This call provides the ability to update the adapter configuration from Itential Platform - includes actions, schema, mockdata and other configurations.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapSuspendAdapter(mode, callback)</td> <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapUnsuspendAdapter(callback)</td> <td style="padding:15px">This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapGetAdapterQueue(callback)</td> <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td> <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapTroubleshootAdapter(props, adapter, callback)</td> <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td> <td style="padding:15px">This call will return the results of a healthcheck.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterConnectivity(callback)</td> <td style="padding:15px">This call will return the results of a connectivity check.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterBasicGet(maxCalls, callback)</td> <td style="padding:15px">This call will return the results of running basic get API calls. By default 5 get calls without parameters will be run. You can ask for more or less by setting maxCalls.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td> <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or Itential Platform Database.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td> <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapActivateTasks(tasks, callback)</td> <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td> <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td> <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td> <td style="padding:15px">This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterLint(callback)</td> <td style="padding:15px">Runs lint on the addapter and provides the information back.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterTests(callback)</td> <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapGetAdapterInventory(callback)</td> <td style="padding:15px">This call provides some inventory related information about the adapter.</td> <td style="padding:15px">Yes</td> </tr> </table> <br> ### Adapter Cache Calls These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well. <table border="1" class="bordered-table"> <tr> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th> </tr> <tr> <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td> <td style="padding:15px">This call populates the adapter cache.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td> <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td> <td style="padding:15px">Yes</td> </tr> </table> <br> ### Adapter Broker Calls These are adapter methods that are used to integrate to Itential Platform Brokers. This adapter currently supports the following broker calls. <table border="1" class="bordered-table"> <tr> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th> </tr> <tr> <td style="padding:15px">hasEntities(entityType, entityList, callback)</td> <td style="padding:15px">This call is utilized by the Itential Platform Device Broker to determine if the adapter has a specific entity and item of the entity.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">getDevice(deviceName, callback)</td> <td style="padding:15px">This call returns the details of the requested device.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">getDevicesFiltered(options, callback)</td> <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">isAlive(deviceName, callback)</td> <td style="padding:15px">This call returns whether the device status is active</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">getConfig(deviceName, format, callback)</td> <td style="padding:15px">This call returns the configuration for the selected device.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">iapGetDeviceCount(callback)</td> <td style="padding:15px">This call returns the count of devices.</td> <td style="padding:15px">No</td> </tr> </table> <br> ### Specific Adapter Calls Specific adapter calls are built based on the API of the TCPWave. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls. <table border="1" class="bordered-table"> <tr> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th> </tr> <tr> <td style="padding:15px">aclCreate(body, callback)</td> <td style="padding:15px">ACL Create</td> <td style="padding:15px">{base_path}/{version}/acls/create?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">aclUpdate(body, callback)</td> <td style="padding:15px">ACL Edit</td> <td style="padding:15px">{base_path}/{version}/acls/update?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">aclList(callback)</td> <td style="padding:15px">ACL List</td> <td style="padding:15px">{base_path}/{version}/acls/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">aclGet(name, callback)</td> <td style="padding:15px">ACL Details</td> <td style="padding:15px">{base_path}/{version}/acls/get?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">aclGetReferences(name, callback)</td> <td style="padding:15px">ACL References</td> <td style="padding:15px">{base_path}/{version}/acls/getreferences?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">aclMultiDelete(body, callback)</td> <td style="padding:15px">ACL Delete Multiple</td> <td style="padding:15px">{base_path}/{version}/acls/multidelete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">aclPage(page, rows, callback)</td> <td style="padding:15px">Search ACL</td> <td style="padding:15px">{base_path}/{version}/acls/search?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">adUserAdd(body, callback)</td> <td style="padding:15px">Active Directory User Add</td> <td style="padding:15px">{base_path}/{version}/activedirectory/useradd?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">adUserList(callback)</td> <td style="padding:15px">Active Directory User list</td> <td style="padding:15px">{base_path}/{version}/activedirectory/userlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">adUserDelete(body, callback)</td> <td style="padding:15px">Active Directory User Delete</td> <td style="padding:15px">{base_path}/{version}/activedirectory/delete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">adUserAuthenticate(body, callback)</td> <td style="padding:15px">Authenticate Active Directory User</td> <td style="padding:15px">{base_path}/{version}/activedirectory/authenticate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">del(id, name, organizationId, organizationName, callback)</td> <td style="padding:15px">Admin Group Delete</td> <td style="padding:15px">{base_path}/{version}/admingroup/delete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">edit(body, callback)</td> <td style="padding:15px">Admin Group Modify</td> <td style="padding:15px">{base_path}/{version}/admingroup/update?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">adminGroupPage(page, rows, callback)</td> <td style="padding:15px">Search Admin Group</td> <td style="padding:15px">{base_path}/{version}/admingroup/search?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">get(adminGroupId, adminGroupName, callback)</td> <td style="padding:15px">Admin Group Details</td> <td style="padding:15px">{base_path}/{version}/admingroup/get?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">list(orgId, orgName, callback)</td> <td style="padding:15px">Admin Group List</td> <td style="padding:15px">{base_path}/{version}/admingroup/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">create(body, callback)</td> <td style="padding:15px">Admin Group Add</td> <td style="padding:15px">{base_path}/{version}/admingroup/add?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">categoryList(callback)</td> <td style="padding:15px">Threshold Category List</td> <td style="padding:15px">{base_path}/{version}/alarmSubscription/categoryList?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">listCategoryMonitorService(category, callback)</td> <td style="padding:15px">List Monitoring Services</td> <td style="padding:15px">{base_path}/{version}/alarmSubscription/thresholdList?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">listComponents(serviceList, orgName, draw, start, length, filterRules, sort, order, callback)</td> <td style="padding:15px">List Alarm Subscription Components</td> <td style="padding:15px">{base_path}/{version}/alarmSubscription/componentList?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addSubscriptions(body, callback)</td> <td style="padding:15px">Add Alarm Subscriptions</td> <td style="padding:15px">{base_path}/{version}/alarmSubscription/add?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteSubscription(body, callback)</td> <td style="padding:15px">Delete Alarm Subscriptions</td> <td style="padding:15px">{base_path}/{version}/alarmSubscription/delete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAlarmSubscriptionList(draw, start, length, filterRules, sort, order, callback)</td> <td style="padding:15px">Subscription List</td> <td style="padding:15px">{base_path}/{version}/alarmSubscription/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">tsigList(callback)</td> <td style="padding:15px">Algorithm TSIG List</td> <td style="padding:15px">{base_path}/{version}/algo/tsiglist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAlgoList(callback)</td> <td style="padding:15px">Algorithm List</td> <td style="padding:15px">{base_path}/{version}/algo/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAppliancegroupEdit(body, callback)</td> <td style="padding:15px">Edit Appliance Group</td> <td style="padding:15px">{base_path}/{version}/appliancegroup/edit?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getApplainceGroupReferences(name, organization, callback)</td> <td style="padding:15px">References of Appliance Group</td> <td style="padding:15px">{base_path}/{version}/appliancegroup/references?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getApplianceGroup(name, organization, callback)</td> <td style="padding:15px">Details of Appliance Group</td> <td style="padding:15px">{base_path}/{version}/appliancegroup/get?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteApplianceGroup(name, organization, callback)</td> <td style="padding:15px">Appliance Group Delete</td> <td style="padding:15px">{base_path}/{version}/appliancegroup/delete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">listByOrg(organization, callback)</td> <td style="padding:15px">Appliance Group List</td> <td style="padding:15px">{base_path}/{version}/appliancegroup/listbyorg?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">applianceGroupSearchPage(draw, start, length, userId, filterRules, sort, order, callback)</td> <td style="padding:15px">Searches for appliance groups</td> <td style="padding:15px">{base_path}/{version}/appliancegroup/search?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAppliancegroupList(draw, start, length, filterRules, sort, order, callback)</td> <td style="padding:15px">List Appliance Group</td> <td style="padding:15px">{base_path}/{version}/appliancegroup/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAppliancegroupAdd(body, callback)</td> <td style="padding:15px">Add Appliance Group</td> <td style="padding:15px">{base_path}/{version}/appliancegroup/add?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAssetEdit(body, callback)</td> <td style="padding:15px">Update Asset</td> <td style="padding:15px">{base_path}/{version}/asset/edit?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteAll(body, callback)</td> <td style="padding:15px">Delete Assets</td> <td style="padding:15px">{base_path}/{version}/asset/deleteAll?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAssetGet(serviceTag, callback)</td> <td style="padding:15px">Get Asset Details</td> <td style="padding:15px">{base_path}/{version}/asset/get?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAssetList(callback)</td> <td style="padding:15px">Asset List</td> <td style="padding:15px">{base_path}/{version}/asset/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAssetAdd(body, callback)</td> <td style="padding:15px">Add Asset</td> <td style="padding:15px">{base_path}/{version}/asset/add?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getReportRecordsForGrid(fromDate, toDate, draw, start, length, filterRules, sort, order, callback)</td> <td style="padding:15px">Backup Audit</td> <td style="padding:15px">{base_path}/{version}/auditbackup/reportlistbydate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">upload(body, callback)</td> <td style="padding:15px">Audit backup files Upload</td> <td style="padding:15px">{base_path}/{version}/auditbackup/upload?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">auditBackupList(callback)</td> <td style="padding:15px">Audit Backup files List</td> <td style="padding:15px">{base_path}/{version}/auditbackup/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">auditBackupListBySearch(searchVal, callback)</td> <td style="padding:15px">Audit Backup files List</td> <td style="padding:15px">{base_path}/{version}/auditbackup/listsearchbackupfiles?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">auditBackupFilesReportList(fileName, draw, start, length, filterRules, sort, order, callback)</td> <td style="padding:15px">Audit Backup Report by file name</td> <td style="padding:15px">{base_path}/{version}/auditbackup/reportlistbyfilename?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditreportsReportlist(reportType, fromDate, toDate, actionType, ipAddressDomainName, user, domain, sourceIp, recordType, changeTicket, orgId, proxy, draw, start, length, filterRules, action, sort, order, mac, organization, id, callback)</td> <td style="padding:15px">Admin Audit</td> <td style="padding:15px">{base_path}/{version}/auditreports/reportlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">sendReportByEmail(body, adminName, adminRole, action, callback)</td> <td style="padding:15px">Email Report</td> <td style="padding:15px">{base_path}/{version}/auditreports/emailreport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAdminsList(actionType, callback)</td> <td style="padding:15px">Admin List</td> <td style="padding:15px">{base_path}/{version}/auditreports/adminslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAdminRolesList(callback)</td> <td style="padding:15px">Admin Role List</td> <td style="padding:15px">{base_path}/{version}/auditreports/adminroleslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getActionsList(callback)</td> <td style="padding:15px">Action List</td> <td style="padding:15px">{base_path}/{version}/auditreports/actionslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditNetworksList(orgId, draw, start, length, actionType, filterRules, q, callback)</td> <td style="padding:15px">Zone List</td> <td style="padding:15px">{base_path}/{version}/auditreports/auditzoneslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditreportsAuditnetworkslist(draw, start, length, actionType, orgId, filterRules, q, callback)</td> <td style="padding:15px">IPV4 Network List</td> <td style="padding:15px">{base_path}/{version}/auditreports/auditnetworkslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIPv4NetworkList(callback)</td> <td style="padding:15px">IPv4 Network Mask Length</td> <td style="padding:15px">{base_path}/{version}/auditreports/ipv4Network?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIPv4SubnetList(callback)</td> <td style="padding:15px">IPv4 Subnet Subnets mask lengths</td> <td style="padding:15px">{base_path}/{version}/auditreports/ipv4Subnet?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getOFACCountryGridList(callback)</td> <td style="padding:15px">ccTLDs Grid List</td> <td style="padding:15px">{base_path}/{version}/auditreports/ofaccountriesgridlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getReportsReportlist(reportType, fromDate, toDate, actionType, ipAddressDomainName, orgId, organization, draw, start, length, filterRules, action, sort, serverIp, macAddress, hostName, order, callback)</td> <td style="padding:15px">Lists all Reports</td> <td style="padding:15px">{base_path}/{version}/reports/reportlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSubnetGroupList(draw, start, length, filterRules, q, callback)</td> <td style="padding:15px">Subnet Groups List</td> <td style="padding:15px">{base_path}/{version}/reports/listsubnetgroup?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getReportsDhcpActiveLeases(reportType, fromDate, toDate, serverIp, page, rows, callback)</td> <td style="padding:15px">DHCP active leases audit report</td> <td style="padding:15px">{base_path}/{version}/reports/dhcpActiveLeases?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postReportsCsvreport(body, callback)</td> <td style="padding:15px">CSV Report</td> <td style="padding:15px">{base_path}/{version}/reports/csvreport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getReportsServertozonecount(organizationName, callback)</td> <td style="padding:15px">DNS Server to zone count result</td> <td style="padding:15px">{base_path}/{version}/reports/servertozonecount?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postReportsPdfreport(body, callback)</td> <td style="padding:15px">PDF Report</td> <td style="padding:15px">{base_path}/{version}/reports/pdfreport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postReportsEmailreport(body, callback)</td> <td style="padding:15px">Email Report</td> <td style="padding:15px">{base_path}/{version}/reports/emailreport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">schedemailreport(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, adminName, adminRole, callback)</td> <td style="padding:15px">Schedule Report Email</td> <td style="padding:15px">{base_path}/{version}/reports/sched_emailreport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">allParamsList(serverTypeCode, entityTypeCode, draw, start, length, filterRules, q, callback)</td> <td style="padding:15px">Parameter List</td> <td style="padding:15px">{base_path}/{version}/reports/allparams?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">generateScheduleCsvReport(body, callback)</td> <td style="padding:15px">CSV report for Scheduled Events</td> <td style="padding:15px">{base_path}/{version}/reports/schedulecsvreport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getReportRecordsForViwsGrid(reportType, fromDate, toDate, viewName, orgId, draw, start, length, q, filterRules, action, sort, order, callback)</td> <td style="padding:15px">Lists all Columns for DNS Views Report</td> <td style="padding:15px">{base_path}/{version}/reports/viewsgridlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getReportRecordsForRPZLogs(reportType, serverIp, clientIp, draw, start, length, q, filterRules, action, sort, order, callback)</td> <td style="padding:15px">Lists all Columns for RPZ Logs Report</td> <td style="padding:15px">{base_path}/{version}/reports/rpzlogsgridlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDHCPServerSubnetReportRecordsForGrid(reportType, ipAddressDomainName, draw, start, length, q, filterRules, action, sort, order, callback)</td> <td style="padding:15px">DHCP Appliance Association audit report</td> <td style="padding:15px">{base_path}/{version}/reports/dhcpserversubnetreportlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDHCPTemplAssoReportRecordsForGrid(reportType, optionTempl, assoType, draw, start, length, q, filterRules, action, sort, order, callback)</td> <td style="padding:15px">DHCP Option Template Association Report</td> <td style="padding:15px">{base_path}/{version}/reports/dhcptemplassoreportgrid?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDhcpOptionConfigReportRecordsForGrid(reportType, configName, paramVal, draw, start, length, q, filterRules, action, sort, order, callback)</td> <td style="padding:15px">DHCP Option Template Report</td> <td style="padding:15px">{base_path}/{version}/reports/dhcpoptionconfigreportlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getScheduleReportRecordsForGrid(reportType, fromDate, toDate, ipAddressDomainName, userId, jobId, draw, start, length, q, filterRules, action, sort, order, callback)</td> <td style="padding:15px">Schedule Events Audit Report</td> <td style="padding:15px">{base_path}/{version}/reports/schedulereportlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getServerConfigReportRecordsForGrid(reportType, fromDate, toDate, ipAddressDomainName, serverType, draw, start, length, q, filterRules, action, sort, order, callback)</td> <td style="padding:15px">Appliance configuration audit report</td> <td style="padding:15px">{base_path}/{version}/reports/serverConfigreportlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDHSSOAReportForGrid(reportType, serverIp, serverName, serverType, page, rows, callback)</td> <td style="padding:15px">DNS SOA Report Grids</td> <td style="padding:15px">{base_path}/{version}/reports/dnssoareportgrid?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDhcpLeaseReportForCsv(reportType, serverIp, page, rows, callback)</td> <td style="padding:15px">DHCP active leases Audit Report</td> <td style="padding:15px">{base_path}/{version}/reports/dhcpLeaseCsvReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDnsSOARptForCsv(reportType, serverName, serverIp, serverType, page, rows, callback)</td> <td style="padding:15px">DNS SOA Report CSV</td> <td style="padding:15px">{base_path}/{version}/reports/dnssoareportcsv?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDnsServersList(actionType, callback)</td> <td style="padding:15px">DNS Servers List</td> <td style="padding:15px">{base_path}/{version}/reports/dnsserverslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDnsAppliancebyViewlist(actionType, organization, orgId, callback)</td> <td style="padding:15px">DNS AUTH Appliance</td> <td style="padding:15px">{base_path}/{version}/reports/dnsappliancebyviewlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDnsZonebyViewlist(actionType, organization, orgId, callback)</td> <td style="padding:15px">DNS Zone list</td> <td style="padding:15px">{base_path}/{version}/reports/dnszonebyviewlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDnsTemplateList(actionType, callback)</td> <td style="padding:15px">DNS Template List</td> <td style="padding:15px">{base_path}/{version}/reports/dnstemplatelist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getZoneTemplateList(actionType, callback)</td> <td style="padding:15px">Zone Template List</td> <td style="padding:15px">{base_path}/{version}/reports/zonetemplauditlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getResourseRecordList(callback)</td> <td style="padding:15px">Owner List</td> <td style="padding:15px">{base_path}/{version}/reports/resourserecordauditlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDnsOptionTemplateList(actionType, callback)</td> <td style="padding:15px">DNS option template List</td> <td style="padding:15px">{base_path}/{version}/reports/dnsoptiontemplauditlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDnsDhcpServersList(callback)</td> <td style="padding:15px">DNS and DHCP Appliance List</td> <td style="padding:15px">{base_path}/{version}/reports/dnsdhcpserverslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDhcpServerList(actionType, callback)</td> <td style="padding:15px">DHCP Appliance List</td> <td style="padding:15px">{base_path}/{version}/reports/DhcpServerlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDhcpLeaseServerList(callback)</td> <td style="padding:15px">DHCP Active Server List</td> <td style="padding:15px">{base_path}/{version}/reports/DhcpLeaseServerlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDhcpServerSubnetList(actionType, callback)</td> <td style="padding:15px">DHCP Appliance Subnet List</td> <td style="padding:15px">{base_path}/{version}/reports/DhcpServerSubnetlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDhcpOptionTemplateList(draw, start, length, actionType, filterRules, q, callback)</td> <td style="padding:15px">DHCP Option Template List</td> <td style="padding:15px">{base_path}/{version}/reports/dhcpoptiontemplauditlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDhcpPolicyTemplateList(actionType, callback)</td> <td style="padding:15px">DHCP Policy Template List</td> <td style="padding:15px">{base_path}/{version}/reports/dhcppolicytemplauditlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDhcpTemplateAssoList(draw, start, length, filterRules, q, callback)</td> <td style="padding:15px">DHCP Option Template List</td> <td style="padding:15px">{base_path}/{version}/reports/dhcpoptiontemplassolist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getScheduleAdminAuditList(actionType, callback)</td> <td style="padding:15px">Administrator List</td> <td style="padding:15px">{base_path}/{version}/reports/scheduleadminauditlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getserverConfigList(callback)</td> <td style="padding:15px">DNS Appliances List</td> <td style="padding:15px">{base_path}/{version}/reports/serverConfigReportlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getmonitoringHostsList(callback)</td> <td style="padding:15px">Host List</td> <td style="padding:15px">{base_path}/{version}/reports/monitoringhostslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getMonitoringServicesList(hostId, callback)</td> <td style="padding:15px">Monitoring Service List</td> <td style="padding:15px">{base_path}/{version}/reports/monitoringserviceslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getObjectTypeList(callback)</td> <td style="padding:15px">Object Type List</td> <td style="padding:15px">{base_path}/{version}/reports/objecttypelist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDNSViewsList(actionType, orgId, draw, start, length, filterRules, q, callback)</td> <td style="padding:15px">DNS Views List</td> <td style="padding:15px">{base_path}/{version}/reports/auditviewslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getServerIpsList(callback)</td> <td style="padding:15px">DNS Cache Appliance List</td> <td style="padding:15px">{base_path}/{version}/reports/dnscacheserverslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getClientIPsList(callback)</td> <td style="padding:15px">Object Type List</td> <td style="padding:15px">{base_path}/{version}/reports/clientserverslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getLast100EventsList(reportType, fromDate, toDate, ipAddressDomainName, page, rows, q, filterRules, callback)</td> <td style="padding:15px">Last 100 Event List</td> <td style="padding:15px">{base_path}/{version}/reports/last100eventslist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNTPOffsetList(reportType, serverType, callback)</td> <td style="padding:15px">NTP Offset List</td> <td style="padding:15px">{base_path}/{version}/reports/ntpoffsetlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">page(draw, start, length, filterRules, q, sort, order, success, loginName, sessionId, remoteIp, target, targetInstance, startDate, endDate, description, ipamIpAddress, callback)</td> <td style="padding:15px">Audit Log List</td> <td style="padding:15px">{base_path}/{version}/audit/page?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">searchAuditHistoryData(draw, start, length, filterRules, sort, order, callback)</td> <td style="padding:15px">Searches Change Tickets</td> <td style="padding:15px">{base_path}/{version}/audit/search?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">configUpdate(body, callback)</td> <td style="padding:15px">Update Audit Logging Configuration Information.</td> <td style="padding:15px">{base_path}/{version}/audit/configUpdate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditConfig(callback)</td> <td style="padding:15px">Audit Logging Configuration</td> <td style="padding:15px">{base_path}/{version}/audit/auditLoggingConfigDetails?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditLicense(callback)</td> <td style="padding:15px">License Details</td> <td style="padding:15px">{base_path}/{version}/audit/license?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">update(body, callback)</td> <td style="padding:15px">Update License</td> <td style="padding:15px">{base_path}/{version}/audit/license/update?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAuthconfEdit(body, callback)</td> <td style="padding:15px">Edit Authentication</td> <td style="padding:15px">{base_path}/{version}/authconf/edit?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuthconfGet(callback)</td> <td style="padding:15px">Get Authentication Configuration</td> <td style="padding:15px">{base_path}/{version}/authconf/get?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deactivate(body, callback)</td> <td style="padding:15px">Session Token Deactivate</td> <td style="padding:15px">{base_path}/{version}/auth_token/deactivate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAuthTokenGet(body, callback)</td> <td style="padding:15px">Get Auth Token</td> <td style="padding:15px">{base_path}/{version}/auth_token/get?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuthTokenList(callback)</td> <td style="padding:15px">Session Token List</td> <td style="padding:15px">{base_path}/{version}/auth_token/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">setActive(code, callback)</td> <td style="padding:15px">Authentication Set Active</td> <td style="padding:15px">{base_path}/{version}/authtype/setactive?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getActive(callback)</td> <td style="padding:15px">Active Authentication Configuration</td> <td style="padding:15px">{base_path}/{version}/authtype/getactive?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuthtypeList(callback)</td> <td style="padding:15px">Authentication Configuration List</td> <td style="padding:15px">{base_path}/{version}/authtype/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">view(targetType, targetId, orgId, orgName, targetName, callback)</td> <td style="padding:15px">Permissions View</td> <td style="padding:15px">{base_path}/{version}/permission/view?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">createMultiple(orgId, orgName, body, callback)</td> <td style="padding:15px">Add permissions</td> <td style="padding:15px">{base_path}/{version}/permission/addmultiple?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getPermissionList(targetType, targetId, orgId, orgName, targetName, callback)</td> <td style="padding:15px">Permissions List</td> <td style="padding:15px">{base_path}/{version}/permission/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postPermissionAdd(orgId, orgName, body, callback)</td> <td style="padding:15px">Add permissions to an entity</td> <td style="padding:15px">{base_path}/{version}/permission/add?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postBookmarkDelete(id, type, queryString, callback)</td> <td style="padding:15px">Delete bookmark</td> <td style="padding:15px">{base_path}/{version}/bookmark/delete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postBookmarkDeleteSection(type, callback)</td> <td style="padding:15px">Delete bookmark</td> <td style="padding:15px">{base_path}/{version}/bookmark/deleteSection?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">delAll(callback)</td> <td style="padding:15px">Delete bookmark</td> <td style="padding:15px">{base_path}/{version}/bookmark/deleteAll?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getBookmarkList(user, callback)</td> <td style="padding:15px">Get Bookmark List</td> <td style="padding:15px">{base_path}/{version}/bookmark/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postBookmarkAdd(body, callback)</td> <td style="padding:15px">Add bookmark</td> <td style="padding:15px">{base_path}/{version}/bookmark/add?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getClogConfig(callback)</td> <td style="padding:15px">Central Logging Configuration</td> <td style="padding:15px">{base_path}/{version}/centralLogging/centralLoggingConfig?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getClogFullConfig(callback)</td> <td style="padding:15px">Central Logging Configuration</td> <td style="padding:15px">{base_path}/{version}/centralLogging/centralLoggingFullConfig?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getClogServerLogConfig(serverType, callback)</td> <td style="padding:15px">Central Logging Server Logs</td> <td style="padding:15px">{base_path}/{version}/centralLogging/centralLoggingServerLogConfig?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">fullConfigupdate(body, callback)</td> <td style="padding:15px">Update Central Logging Configuration Information.</td> <td style="padding:15px">{base_path}/{version}/centralLogging/fullConfigUpdate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">changeServerClogSetting(serverType, address, clogOption, callback)</td> <td style="padding:15px">Server Central Logging Setting</td> <td style="padding:15px">{base_path}/{version}/centralLogging/serverCentralLoggingSetting?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAllCerts(callback)</td> <td style="padding:15px">certificate list</td> <td style="padding:15px">{base_path}/{version}/certmgmt/certlist?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNumberOfDays(callback)</td> <td style="padding:15px">Number of days Certificate is valid for</td> <td style="padding:15px">{base_path}/{version}/certmgmt/certValidDays?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">duplicateAliasCheck(body, callback)</td> <td style="padding:15px">Duplicate Alias check</td> <td style="padding:15px">{base_path}/{version}/certmgmt/duplicateAlias?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">certificateValidate(cfile, callback)</td> <td style="padding:15px">Certificate validation</td> <td style="padding:15px">{base_path}/{version}/certmgmt/certValidate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">allcertValidDays(callback)</td> <td style="padding:15px">Get number of days all certificates are valid</td> <td style="padding:15px">{base_path}/{version}/certmgmt/allcertValidDays?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">certificateImport(body, callback)</td> <td style="padding:15px">Import Certificate</td> <td style="padding:15px">{base_path}/{version}/certmgmt/certImport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">certificateDelete(body, callback)</td> <td style="padding:15px">Certificate Delete</td> <td style="padding:15px">{base_path}/{version}/certmgmt/certDelete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">changeKeystorePassword(body, callback)</td> <td style="padding:15px">Change Keystore Password</td> <td style="padding:15px">{base_path}/{version}/certmgmt/changeKeystorePassword?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">jettyRestart(callback)</td> <td style="padding:15px">Web Server Restart</td> <td style="padding:15px">{base_path}/{version}/certmgmt/jettyRestart?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getTop10Subnets(id, address, callback)</td> <td style="padding:15px">Network Statistics</td> <td style="padding:15px">{base_path}/{version}/chart/top10subnets?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getTop10v6Subnets(id, orgName, address, callback)</td> <td style="padding:15px">Network Statistics</td> <td style="padding:15px">{base_path}/{version}/chart/top10v6subnets?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAllocPercent(id, address, callback)</td> <td style="padding:15px">Network Statistics</td> <td style="padding:15px">{base_path}/{version}/chart/allocationpercent?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getv6AllocPercent(id, orgName, address, callback)</td> <td style="padding:15px">Network Statistics</td> <td style="padding:15px">{base_path}/{version}/chart/v6allocationpercent?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getObjectAllocChart(id, callback)</td> <td style="paddin