UNPKG

@itentialopensource/adapter-bluecat

Version:

This adapter integrates with system described as: BlueCat ProteusAPI.

952 lines (939 loc) 85.3 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 BlueCat. 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 BlueCat.</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 BlueCat. 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">addACL(configurationId, name, properties, callback)</td> <td style="padding:15px">Adds an Access Control List (ACL) to a view.</td> <td style="padding:15px">{base_path}/{version}/v1/addACL?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addAliasRecord(absoluteName, linkedRecordName, properties, ttl, viewId, callback)</td> <td style="padding:15px">Adds alias records.</td> <td style="padding:15px">{base_path}/{version}/v1/addAliasRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addBulkHostRecord(absoluteName, networkId, numberOfAddresses, properties, startAddress, ttl, viewId, callback)</td> <td style="padding:15px">Adds bulk host records using auto-increment from the specific starting address.</td> <td style="padding:15px">{base_path}/{version}/v1/addBulkHostRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addDNSDeploymentOption(entityId, name, properties, value, callback)</td> <td style="padding:15px">Adds DNS options.</td> <td style="padding:15px">{base_path}/{version}/v1/addDNSDeploymentOption?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addEnumNumber(enumZoneId, number, properties, callback)</td> <td style="padding:15px">Adds ENUM numbers.</td> <td style="padding:15px">{base_path}/{version}/v1/addEnumNumber?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addEnumZone(parentId, prefix, properties, callback)</td> <td style="padding:15px">Adds ENUM zones.</td> <td style="padding:15px">{base_path}/{version}/v1/addEnumZone?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addExternalHostRecord(name, properties, viewId, callback)</td> <td style="padding:15px">Adds external host records.</td> <td style="padding:15px">{base_path}/{version}/v1/addExternalHostRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addGenericRecord(absoluteName, properties, rdata, ttl, type, viewId, callback)</td> <td style="padding:15px">Adds generic records.</td> <td style="padding:15px">{base_path}/{version}/v1/addGenericRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addHINFORecord(absoluteName, cpu, os, properties, ttl, viewId, callback)</td> <td style="padding:15px">Adds HINFO records.</td> <td style="padding:15px">{base_path}/{version}/v1/addHINFORecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addHostRecord(absoluteName, addresses, properties, ttl, viewId, callback)</td> <td style="padding:15px">Adds host records for IPv4 or IPv6 addresses.</td> <td style="padding:15px">{base_path}/{version}/v1/addHostRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addMXRecord(absoluteName, linkedRecordName, priority, properties, ttl, viewId, callback)</td> <td style="padding:15px">Adds MX records.</td> <td style="padding:15px">{base_path}/{version}/v1/addMXRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addNAPTRRecord(absoluteName, flags, order, preference, properties, regexp, replacement, service, ttl, viewId, callback)</td> <td style="padding:15px">Adds NAPTR records.</td> <td style="padding:15px">{base_path}/{version}/v1/addNAPTRRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addResourceRecord(absoluteName, properties, rdata, ttl, type, viewId, callback)</td> <td style="padding:15px">Add resource records.</td> <td style="padding:15px">{base_path}/{version}/v1/addResourceRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addResponsePolicy(configurationId, name, properties, responsePolicyType, ttl, callback)</td> <td style="padding:15px">Adds a DNS response policy.</td> <td style="padding:15px">{base_path}/{version}/v1/addResponsePolicy?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addResponsePolicyItem(itemName, options, policyId, callback)</td> <td style="padding:15px">Adds a DNS response policy item under a specified local DNS response policy.</td> <td style="padding:15px">{base_path}/{version}/v1/addResponsePolicyItem?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addSRVRecord(absoluteName, linkedRecordName, port, priority, properties, ttl, viewId, weight, callback)</td> <td style="padding:15px">Adds SRV records.</td> <td style="padding:15px">{base_path}/{version}/v1/addSRVRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addStartOfAuthority(email, expire, minimum, parentId, properties, refresh, retry, callback)</td> <td style="padding:15px">Adds SOA records.</td> <td style="padding:15px">{base_path}/{version}/v1/addStartOfAuthority?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addTXTRecord(absoluteName, properties, ttl, txt, viewId, callback)</td> <td style="padding:15px">Adds TXT records.</td> <td style="padding:15px">{base_path}/{version}/v1/addTXTRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addView(configurationId, name, properties, callback)</td> <td style="padding:15px">Adds DNS views.</td> <td style="padding:15px">{base_path}/{version}/v1/addView?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addZone(absoluteName, parentId, properties, callback)</td> <td style="padding:15px">Adds DNS zones.</td> <td style="padding:15px">{base_path}/{version}/v1/addZone?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addZoneTemplate(name, parentId, properties, callback)</td> <td style="padding:15px">Adds a DNS zone template.</td> <td style="padding:15px">{base_path}/{version}/v1/addZoneTemplate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteDNSDeploymentOption(entityId, name, serverId, callback)</td> <td style="padding:15px">Deletes DNS options.</td> <td style="padding:15px">{base_path}/{version}/v1/deleteDNSDeploymentOption?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteResponsePolicyItem(itemName, options, policyId, callback)</td> <td style="padding:15px">Deletes a DNS response policy item under a specified local DNS response policy.</td> <td style="padding:15px">{base_path}/{version}/v1/deleteResponsePolicyItem?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">findResponsePoliciesWithItem(configurationId, itemName, options, callback)</td> <td style="padding:15px">Finds local DNS response policies with their associated response policy items.</td> <td style="padding:15px">{base_path}/{version}/v1/findResponsePoliciesWithItem?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDNSDeploymentOption(entityId, name, serverId, callback)</td> <td style="padding:15px">Retrieves all DNS options assigned for the object specified excluding the options inherited from th</td> <td style="padding:15px">{base_path}/{version}/v1/getDNSDeploymentOption?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getHostRecordsByHint(count, options, start, callback)</td> <td style="padding:15px">Returns an array of objects with host record type.</td> <td style="padding:15px">{base_path}/{version}/v1/getHostRecordsByHint?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getKSK(entityId, format, callback)</td> <td style="padding:15px">Returns a string containing all active Key Signing Keys (KSK) for a given entityId value in a speci</td> <td style="padding:15px">{base_path}/{version}/v1/getKSK?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNetworkLinkedProperties(networkId, callback)</td> <td style="padding:15px">Returns an array of IP addresses with linked records and the IP addresses that are assigned as DHCP</td> <td style="padding:15px">{base_path}/{version}/v1/getNetworkLinkedProperties?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getZonesByHint(containerId, count, options, start, callback)</td> <td style="padding:15px">Returns an array of accessible zones of child objects for a given containerId value.</td> <td style="padding:15px">{base_path}/{version}/v1/getZonesByHint?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">moveResourceRecord(destinationZone, resourceRecordId, callback)</td> <td style="padding:15px">Moves resource records between different zones that already exist.</td> <td style="padding:15px">{base_path}/{version}/v1/moveResourceRecord?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">searchResponsePolicyItems(count, keyword, properties, scope, start, callback)</td> <td style="padding:15px">Searches Response Policy items configured in local Response Policies or predefined BlueCat Security</td> <td style="padding:15px">{base_path}/{version}/v1/searchResponsePolicyItems?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateDNSDeploymentOption(body, callback)</td> <td style="padding:15px">Updates DNS options.</td> <td style="padding:15px">{base_path}/{version}/v1/updateDNSDeploymentOption?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">uploadResponsePolicyItems(inputStream, parentId, body, callback)</td> <td style="padding:15px">Uploads one response policy file containing a list of fully qualified domain names (FQDNs).</td> <td style="padding:15px">{base_path}/{version}/v1/uploadResponsePolicyItems?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addAccessRight(entityId, overrides, properties, userId, value, callback)</td> <td style="padding:15px">Adds access rights to a specified object.</td> <td style="padding:15px">{base_path}/{version}/v1/addAccessRight?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addDevice(configurationId, deviceSubtypeId, deviceTypeId, ip4Addresses, ip6Addresses, name, properties, callback)</td> <td style="padding:15px">Adds a device to a configuration.</td> <td style="padding:15px">{base_path}/{version}/v1/addDevice?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addDeviceSubtype(name, parentId, properties, callback)</td> <td style="padding:15px">Adds a device sub-type to Address Manager.</td> <td style="padding:15px">{base_path}/{version}/v1/addDeviceSubtype?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addDeviceType(name, properties, callback)</td> <td style="padding:15px">Adds a device type to Address Manager.</td> <td style="padding:15px">{base_path}/{version}/v1/addDeviceType?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addMACAddress(configurationId, macAddress, properties, callback)</td> <td style="padding:15px">Adds MAC addresses.</td> <td style="padding:15px">{base_path}/{version}/v1/addMACAddress?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addTag(name, parentId, properties, callback)</td> <td style="padding:15px">Adds object tags.</td> <td style="padding:15px">{base_path}/{version}/v1/addTag?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addTagGroup(name, properties, callback)</td> <td style="padding:15px">Adds object tag groups.</td> <td style="padding:15px">{base_path}/{version}/v1/addTagGroup?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addUser(password, properties, username, callback)</td> <td style="padding:15px">Adds Address Manager users.</td> <td style="padding:15px">{base_path}/{version}/v1/addUser?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addUserGroup(name, properties, callback)</td> <td style="padding:15px">Adds user groups.</td> <td style="padding:15px">{base_path}/{version}/v1/addUserGroup?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">associateMACAddressWithPool(configurationId, macAddress, poolId, callback)</td> <td style="padding:15px">Associates a MAC address with a MAC pool.</td> <td style="padding:15px">{base_path}/{version}/v1/associateMACAddressWithPool?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">breakReplication(callback)</td> <td style="padding:15px">Breaks replication and returns each server to its original stand-alone state.</td> <td style="padding:15px">{base_path}/{version}/v1/breakReplication?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">configureStreamingReplication(compressReplication, latencyCriticalThreshold, latencyWarningThreshold, properties, standbyServer, callback)</td> <td style="padding:15px">Enables database replication on a remote system in order to automate the setup of replication betwe</td> <td style="padding:15px">{base_path}/{version}/v1/configureStreamingReplication?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteAccessRight(entityId, userId, callback)</td> <td style="padding:15px">Deletes an access right for a specified object.</td> <td style="padding:15px">{base_path}/{version}/v1/deleteAccessRight?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">denyMACAddress(configurationId, macAddress, callback)</td> <td style="padding:15px">Denies MAC addresses.</td> <td style="padding:15px">{base_path}/{version}/v1/denyMACAddress?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">establishTrustRelationship(password, properties, remoteIP, username, callback)</td> <td style="padding:15px">Establishes a trust relationship between a maximum of three Address Manager servers, which is a pre</td> <td style="padding:15px">{base_path}/{version}/v1/establishTrustRelationship?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">failoverReplication(properties, standbyServer, callback)</td> <td style="padding:15px">Performs a manual replication failover.</td> <td style="padding:15px">{base_path}/{version}/v1/failoverReplication?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAccessRight(entityId, userId, callback)</td> <td style="padding:15px">Retrieves an access right for a specified object.</td> <td style="padding:15px">{base_path}/{version}/v1/getAccessRight?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAccessRightsForEntity(count, entityId, start, callback)</td> <td style="padding:15px">Returns an array of access rights for entities.</td> <td style="padding:15px">{base_path}/{version}/v1/getAccessRightsForEntity?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAccessRightsForUser(count, start, userId, callback)</td> <td style="padding:15px">Returns an array of access rights for a specified user.</td> <td style="padding:15px">{base_path}/{version}/v1/getAccessRightsForUser?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAllUsedLocations(callback)</td> <td style="padding:15px">Returns a list of location objects that are used to annotate other objects.</td> <td style="padding:15px">{base_path}/{version}/v1/getAllUsedLocations?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getConfigurationGroups(callback)</td> <td style="padding:15px">Gets a list of all configuration groups in Address Manager.</td> <td style="padding:15px">{base_path}/{version}/v1/getConfigurationGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getConfigurationSetting(configurationId, settingName, callback)</td> <td style="padding:15px">Returns the configuration setting.</td> <td style="padding:15px">{base_path}/{version}/v1/getConfigurationSetting?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getConfigurationsByGroup(groupName, properties, callback)</td> <td style="padding:15px">Gets a list of configurations in Address Manager based on the name of a configuration group.</td> <td style="padding:15px">{base_path}/{version}/v1/getConfigurationsByGroup?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getLocationByCode(code, callback)</td> <td style="padding:15px">Returns the location object with the specified hierarchical location code.</td> <td style="padding:15px">{base_path}/{version}/v1/getLocationByCode?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getMACAddress(configurationId, macAddress, callback)</td> <td style="padding:15px">Returns an APIEntity for a MAC address.</td> <td style="padding:15px">{base_path}/{version}/v1/getMACAddress?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getReplicationInfo(properties, callback)</td> <td style="padding:15px">Retrieves information regarding the status of replication in Address Manager through the API.</td> <td style="padding:15px">{base_path}/{version}/v1/getReplicationInfo?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">purgeHistoryNow(numberOfDaysToKeep, numberOfMonthsToKeep, untilWhenTimestamp, waitOption, callback)</td> <td style="padding:15px">Runs the history purge function.</td> <td style="padding:15px">{base_path}/{version}/v1/purgeHistoryNow?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">removeTrustRelationship(otherBAMIP, properties, callback)</td> <td style="padding:15px">Removes a remote Address Manager server from the trust relationship.</td> <td style="padding:15px">{base_path}/{version}/v1/removeTrustRelationship?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">terminateUserSessions(properties, username, callback)</td> <td style="padding:15px">Terminates all active user sessions in Address Manager.</td> <td style="padding:15px">{base_path}/{version}/v1/terminateUserSessions?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateAccessRight(entityId, overrides, properties, userId, value, callback)</td> <td style="padding:15px">Updates access rights for a specified object.</td> <td style="padding:15px">{base_path}/{version}/v1/updateAccessRight?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateConfigurationSetting(configurationId, properties, settingName, callback)</td> <td style="padding:15px">Updates the configuration setting.</td> <td style="padding:15px">{base_path}/{version}/v1/updateConfigurationSetting?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateUserPassword(newPassword, options, userId, callback)</td> <td style="padding:15px">Updates an Address Manager user password.</td> <td style="padding:15px">{base_path}/{version}/v1/updateUserPassword?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addAdditionalIPAddresses(ipsToAdd, properties, serverId, callback)</td> <td style="padding:15px">Adds additional IPv4 addresses and loopback addresses to the Services interface for DNS service.</td> <td style="padding:15px">{base_path}/{version}/v1/addAdditionalIPAddresses?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addDeviceInstance(configName, deviceName, ipAddressMode, ipEntity, macAddressMode, macEntity, options, recordName, viewName, zoneName, callback)</td> <td style="padding:15px">Adds a device instance.</td> <td style="padding:15px">{base_path}/{version}/v1/addDeviceInstance?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP4BlockByCIDR(cIDR, parentId, properties, callback)</td> <td style="padding:15px">Adds a new IPv4 Block using CIDR notation.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP4BlockByCIDR?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP4BlockByRange(end, parentId, properties, start, callback)</td> <td style="padding:15px">Adds a new IPv4 block defined by an address range.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP4BlockByRange?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP4IPGroupByRange(end, name, parentId, properties, start, callback)</td> <td style="padding:15px">Adds an IPv4 IP group by range bounds (start address and end address).</td> <td style="padding:15px">{base_path}/{version}/v1/addIP4IPGroupByRange?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP4IPGroupBySize(name, parentId, positionRangeBy, positionValue, properties, size, callback)</td> <td style="padding:15px">Adds an IPv4 IP group by size.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP4IPGroupBySize?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP4Network(cIDR, blockId, properties, callback)</td> <td style="padding:15px">Adds an IPv4 network using CIDR notation.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP4Network?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP4NetworkTemplate(configurationId, name, properties, callback)</td> <td style="padding:15px">Add an IPv4 network template to the specified configuration.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP4NetworkTemplate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP4ReconciliationPolicy(name, parentId, properties, callback)</td> <td style="padding:15px">Adds an IPv4 reconciliation policy.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP4ReconciliationPolicy?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP6Address(address, containerId, name, properties, type, callback)</td> <td style="padding:15px">Adds an IPv6 address to a specified IPv6 network.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP6Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP6BlockByMACAddress(macAddress, name, parentId, properties, callback)</td> <td style="padding:15px">Adds an IPv6 block by specifying the MAC address of the server.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP6BlockByMACAddress?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP6BlockByPrefix(name, parentId, prefix, properties, callback)</td> <td style="padding:15px">Adds an IPv6 block be specifying the prefix for the block.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP6BlockByPrefix?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addIP6NetworkByPrefix(name, parentId, prefix, properties, callback)</td> <td style="padding:15px">Adds an IPv6 network be specifying the prefix for the network.</td> <td style="padding:15px">{base_path}/{version}/v1/addIP6NetworkByPrefix?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addParentBlock(body, callback)</td> <td style="padding:15px">Adds a parent block.</td> <td style="padding:15px">{base_path}/{version}/v1/addParentBlock?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addParentBlockWithProperties(properties, body, callback)</td> <td style="padding:15px">Adds a parent block with properties.</td> <td style="padding:15px">{base_path}/{version}/v1/addParentBlockWithProperties?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">applyIP4NetworkTemplate(networkId, properties, templateId, callback)</td> <td style="padding:15px">Applies IPv4 network templates.</td> <td style="padding:15px">{base_path}/{version}/v1/applyIP4NetworkTemplate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">assignIP4Address(action, configurationId, hostInfo, ip4Address, macAddress, properties, callback)</td> <td style="padding:15px">Assigns a MAC address and other properties to an IPv4 address.</td> <td style="padding:15px">{base_path}/{version}/v1/assignIP4Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">assignIP4NetworkTemplate(networkId, properties, templateId, callback)</td> <td style="padding:15px">Assigns IPv4 network templates.</td> <td style="padding:15px">{base_path}/{version}/v1/assignIP4NetworkTemplate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">assignIP6Address(action, address, containerId, hostInfo, macAddress, properties, callback)</td> <td style="padding:15px">Assigns an IPv6 address to a MAC address and host.</td> <td style="padding:15px">{base_path}/{version}/v1/assignIP6Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">assignNextAvailableIP4Address(action, configurationId, hostInfo, macAddress, parentId, properties, callback)</td> <td style="padding:15px">Assign the next available IPv4 address.</td> <td style="padding:15px">{base_path}/{version}/v1/assignNextAvailableIP4Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">changeStateIP4Address(addressId, macAddress, targetState, callback)</td> <td style="padding:15px">Converts the state of an address from and between Reserved, DHCP Reserved, and Static, or DHCP Allo</td> <td style="padding:15px">{base_path}/{version}/v1/changeStateIP4Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">clearIP6Address(addressId, callback)</td> <td style="padding:15px">Clears a specified IPv6 address assignment.</td> <td style="padding:15px">{base_path}/{version}/v1/clearIP6Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteDeviceInstance(configName, identifier, options, callback)</td> <td style="padding:15px">Deletes either the IP address or MAC address (and all related DNS entries including host records, P</td> <td style="padding:15px">{base_path}/{version}/v1/deleteDeviceInstance?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAdditionalIPAddresses(adonisID, properties, callback)</td> <td style="padding:15px">Returns IPv4 addresses and loopback addresses added to the Service interface for DNS services.</td> <td style="padding:15px">{base_path}/{version}/v1/getAdditionalIPAddresses?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAliasesByHint(count, options, start, callback)</td> <td style="padding:15px">Returns an array of CNAMEs with linked record name.</td> <td style="padding:15px">{base_path}/{version}/v1/getAliasesByHint?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDiscoveredDevice(deviceId, policyId, callback)</td> <td style="padding:15px">Returns the object ID of the discovered device by running an IPv4 reconciliation policy.</td> <td style="padding:15px">{base_path}/{version}/v1/getDiscoveredDevice?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDiscoveredDeviceArpEntries(deviceId, policyId, callback)</td> <td style="padding:15px">Returns all ARP entries of a specific device discovered by running an IPv4 reconciliation policy.</td> <td style="padding:15px">{base_path}/{version}/v1/getDiscoveredDeviceArpEntries?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDiscoveredDeviceHosts(deviceId, policyId, callback)</td> <td style="padding:15px">Returns all hosts of a specific device discovered by running an IPv4 reconciliation policy.</td> <td style="padding:15px">{base_path}/{version}/v1/getDiscoveredDeviceHosts?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDiscoveredDeviceInterfaces(deviceId, policyId, callback)</td> <td style="padding:15px">Returns all interfaces of a specific device discovered by running an IPv4 reconciliation policy.</td> <td style="padding:15px">{base_path}/{version}/v1/getDiscoveredDeviceInterfaces?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDiscoveredDeviceMacAddressEntries(deviceId, policyId, callback)</td> <td style="padding:15px">Returns all MAC address entries of a specific device discovered by running an IPv4 reconciliation p</td> <td style="padding:15px">{base_path}/{version}/v1/getDiscoveredDeviceMacAddressEntries?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDiscoveredDeviceNetworks(deviceId, policyId, callback)</td> <td style="padding:15px">Returns all networks of a specific device discovered by running an IPv4 reconciliation policy.</td> <td style="padding:15px">{base_path}/{version}/v1/getDiscoveredDeviceNetworks?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDiscoveredDeviceVlans(deviceId, policyId, callback)</td> <td style="padding:15px">Returns all VLANs of a specific device discovered by running an IPv4 reconciliation policy.</td> <td style="padding:15px">{base_path}/{version}/v1/getDiscoveredDeviceVlans?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDiscoveredDevices(policyId, callback)</td> <td style="padding:15px">Returns a list of discovered Layer 2 or Layer 3 devices by running an IPv4 reconciliation policy sp</td> <td style="padding:15px">{base_path}/{version}/v1/getDiscoveredDevices?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIP4Address(address, containerId, callback)</td> <td style="padding:15px">Returns the details for the requested IPv4 address object.</td> <td style="padding:15px">{base_path}/{version}/v1/getIP4Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIP4NetworksByHint(containerId, count, options, start, callback)</td> <td style="padding:15px">Returns an array of IPv4 networks found under a given container object.</td> <td style="padding:15px">{base_path}/{version}/v1/getIP4NetworksByHint?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIP6Address(address, containerId, callback)</td> <td style="padding:15px">Returns an APIEntity for the specified IPv6 address.</td> <td style="padding:15px">{base_path}/{version}/v1/getIP6Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIP6ObjectsByHint(containerId, count, objectType, options, start, callback)</td> <td style="padding:15px">Returns an array of IPv6 objects found under a given container object.</td> <td style="padding:15px">{base_path}/{version}/v1/getIP6ObjectsByHint?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIPRangedByIP(address, containerId, type, callback)</td> <td style="padding:15px">Returns the DHCP range containing the specified IPv4 or IPv6 address.</td> <td style="padding:15px">{base_path}/{version}/v1/getIPRangedByIP?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getLinkedNetworkConflicts(networkId, templateId, callback)</td> <td style="padding:15px">Get a list of deployment options that conflict with the associated networks or network that are lin</td> <td style="padding:15px">{base_path}/{version}/v1/getLinkedNetworkConflicts?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getMaxAllowedRange(rangeId, callback)</td> <td style="padding:15px">Finds the maximum possible address range to which the existing IPv4 DHCP range can be extended.</td> <td style="padding:15px">{base_path}/{version}/v1/getMaxAllowedRange?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNextAvailableIP4Address(parentId, callback)</td> <td style="padding:15px">Returns the IPv4 address for the next available (unallocated) address within a configuration, block</td> <td style="padding:15px">{base_path}/{version}/v1/getNextAvailableIP4Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNextAvailableIP4Network(autoCreate, isLargerAllowed, parentId, size, callback)</td> <td style="padding:15px">Returns the object ID for the next available (unused) network within a configuration or block.</td> <td style="padding:15px">{base_path}/{version}/v1/getNextAvailableIP4Network?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNextAvailableIP6Address(parentId, properties, callback)</td> <td style="padding:15px">Returns the next available IPv6 address within an IPv6 block or network.</td> <td style="padding:15px">{base_path}/{version}/v1/getNextAvailableIP6Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNextAvailableIPRange(parentId, properties, size, type, callback)</td> <td style="padding:15px">Returns the object ID for the next available (unused) block or network within a configuration or bl</td> <td style="padding:15px">{base_path}/{version}/v1/getNextAvailableIPRange?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNextAvailableIPRanges(count, parentId, properties, size, type, callback)</td> <td style="padding:15px">Returns the object IDs for the next available (unused) blocks or networks within a configuration or</td> <td style="padding:15px">{base_path}/{version}/v1/getNextAvailableIPRanges?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNextIP4Address(parentId, properties, callback)</td> <td style="padding:15px">Returns the next available IP addresses in octet notation under specified circumstances.</td> <td style="padding:15px">{base_path}/{version}/v1/getNextIP4Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getTemplateTaskStatus(taskId, callback)</td> <td style="padding:15px">Gets the IPv4 template task status when the template is applied.</td> <td style="padding:15px">{base_path}/{version}/v1/getTemplateTaskStatus?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">isAddressAllocated(configurationId, ipAddress, macAddress, callback)</td> <td style="padding:15px">Queries a MAC address to determine if the address has been allocated to an IP address.</td> <td style="padding:15px">{base_path}/{version}/v1/isAddressAllocated?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">mergeBlocksWithParent(body, callback)</td> <td style="padding:15px">Merges specified IPv4 blocks into a single block.</td> <td style="padding:15px">{base_path}/{version}/v1/mergeBlocksWithParent?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">mergeSelectedBlocksOrNetworks(blockOrNetworkToKeep, body, callback)</td> <td style="padding:15px">Merges specified IPv4 blocks or IPv4 networks into a single IPv4 block or IPv4 network.</td> <td style="padding:15px">{base_path}/{version}/v1/mergeSelectedBlocksOrNetworks?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">moveIPObject(address, objectId, options, callback)</td> <td style="padding:15px">Moves an IPv4 block, IPv4 network, IPv4 address, IPv6 block, or IPv6 network to a new IPv4 or IPv6</td> <td style="padding:15px">{base_path}/{version}/v1/moveIPObject?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">reapplyTemplate(properties, templateId, callback)</td> <td style="padding:15px">Reapplies DNS zone templates.</td> <td style="padding:15px">{base_path}/{version}/v1/reapplyTemplate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">reassignIP6Address(destination, oldAddressId, properties, callback)</td> <td style="padding:15px">Reassigns an existing IPv6 address to a new IPv6 address.</td> <td style="padding:15px">{base_path}/{version}/v1/reassignIP6Address?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">removeAdditionalIPAddresses(ipsToRemove, properties, serverId, callback)</td> <td style="padding:15px">Removes additional IPv4 addresses and loopback addresses from the Services interface.</td> <td style="padding:15px">{base_path}/{version}/v1/removeAdditionalIPAddresses?{quer