Example: NAT 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 and navigate NAT

  1. Request a token for authenticating API requests using GET v1/login
  2. Create a JSON description for NAT UDL
    Sample addLinkDefinitionJson
    {
        "linkType": "NAT",
        "displayName": "NAT",
        "sourceEntityTypes": ["IP4Network","IP4Addr","IP4Ranged"],
        "destinationEntityTypes": ["IP4Network","IP4Addr","IP4Ranged"]
    }
  3. Create NAT UDL using POST v1/addUserDefinedLink with the NAT UDL JSON description for the addLinkDefinitionJson parameter
  4. Link entities to the NAT UDL using PUT v1/linkEntitiesEx with a linkEntitiesJson parameter containing the entity IDs
    Create a 1:n NAT between a public IP and private network: Enter the object ID of the public IP address as the sourceEntityId, and the object ID of the private network as the destinationEntityId.
    Create a static 1:1 NAT between IP addresses (ex. public IP to private IP): Enter the object ID of the public IP address as the sourceEntityId, and the object ID of the private IP address as the destinationEntityId.
    Sample linkEntitiesJson
    {
        "linkType": "NAT",
        "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 NAT UDL, allowing easy navigation between addresses and 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.