Example

Code

BIGIP.example(path: str) → bigrest.common.restobject.RESTObject

Gets an example of an object from the device.

Sends an HTTP GET request to the iControl REST API.

Parameters:path – HTTP path used in the HTTP request sent to the device.
Exceptions:
RESTAPIError: Raised when iControl REST API returns an error.

Example

node = device.example(f"/mgmt/tm/ltm/node")
print("Print node example:")
print(node)

Explanation

Get an example representation of the object from the device.
It provides a list of properties and also an explanation for each property.
Similar to create an object via the GUI and select the help tab.