Lab 1.1: Exploring the iControl REST API¶

Task 1 – Explore the API using the TMOS Web Interface¶

In this lab we will explore the API using an interface that is built-in to TMOS. This utility is useful for understanding how TMOS objects map to the REST API. The interfaces implement full Create, Read, Update and Delete (CRUD) functionality, however, in most practical use cases it’s far easier to use this interface as a ‘Read’ tool rather than trying to Create objects directly from it. It’s usually far easier to use TMUI or TMSH to create the object as needed and then use this tool to view the created object with all the correct attributes already populated.

1. Open Google Chrome and navigate to the following bookmarks: BIG-IP

GUI. Bypass any SSL errors that

appear and ensure you see the login screen for each bookmark.

1. Navigate to the URL https://10.1.1.4/mgmt/toc (or click the BIG-IP REST TOC bookmark). The ‘/mgmt/toc’ path in the URL is available on all TMOS versions 11.6 or newer.

2. Authenticate to the interface using the default admin/admin credentials.

3. You will now be presented with a top-level list of various REST resources. At the top of the page there is a search box that can be used to find items on the page. Type ‘net’ in the search box and then click on the ‘net’ link under iControl REST Resources:

4. Find the /mgmt/tm/net/route-domain Collection and click it.

5. You will now see a listing of the Resources that are part of the route-domain(s) collection. As you can see the default route domain of 0 is listed. You can also create new objects by clicking the button. Additionally resources can be deleted using the button or edited using the button.

6. Click the 0 resource to view the attributes of route-domain 0 on the device:

   

   Take note of the full path to the resource. Here is how the path is broken down:

   / mgmt / tm / net / route-domain / ~Common~0
   | Root | OC | OC  |  Collection  | Resource
   *OC=Organizing Collection