Get Object Configuration

Gets the configuration of an object as stored in the AppViewX inventory. Supports both the latest configuration and also the configuration known at a given time if any.

Note: The configuration is not fetched from the device real-time but from the AppViewX inventory.

URL: /adc-object-configuration

Type: POST

Parameters

ParamType Name Description Field Type
Header sessionId ** Session Id received after login string
Query Gwkey Tenant Key. Needed only in case of multitenant installations string
Query gwsource** Source from which the request is triggered (Eg: web, external) String
Payload input**

Input filter key and value to perform the search. Multiple key and value pairs can also be mentioned. Supported keys :

  • deviceName
  • objectType
  • vendor
  • partition
  • etc.
 Key:value
Payload timeStamp To get the known configuration at the given time mention the time stamp as well. If not mentioned the latest known configuration will be returned. Long

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
400 Bad request Invalid Object type, Invalid Request
200 OK Configuration found for the given object.
404 Not found Config data not found for the given object details

Sample Request/Response

Use Case

Get the known object configuration available at the time 1549362738957(time in milliseconds) for the Virtual server with name Event_test in the partition Test_parti-tion.1 on the device device_1.

Request URL

http://appviewxapi.com/avxapi/adc-object-configuration?gwkey=f000ca01&gwsource=external

Request Payload

{ "payload": { "object": { "deviceName": "device_1", "objectType": "VirtualServer", "partition": "Test_parti-tion.1", "objectName": "Event_test" }, "timeStamp": 1549362738957 } }

Response

{ "response": "** Virtual Server - Event_test **\nltm virtual /Test_parti-tion.1/Event_test {\n destination /Common/2.2.2.2:5004\n disabled\n ip-protocol tcp\n mask 255.255.255.255\n profiles {\n /Common/tcp { }\n }\n source 0.0.0.0/0\n translate-address enabled\n translate-port enabled\n}\n\n** Profile - tcp **\nltm profile tcp tcp {\n ack-on-push enabled\n close-wait-timeout 5\n congestion-control high-speed\n deferred-accept disabled\n delayed-acks enabled\n ecn disabled\n fin-wait-timeout 5\n idle-timeout 300\n keep-alive-interval 1800\n limited-transmit enabled\n max-retrans 8\n nagle disabled\n proxy-buffer-high 49152\n proxy-buffer-low 32768\n proxy-mss disabled\n proxy-options disabled\n receive-window-size 65535\n reset-on-timeout enabled\n selective-acks enabled\n send-buffer-size 65535\n slow-start enabled\n syn-max-retrans 3\n time-wait-recycle enabled\n time-wait-timeout 2000\n timestamps enabled\n}\n\n", "message": "Configuration found for the given object.", "appStatusCode": null, "tags": null, "headers": null }