Organizing Collection

kind: collectionstate

In iControl® REST, the URI represents the tree structure of modules and components in the BIG-IP®. The root is represented by mgmt; the REST API representation of the BIG-IP® module follows.

The REST representations of BIG-IP® modules which contain submodules are called organizing collections. In the above example, /tm/ is an organizing collection. Its submodules – ‘Statistics’, ‘iApps’, ‘DNS’, ‘Local Traffic’, etc. – are all organizing collections as well.

The F5® SDK follows the same mapping model as the REST API. Organizing collections, which appear under f5.bigip, correspond to the various modules available on the BIG-IP®.

OrganizingCollection objects are not configurable; rather, they contain other submodules which either contain configurable objects (Collection) or are configurable objects (Resource).