Example: VRF navigation - 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 overlapping VRFs on devices

  1. Request a token for authenticating API requests using GET v1/login
  2. Create a JSON description for VRF UDL
    Sample addLinkDefinitionJson
    {
        "linkType":"VRF",
        "displayName": "VRF",
        "sourceEntityTypes": ["Device"],
        "destinationEntityTypes": ["IP4Block"]
    }
  3. Create VRF UDL using POST v1/addUserDefinedLink with the VRF UDL JSON description for the addLinkDefinitionJson parameter
  4. Link entities to the VRF UDL using PUT v1/linkEntitiesEx with a linkEntitiesJson parameter containing the entity IDs
    Link a device to an address block: Enter the object ID of the device as the sourceEntityId, and the object ID of the address block as the destinationEntityId.
    Sample linkEntitiesJson
    {
        "linkType": "VRF",
        "sourceEntityId": "100903",
        "destinationEntityId": "100901"
    }
  5. Use UDLs to navigate relationships in the Address Manager UI
    1. Browse the Details tab of a linked device or address block in the Address Manager UI. The User Defined Links module will now contain the VRF UDL, allowing easy navigation between addresses and networks.
    2. The VRF UDL can also be navigated from hovering over the UDL on the table view on the Devices tab