f5.bigip.cm¶
Module Contents¶
Classes and functions for configuring BIG-IP
Submodule List¶
device |
|
device_group |
|
traffic_group |
-
class
f5.bigip.cm.Cm(bigip)[source]¶ Bases:
f5.bigip.resource.OrganizingCollectionAn organizing collection for CM resources.
-
create(**kwargs)¶ Implement this by overriding it in a subclass of Resource
Raises: InvalidResource
-
delete(**kwargs)¶ Implement this by overriding it in a subclass of Resource
Raises: InvalidResource
-
get_collection(**kwargs)¶ Call to obtain a list of the reference dicts in the instance items
Returns: List of self.items
-
modify(**patch)¶ Modify the configuration of the resource on device based on patch
-
raw¶ Display the attributes that the current object has and their values.
Returns: A dictionary of attributes and their values
-
refresh(**kwargs)¶ Use this to make the device resource be represented by self.
This method makes an HTTP GET query against the device service. This method is run for its side-effects on self. If successful the instance attribute __dict__ is replaced with the dict representing the device state. To figure out what that state is, run a subsequest query of the object like this: As with all CURDLE methods use a “requests_params” dict to pass parameters to requests.session.HTTPMETHOD. See test_requests_params.py for an example. >>> resource_obj.refresh() >>> print(resource_obj.raw)
-
update(**kwargs)¶ Update the configuration of the resource on the BIG-IP®.
This method uses HTTP PUT alter the resource state on the BIG-IP®.
The attributes of the instance will be packaged as a dictionary. That dictionary will be updated with kwargs. It is then submitted as JSON to the device.
Various edge cases are handled: * read-only attributes that are unchangeable are removed
Parameters: kwargs – keys and associated values to alter on the device NOTE: If kwargs has a ‘requests_params’ key the corresponding dict will be passed to the underlying requests.session.put method where it will be handled according to that API. THIS IS HOW TO PASS QUERY-ARGS!
-
Subpackages¶
Classes and functions for configuring BIG-IP
-
class
f5.bigip.cm.autodeploy.Autodeploy(cm)[source]¶ Bases:
f5.bigip.resource.OrganizingCollectionAn organizing collection for Autodeploy resources.
-
create(**kwargs)¶ Implement this by overriding it in a subclass of Resource
Raises: InvalidResource
-
delete(**kwargs)¶ Implement this by overriding it in a subclass of Resource
Raises: InvalidResource
-
get_collection(**kwargs)¶ Call to obtain a list of the reference dicts in the instance items
Returns: List of self.items
-
modify(**patch)¶ Modify the configuration of the resource on device based on patch
-
raw¶ Display the attributes that the current object has and their values.
Returns: A dictionary of attributes and their values
-
refresh(**kwargs)¶ Use this to make the device resource be represented by self.
This method makes an HTTP GET query against the device service. This method is run for its side-effects on self. If successful the instance attribute __dict__ is replaced with the dict representing the device state. To figure out what that state is, run a subsequest query of the object like this: As with all CURDLE methods use a “requests_params” dict to pass parameters to requests.session.HTTPMETHOD. See test_requests_params.py for an example. >>> resource_obj.refresh() >>> print(resource_obj.raw)
-
update(**kwargs)¶ Update the configuration of the resource on the BIG-IP®.
This method uses HTTP PUT alter the resource state on the BIG-IP®.
The attributes of the instance will be packaged as a dictionary. That dictionary will be updated with kwargs. It is then submitted as JSON to the device.
Various edge cases are handled: * read-only attributes that are unchangeable are removed
Parameters: kwargs – keys and associated values to alter on the device NOTE: If kwargs has a ‘requests_params’ key the corresponding dict will be passed to the underlying requests.session.put method where it will be handled according to that API. THIS IS HOW TO PASS QUERY-ARGS!
-