Viewing topologies with direct-launch URLs

You can view specific topologies using a direct-launch URL by setting the topology navigation settings in the URL parameters to directly load a specific topology configuration. This configuration gives you quick access to specific views.

You can obtain a direct-launch URL string from a topology in the IBM Cloud Pak for AIOps console, or create the URL manually.

Before you begin

To obtain a direct-launch URL from the Cloud Pak for AIOps console, complete the process of visualizing a topology. To share a direct-launch URL with other users, those users must have the appropriate role permissions.

About this task

A typical URL starts with the host URL (cluster_address) and the tenant ID:

https://<cluster_address>/aiops/<TENANT ID>/topology-viewer

The cluster_address is the Cloud Pak for AIOps console route. For more information, see Accessing your cluster by using the console.

Tips

  • For filtering a topology, you can specify 'type', and include 'Advanced' resource or relationship filters in your URL (not available for 'Simple' filters).

  • For setting conditions for filters, any filter conditions you set on the Resource management page are maintained in the URL, and can therefore be shared.

Example topology URL

https://cp-console-cp4aiops.apps.mycluster.mydomain.com/aiops/cfd95b7e-3bc7-4006-a4a8-a73a79c71255/topology-viewer?resourceId=sl1RQ5NCR_ykgciQCTkFGA&hops=1&layoutType=5&refreshTime=30000

This example URL includes the following parts:

  • resourceId - Identifies the seed resource.
  • hops - The number of hops from the seed to be included in the topology. In this example, the hops number is set at '1'.
  • layoutType - Specifies the type of display. In this example, the layout type is 5.
  • refreshTime - Specifies how often the view is refreshed. In this example, the refresh time is set at 30000 ms (30 seconds).
  • The hop type is 'element-to-element', which does not have to be specified as it is the default.

For more information about the layout type, see layout information in the topic Viewing a group or resource topology.

Tips: By specifying 'type', you can include Advanced resource or relationship filters in your URL, which are not available for Simple filters. For more information, see the filtering information in the topic Viewing a group or resource topology.

Procedure

Obtain a topology URL from the Cloud Pak for AIOps console

Once you render a topology in the Topology viewer, use the Sharing options drop-down to obtain a direct-launch URL string.

Define a URL manually

You can define a URL by editing the parameters, as shown in the following examples:

  • Empty topology URL

    For a URL to open the Topology viewer with no configurations, use this type of URL:

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer

  • Specify seed resource by ID in the URL

    To open the page and create a visualization from a specific seed resource by ID, use this format:

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceId=<resource_id>

  • Specify seed resource by name in the URL

    To open the page and create a visualization from a specific seed resource by name, use this format.

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceName=<name>

  • Specify seed resource and hops URL

    To open the page and create a visualization from a specific seed resource with a specific number of hops and hop type, use this format.

    The hopType parameter is only required if you use the host-to-host (that is, host) hop type (element-to-element is the default).

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceName=<name>&hops=<hops>&hopType=<host>

  • Specify focus areas for large topologies in the URL

    When you load it, this topology view zooms in on the area specified, preventing very large topologies from being displayed with potentially too much information on view.

    The focusId parameter is required for the topology view to zoom into the area of a particular resource.

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceId=<resource_id>&hops=<hop number>&focusId=<resource_id>

  • Specify more resources to be highlighted in the URL

    Specify an array of resource IDs to highlight more resources in the topology view. These selections override any already selected seed resource.

    The selectedIds parameter is required for the topology view to highlight non-seed resources when the topology is loaded.

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceId=<resource_id>&hops=<number>&selectedIds=["<resource_id>" "" …]

  • Specify seed resource, hops and get neighbor expansions URL

    To open the page and create a visualization from a specific seed resource with a specific number of hops, as well as resource neighbors, use this format.

    This example sets the hop type as element-to-element, and it uses the parameter neighbourRequests, which expects an array of space separated ID strings.

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceName=<name>&hops=<hops>&neighbourRequests=["<resource_id>" "<resource id>" …]

  • Specify search parameter (partial resource name) in the URL

    To open the page and create a visualization from a specific resource search value, use this format.

    • If a single resource is found that matches the search parameter, the resource is used as a seed and the topology is drawn.
    • If more than one resource is found that matches the parameter, the Search Results page is displayed listing possible results, including their names, types and other resource properties.
    • If no matches are found, an error message is displayed.

    This example searches for a resource by name, and will return results that match the name either fully or partially.

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?search=<name>

  • Load topology using unique ID to set seed

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceUniqueId=<unique id>

  • Load topology using advanced resource filters

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceFilter=["Type1" "Type2"]

  • Load topology using advanced relationship filters

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?relationFilter=["Type1" "Type2"]

  • Show topology at a specific point in time.

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceName=<name>..<any other configuration>..&time=<unixTimeMilliseconds>

  • Show topology in delta history mode, with 'time' as a reference point and deltaTime as the point to delta against

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?resourceName=<name>..<any other configuration>..&time=<unixTimeMilliseconds>&deltaTime=<unixTimeMilliseconds>

  • Load topology with side toolbar hidden

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?hideToolbar=<true>

  • Load topology with top search bar hidden

    https://<cluster_address>/aiops/<TENANT ID>/topology-viewer?hideSearch=<true>

  • Load topology using simple filters in the URL

    You can use simple filters to include specific resource or relationship types, or severities.

    simpleResourceFilter

    https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleResourceFilter=type1,type2

    simpleRelationshipFilter

    https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleRelationshipFilter=type1,type2

    simpleSeverityFilter

    https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleSeverityFilter=clear,critical

    You can extend the use of these simple filters by activating 'Include mode' for a group using the following parameters:

    • includeResourceType
    • includeRelationshipType
    • includeSeverityType

    Examples:

    https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleResourceFilter=type1,type2&includeResourceType=true

    https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleRelationshipFilter=type1,type2&includeRelationshipType=true

    https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleSeverityFilter=clear,critical&includeSeverityType=true

What to do next

With direct-launch URLs for topology visualizations created, you can save the URLs for quick access to specific views, or share them with other users to provide them with specific, instant information.