Example: Dual Stack - BlueCat Address Manager - 9.3.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.3.0

Adding a UDL to document and navigate Dual Stacked addresses and networks

  1. Request a token for authenticating API requests using GET v1/login
  2. Create a JSON description for DualStack UDL
    Sample addLinkDefinitionJson
    {
        "linkType":"DualStack",
        "displayName": "DualStack",
        "sourceEntityTypes": ["IP4Network", "IP4Addr"],
        "destinationEntityTypes": ["IP6Network", "IP6Addr"]
    }
  3. Create DualStack UDL using POST v1/addUserDefinedLink with the DualStack UDL JSON description for the addLinkDefinitionJson parameter
  4. Link entities to the DualStack UDL using PUT v1/linkEntitiesEx with a linkEntitiesJson parameter containing the entity IDs
    Linking networks: Enter the object ID of the IPv4 network as the sourceEntityId, and the object ID of the IPv6 network as the destinationEntityId.
    Linking addresses: Enter the object ID of the IPv4 address as the sourceEntityId, and the object ID of the IPv6 address as the destinationEntityId.
    Sample linkEntitiesJson
    {
        "linkType": "DualStack",
        "sourceEntityId": "100903",
        "destinationEntityId": "100901"
    }
  5. Use UDLs to navigate relationships in the Address Manager UI
    1. Browse the Details tab of a linked network or address in the Address Manager UI. The User Defined Links module will now contain the DualStack UDL, allowing easy navigation between IPv4 and IPv6 networks.
    2. For easier navigation, a UDL field can be added to the Addresses table of a network. In the Customize Table option menu, UDLs will be available Customizable Columns. Select and move a UDL from the Available to Selected group using the UI arrows, then click Update to add a column for UDL information on the Addresses table.