Viewing a VCN Topology Map

View a map that shows a visual representation of a VCN topology.

• Console
• CLI
• API

• 1. While viewing a regional map, click a VCN.
  2. If you need to change compartment, click CHANGE COMPARTMENT and select a different compartment.
  3. Click any VCN resource on the map, and in the resource summary click either View VCN routing map or View VCN security map. While viewing one of these map modes, you can easily switch to the other map mode.
  4. To see resources in all compartments nested within the selected compartment, click INCLUDE CHILD COMPARTMENTS.
  5. Elements in the control bar include, from leftmost to rightmost:
     • Map: Displays the selected VCN.
     • To find a resource by name, enter the name in the search window. When a match is found and selected, the view zooms in to that resource.
     • Export Map Data: Exports a zip file containing a high resolution .png map of the resources in the current region and compartment, and a .pdf file containing a lower resolution version of the map plus resource data (such as route tables). This PDF only includes the resource information for the elements seen in the map at the time of export.
     • Refresh: updates the view in the main map window. The view is refreshed every three minutes, but if a change was made since the last refresh you can manually trigger a refresh of the diagram.
     • Filter: Allows you to turn on and off the filters used in the current view.
     • Legend: Displays the symbols used in the map and their meaning.

     Routable resources in the region but not within the specified VCN are shown on the left side of the canvas, separated with a dashed line from the resources (such as subnets and VLANs) inside the chosen VCN. Gateways and DRG attachments are placed on this dashed line, and you can drag them on the line to make the relationships clearer. Resources that aren't routable from the VCN aren't shown.

     The zoom controls are in the lower right corner of the diagram canvas, and you can click the canvas and hold as you move to pan up, down, left, or right. You can also double-click to zoom in.

     Some resources are displayed with both a name and an associated CIDR block. When more than one CIDR block is associated with a resource, a +1 or +2 is added as appropriate (up to +4). The extra CIDR blocks are listed in the details screen for the resource.

     Any connected elements you don't have the needed permissions to view are shown with a tag: . Only the OCID is visible for that resource.

  6. Click any resource on the map (the resource changes color to indicate the selection) to view basic information for that item in the right-hand column. The details presented vary depending on the component you selected.

     For some components, you can also click Open Additional Details to open a details screen for that component. These details are read-only summaries of the basic components for that resource. Links to that resource's details page are provided in case you want to make edits.

     You can Persist Routing Information for subnets and VLANs, which maintains the display of the routing information for connections to and from the resource. Using this control you can display as many or as few routes as you choose.

     You can navigate back to the Network Topology regional map by clicking on the name of the region in the control bar, or by selecting one of the connected VCNs and clicking Go to Region Map in the resource information.

• Use the vcn-topology get command and required parameters to get a virtual network topology for a VCN in the current region and specified compartment:

  oci network vcn-topology get --compartment-id compartment_OCID ... [OPTIONS]

  For a complete list of flags and variable options for CLI commands, see the CLI Command Reference.

• Run the GetVcnTopology operation to get a virtual VCN topology for the current region and specified compartment.

  The response body will contain a single VcnTopology resource, which contains the following resources showing relationships between entities in the VCN:

  • TopologyEntityRelationship
  • TopologyContainsEntityRelationship
  • TopologyAssociatedWithEntityRelationship