CollectionΒΆ
kind
: collectionstate
A collection is similar to an Organizing Collection in it is not a configurable object. Unlike an organiziont collection, however, a collection only contains references to objects (or, resources) of the same type.
Important
When using the SDK, you’ll notice that collection objects are referenced using the plural version of the Resource
objects they contain. When the Resource
object’s type is plural (ends in an s
), you need to add _s
to the name when referring to the collection.
This _s
rule applies to all object collections where the object in the collection already ends in s
.
Examples:
- LTM Pool objects are collected in
f5.bigip.tm.ltmpool.Pools
and are accessible via the pathf5.bigip.pools.get_collection()
. - Network Tunnels objects are stored in
f5.bip.net.tunnels.Tunnels_s
and are accessible viaf5.bigip.net.tunnels_s.get_collection()
.
Example: Use f5.bigip.resource.Collection.get_collection()
to get a list of the objects in the f5.bigip.tm.ltm.pool
collection.
The items
attribute in the JSON returned contains Resource objects that all share the same kind
. We can tell that these objects are resources because the kind
ends in state
.
{
kind: "tm:ltm:pool:poolcollectionstate",
selfLink: "https://localhost/mgmt/tm/ltm/pool?ver=11.6.0",
items: [
{
kind: "tm:ltm:pool:poolstate",
name: "my_newpool",
partition: "Common",
fullPath: "/Common/my_newpool",
generation: 76,
selfLink: "https://localhost/mgmt/tm/ltm/pool/~Common~my_newpool?ver=11.6.0",
allowNat: "yes",
allowSnat: "yes",
description: "This is my pool",
ignorePersistedWeight: "disabled",
ipTosToClient: "pass-through",
ipTosToServer: "pass-through",
linkQosToClient: "pass-through",
linkQosToServer: "pass-through",
loadBalancingMode: "round-robin",
minActiveMembers: 0,
minUpMembers: 0,
minUpMembersAction: "failover",
minUpMembersChecking: "disabled",
queueDepthLimit: 0,
queueOnConnectionLimit: "disabled",
queueTimeLimit: 0,
reselectTries: 0,
serviceDownAction: "none",
slowRampTime: 10,
membersReference: {
link: "https://localhost/mgmt/tm/ltm/pool/~Common~my_newpool/members?ver=11.6.0",
isSubcollection: true
}
},
{
kind: "tm:ltm:pool:poolstate",
name: "mypool",
partition: "Common",
fullPath: "/Common/mypool",
generation: 121,
selfLink: "https://localhost/mgmt/tm/ltm/pool/~Common~mypool?ver=11.6.0",
allowNat: "yes",
allowSnat: "yes",
ignorePersistedWeight: "disabled",
ipTosToClient: "pass-through",
ipTosToServer: "pass-through",
linkQosToClient: "pass-through",
linkQosToServer: "pass-through",
loadBalancingMode: "round-robin",
minActiveMembers: 0,
minUpMembers: 0,
minUpMembersAction: "failover",
minUpMembersChecking: "disabled",
queueDepthLimit: 0,
queueOnConnectionLimit: "disabled",
queueTimeLimit: 0,
reselectTries: 0,
serviceDownAction: "none",
slowRampTime: 10,
membersReference: {
link: "https://localhost/mgmt/tm/ltm/pool/~Common~mypool/members?ver=11.6.0",
isSubcollection: true
}
},
]
}