This document applies to vendor-specific IPAM integration in VMware Aria Automation SaaS and VMware Aria Automation on-prem using the available IPAM SDK.

The goal of this document is to provide the information needed by external IPAM providers to integrate their external IPAM system with the Automation Assembler service in VMware Aria Automation. Reference this document when building a custom external IPAM integration for VMware Aria Automation.

IPAM integration with VMware Aria Automation.

After you create the external IPAM integration package using the instruction provided in this document, you can use the following workflow scenarios in the Automation Assembler product documentation to create and use the IPAM integration point.

Note: New IPAM SDK integration packages are released periodically. The format of the IPAM SDK integration package may change based on the introduction of new SDK packages. To support backward compatibility, the existing format continues to be supported but use of the updated format is preferred.

Revision history

Date Version Description
October 17, 2019 1.0 Initial version.
December 6, 2019 1.1 Title change and note about forthcoming SDK.
April 14, 2020 1.2 Includes SDK and documentation updates for IPAM SDK 1.0.0.
June 07, 2020 1.3 Column title correction from Optional to Required in Baseline contract.
June 20, 2020 1.4 Add link to IPAM SDK video and blog post.
September 9, 2020 1.5 Language cleanup.
October 6, 2020 1.6 Add IPAM SDK 1.1.0 links and information.
January 21, 2021 1.7 Update Entity: information for ResourceInfo, AddressInfo, IpDeallocation, IpRangeAllocation, IpRangeDeallocation.
September 15, 2021 1.8 Update.