Avi Vantage load balancer discovery

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：15分

    • The ServiceNow Discovery and Service Mapping applications use the Avi load balancer discovery patterns to find Avi Vantage load balancer components. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

    Discovery uses the Avi Load Balancer Controller pattern and the Avi Load Balancer Controller - Session-based pattern to run horizontal discovery. Both patterns use set of REST APIs to find the load balancers. They differ only in the type of authentication used when running the API queries.

    For top-down discovery, Service Mapping uses the Avi Load Balancer VIP pattern.

    The patterns support Avi infrastructure residing on AWS and VMware. They relate the discovered CIs to the infrastructure only when run on VMware . The patterns also support Global Server Load Balancing (GSLB).

    You can use these patterns on the ServiceNow AI Platform® using the release Madrid patch 5, New York or later.

    Request apps on the Store

    Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Prerequisites

    • Ensure that your instance supports the Avi Load Balancer CI class models by deploying the latest version of the CMDB CI Class Models store app. Install the application from the ServiceNow Store.
    • For the Avi Load Balancer Controller pattern:
      • In the Avi Controller, ensure that Basic Authentication is allowed.
      • Configure the following credentials:
        1. Navigate to Discovery > Credentials
        2. Click New.
        3. Click Basic Auth Credentials, fill out the form, and then click Submit.
          表 : 1. Credentials form
          Field Description
          Name Credential name.
          Active Option for enabling this credential for discovery. Select this check box to enable discovery.
          Applies to Select All MID servers.
          Order Order in which the platform tries this credential as it attempts to log on to devices. A smaller number indicates that the credential appears higher in the list. Establish the credential order when using large numbers of credentials or when security locks out users after three failed login attempts. If all the credentials have the same order number, or none, the instance tries the credentials in a random order. The default value is 100.
          User name Name of the user for performing Avi Load Balancer discovery.
          Password Password for this user.
        4. Run a Quick Discovery on the IP address of the Avi Controller Cluster.
    • For the Avi Load Balancer Controller - Session-based pattern:
      • Create a Basic Authentication credential with an alias:
        1. Navigate to Connections & Credentials > Connection & Credential Aliases.
        2. Click New.
        3. Enter a unique name for the alias and select Credential for the alias type.
        4. Click Submit.
        5. Open the new alias.
        6. On the Credentials tab, click New.
        7. Select Basic Auth Credentials for the credential type and fill out the form.
          表 : 2. Credentials form
          Field Description
          Name Credential name.
          User name Name of the user for performing Avi Load Balancer discovery.
          Password Password for this user.
        8. Click Update.
      • Create a serverless discovery schedule.

        Then do the following:

        1. In the scheduler, click the Serverless Execution Patterns tab.
        2. Click New.
        3. Fill out the form and then click Submit.
          Field Description
          Name Provide a descriptive name.
          Pattern Select the Avi Load Balancer Controller - Session-based pattern.
        4. Open the record created in the previous steps, and configure these parameters:
          Parameter Description
          IP address The Avi IP address.
          Credential alias The name of the credential alias created above.
    • For the Avi Load Balancer Controller pattern and the Avi Load Balancer Controller - Session-based pattern, provide a user with permissions to send the following API queries.
      • /api/cluster
      • /api/serviceengine
      • /api/pool
      • /api/vimgrvmruntime?controller_vm=true
      • /api/cloud
      • /api/virtualservice
      • /api/serviceenginegroup
      • /api/gslbservice
      • /api/tenant
    • For the Avi Load Balancer VIP pattern:
      • Create an service instance.
      • Before using the Avi Load Balancer VIP pattern, use one of the horizontal Avi load balancer discovery patterns to find the Avi infrastructure.

    Data collected by Discovery during horizontal discovery

    The discovered data includes the following tables and fields.

    Table and field Description
    Avi Controller [cmdb_ci_avi_controller]
    Name [name] Name of the Avi Controller.
    Fully qualified domain name [fqdn] Hostname of the Virtual Machine (VM).
    IP address [ip_address] IP address of the FQDN.
    Avi Service Engine [cmdb_ci_avi_service_engine]
    Name [name] Name of the Avi Service Engine.
    IP address [ip_address] IP address of the Avi Service Engine.
    Version [version] Version of the Avi Service Engine.
    Object ID [object_id] Unique identifier of the Avi Service Engine.
    Avi Controller Cluster [cmdb_ci_avi_controller_cluster]
    Cluster ID [cluster_id] Unique identifier of the Avi Controller Cluster.
    Name [name] Name of the Avi Controller Cluster.
    IP address [ip_address] IP address of the Avi Controller Cluster host.
    Load Balancer Pool [cmdb_ci_lb_pool]
    Name [name] Name of the Load Balancer Pool.
    Server ID [server_id] Unique identifier of the Load Balancer Pool.
    Load Balancing Method [load_balancing_method] Method that Avi Vantage uses to make its load balancing decision. The pattern translates the algorithms as follows:
    • "LB_ALGORITHM_LEAST_CONNECTIONS": "least-connections"
    • "LB_ALGORITHM_ROUND_ROBIN": "round-robin"
    • "LB_ALGORITHM_FASTEST_RESPONSE": "fastest-response"
    • "LB_ALGORITHM_CONSISTENT_HASH": "consistent-hash"
    • "LB_ALGORITHM_LEAST_LOAD": "least-load"
    • "LB_ALGORITHM_FEWEST_SERVERS": "fewest-servers"
    • "LB_ALGORITHM_RANDOM": "random"
    • "LB_ALGORITHM_FEWEST_TASKS": "fewest-tasks"
    • "LB_ALGORITHM_NEAREST_SERVER": "nearest-server"
    Load Balancer Pool Member [cmdb_ci_lb_pool_member]
    Name [name] Name of the Pool Member @ name of the Pool.
    IP address [ip_address] IP address of the Pool Member host.
    Load Balancer Service [cmdb_ci_lb_service]
    Name [name] Name of the Virtual IP (VIP).
    IP address [ip_address] IP address of the VIP.
    Object ID [object_id] Unique identifier of the VIP.
    Port [port] Port of the host VM.
    Avi Tenant [cmdb_ci_avi_tenant]
    name Name of the Tenant​.
    object_id The object_id of the Tenant​.
    tenant_url URL to the Tenant​.

    The Dependency Views map shows discovered load balancer CIs and the relationships between them.


    CIs and connections on a Dependency Views map.

    The following image shows the results of top-down discovery using the Avi Load Balancer VIP pattern.

    図 : 1. Top-down discovery using the Avi Load Balancer VIP pattern

    This image shows top-down discovery using the Avi Load Balancer VIP pattern.

    CI relationships

    These relationships are created to support Avi Load Balancer discovery:
    CI Relationship CI
    Avi Controller Cluster [cmdb_ci_avi_controller_cluster] Cluster of::Cluster Avi Controller [cmdb_ci_avi_controller]
    Avi Tenant [cmdb_ci_avi_tenant​] Hosted on::Hosts Avi Controller Cluster [cmdb_ci_avi_controller_cluster]
    Contains::Contained by Load Balancer Service [cmdb_ci_lb_service]
    Load Balancer Pool [cmdb_ci_lb_pool] Used by::Uses Load Balancer Service [cmdb_ci_lb_service]
    Hosted on::Hosts Avi Controller Cluster [cmdb_ci_avi_controller_cluster]
    Owns::Owned by Load Balancer Pool Member [cmdb_ci_lb_pool_member]
    Avi Service Engine [cmdb_ci_avi_service_engine] Hosted on::Hosts Avi Controller Cluster [cmdb_ci_avi_controller_cluster]
    Avi Controller [cmdb_ci_avi_controller] Contains::Contained by Avi Service Engine [cmdb_ci_avi_service_engine]
    Load Balancer Service [cmdb_ci_lb_service] Used by::Uses Avi Service Engine [cmdb_ci_avi_service_engine]
    Runs on::Runs Avi Controller Cluster [cmdb_ci_avi_controller_cluster]
    Load Balancer Pool Member [cmdb_ci_lb_pool_member] Reference only Avi Controller Cluster [cmdb_ci_avi_controller_cluster]

    Troubleshooting

    If Avi load balancer top-down discovery fails, see KB article KB0824019 for a workaround.

    If the mapping process does not proceed as you expected, follow the following suggestions.
    Symptom Cause Solution
    Discovery fails. The discovery message contains the information about an error caused by the REST timeout. There are many CIs sending the REST call response in the deployment. The MID Server cannot process the REST call response without exceeding the time limit controlled by the mid.sa.cloud.request_timeout parameter. By default, the mid.sa.cloud.request_timeout parameter is set to 30000 milliseconds.
    Increase the value of this parameter on the relevant MID Server and run discovery again.
    注:
    If the Configuration Parameters related list for the relevant MID Server does not show this parameter, you may need to add it.
    Pattern Designer fails during a debug session. The Pattern Designer message contains information about an error caused by a timeout. The Pattern Designer fails because of a timeout during pattern debugging (and not during discovery). By default, the sa.debugger.max_timeoutparameter is set to 240 seconds.

    Increase the value of this parameter on the relevant MID Server.