Search - LTM and GTM Pool

Before You Begin

Before attempting to search for the pool(s) and associated pool members with this API, users must ensure any of the ACF permission is available:

ADC > Control Center
ADC > Dashboard > Application Widget
ADC > Orphan objects

This can be checked under Accounts > Role > Authorized Functions.

Request Structure


Endpoint:	`/adc-controlcenter-pool-object-search`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-controlcenter-pool-object-search ?gwsource=external` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Input Parameter
Name	Description
sessionId `Header`	(Mandatory) Specifies the session ID of the user session received after login. Type: String Constraints: The session ID is used when username and password are not provided.
username `Header`	(Mandatory) Specifies the login username used to access the AppViewX. Type: String Constraints: The username, along with the password, is used when the session ID is not provided.
password `Header`	(Mandatory) Specifies the login password used to access the AppViewX. Type: String Constraints: The password, along with the username, is used when the session ID is not provided.
Content-Type `Header`	(Mandatory) Specifies the format of the data in the payload. Type: String Constraints: The value of this param must be ‘application/json’.
gwsource `Query`	(Mandatory) Specifies the source from which the request is triggered. The options are: web external Type: String
payload `Body`	(Mandatory) Contains all the params to be sent in the request body for the post request. See Payload section for more details.

Payload


Name	Description
deviceName `String`	(Mandatory) Device name of the pool to be searched for.
objectName `String`	(Mandatory) Object name to be searched.
objectType `String`	(Mandatory) GTM pool and LTM pool have to be searched. Constraints: Value of param should be TM pool or WideIP Pool or both.
partition `String`	(Optional) Partition in which the pool lies.
recordType `String`	(Optional) Pool record type.
orphan `Boolean`	(Optional) Flag to get orphan objects.

Response Structure

Status Code: 200 OK
Message: Successful
Headers:
- Content-Type: application/json


Name	Description
response `String`	Contains the requested pool objects and pool members.
message `String`	Failure description in case of error
appStatusCode `String`	Application-specific status code for the response. It will be non-null for failure response.
tags `String`	More info in case of a failed response.

Response


Name	Description
result `Object`	Contains result object

Object


Name	Description
Object `Object[]`	List of objects from the database that match the input query.

Status Codes


HTTP Status Code	appStatusCode	Message
200 Ok	-	Refer to sample response
404 Not Found	AVX_GW_009	Resource not found, reason - Invalid apiid
400	avx-common-028	Invalid/ Incorrect payload

Sample Request/Response

Use Case

Search pool object with mandatory and optional parameters.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-controlcenter-pool-object-search

Sample Request

{
   "payload": {
       "objects": [
           {
               "objectType": "ltm Pool",
               "deviceName": "192.168.42.150",
               "objectName": "pool_demo36_80",
               "orphan" : true
           }
       ]
   }
}

Sample Response

{
   "response": {
       "result": {
           "objects": [
               {
                   "id": "lp:@60518caecc48a15dda15a673:@pool_demo36_80:@Common",
                   "name": "pool_demo36_80",
                   "deviceName": "192.168.42.150",
                   "objectType": "ltm Pool",
                   "code": "lp",
                   "displayName": "pool_demo36_80/192.168.42.150/F5",
                   "orphan": true,
                   "recordType": null,
                   "status": "ENABLED",
                   "statusCode": "UNKNOWN ENABLED",
                   "childs": [
                       {
 "id":"lpm:@6051da15a73:@pool_demo36_80:@Common::192.168.40.31:80:@Common",
                           "name": "192.168.40.31:80",
                           "code": "lpm",
                             "displayName": "192.168.40.31:80/192.168.40.31:80/pool_demo36_80/192.168.42.150/F5",
                           "partition": "Common",
                           "ip": "192.168.40.31",
                           "port": "80",
                           "status": "DISABLED",
                           "statusCode": "UNKNOWN DISABLED",
                           "memberName": "/Common/192.168.40.31",
                           "parentName": "pool_demo36_80",
                           "parentPartion": "Common"
                       }      
     ]
       }
   },
   "message": null,
   "appStatusCode": null,
   "tags": null,
   "headers": null
}

Reference

Understanding the sample URL:

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.

What's Next

Get Object Configuration