|
22 | 22 |
|
23 | 23 | Examples: |
24 | 24 |
|
25 | | - * Expression: bigip = BigIP('a', 'b', 'c') |
26 | | - * URI Returned: https://a/mgmt/tm/ |
| 25 | + * Expression: bigip = ManagementRoot('a', 'b', 'c') |
| 26 | + * URI Returned: https://a/mgmt/ |
27 | 27 |
|
28 | | - * Expression: bigip.ltm |
| 28 | + * Expression: bigip.tm.ltm |
29 | 29 | * URI Returned: https://a/mgmt/tm/ltm/ |
30 | 30 |
|
31 | | - * Expression: pools1 = bigip.ltm.pools |
| 31 | + * Expression: pools1 = bigip.tm.ltm.pools |
32 | 32 | * URI Returned: https://a/mgmt/tm/ltm/pool |
33 | 33 |
|
34 | 34 | * Expression: pool_a = pools1.create(partition="Common", name="foo") |
|
40 | 40 | We refer to a server-provided resource as a "service". Thus far all URI |
41 | 41 | referenced resources are "services" in this sense. |
42 | 42 |
|
43 | | -We use methods named Create, Refresh, Update, Load, and Delete to manipulate |
| 43 | +We use methods named Create, Refresh, Update, Load, Modify, and Delete to manipulate |
44 | 44 | BIG-IP® device services. |
45 | 45 |
|
46 | 46 | Methods: |
|
53 | 53 | and sets the Resource attrs to the state the device reports |
54 | 54 | * load -- uses HTTP GET, obtains the state of an existing resource on the |
55 | 55 | device and sets the Resource attrs to that state |
| 56 | + * modify -- uses HTTP PATCH to selectively modify named resources submitted |
| 57 | + as keyword arguments |
56 | 58 | * delete -- uses HTTP DELETE, removes the resource from the device, and sets |
57 | 59 | self.__dict__ to {'deleted': True} |
58 | 60 |
|
59 | 61 | Available Classes: |
| 62 | + * PathElement -- the most fundamental class it represent URI elements that |
| 63 | + serve only as place-holders. All other Resources inherit from |
| 64 | + PathElement, though the inheritance may be indirect. PathElement provides |
| 65 | + a constructor to match its call in LazyAttributeMixin.__getattr__. The |
| 66 | + expected behavior is that all resource subclasses depend on this |
| 67 | + constructor to correctly set their self._meta_data['uri']. See |
| 68 | + _set_meta_data_uri for the logic underlying self._meta_data['uri'] |
| 69 | + construction. |
60 | 70 | * ResourceBase -- only `refresh` is generally supported in all resource |
61 | 71 | types, this class provides `refresh`. ResourceBase objects are usually |
62 | | - instantiated via setting lazy attributes. ResourceBase provides a |
63 | | - constructor to match its call in LazyAttributeMixin.__getattr__. The |
64 | | - expected behavior is that all resource subclasses depend on this |
65 | | - constructor to correctly set their self._meta_data['uri']. |
| 72 | + instantiated via setting lazy attributes. |
66 | 73 | All ResourceBase objects (except BIG-IPs) have a container (BIG-IPs |
67 | 74 | contain themselves). The container is the object the ResourceBase is an |
68 | 75 | attribute of. |
|
0 commit comments