f5.bigip.tm.cm
Module contents
BIG-IP® cluster module
- REST URI
http://localhost/mgmt/tm/cm/
- GUI Path
Device Management
- REST Kind
tm:cm:*
Submodule List
BIG-IP® cluster device submodule |
|
BIG-IP® cluster device-group submodule |
|
Directory: cm module: sync-status. |
|
BIG-IP® cluster traffic-group submodule |
|
BIG-IP® cluster trust-domain submodule |
Submodules
device
BIG-IP® cluster device submodule
- REST URI
http://localhost/mgmt/tm/cm/device/
- GUI Path
Device Management --> Devices
- REST Kind
tm:cm:device:*
device_group
BIG-IP® cluster device-group submodule
- REST URI
http://localhost/mgmt/tm/cm/device-group
- GUI Path
Device Management --> Device Groups
- REST Kind
tm:cm:device-group:*
- class f5.bigip.tm.cm.device_group.Device_Groups(cm)[source]
BIG-IP® cluster device-groups collection.
- class f5.bigip.tm.cm.device_group.Device_Group(device_groups)[source]
BIG-IP® cluster device-group resource
- sync_to()[source]
Wrapper method that synchronizes configuration to DG.
Executes the containing object’s cm
exec_cmd()
method to sync the configuration TO the device-group.- Note::
Both sync_to, and sync_from methods are convenience methods which usually are not what this SDK offers. It is best to execute config-sync with the use of exec_cmd() method on the cm endpoint.
- sync_from()[source]
Wrapper method that synchronizes configuration from DG.
Executes the containing object’s cm
exec_cmd()
method to sync the configuration FROM the device-group.- Note::
Both sync_to, and sync_from methods are convenience methods which usually are not what this SDK offers. It is best to execute config-sync with the use of exec_cmd() method on the cm endpoint.
- class f5.bigip.tm.cm.device_group.Devices_s(device_group)[source]
BIG-IP® cluster devices-group devices subcollection.
- class f5.bigip.tm.cm.device_group.Devices(devices_s)[source]
BIG-IP® cluster devices-group devices subcollection resource.
- update(**kwargs)[source]
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
- Args:
- kwargs (dict): Arbitrary number of keyword arguments.
Keys and associated values to alter on the device.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.put
method where it will be handled according to that API.
- create(**kwargs)[source]
Create the resource on the BIG-IP®.
Uses HTTP POST to the collection URI to create a resource associated with a new unique URI on the device.
- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
All the key-values needed to create the resource.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.post
method where it will be handled according to that API.
- Returns:
- Resource: A python object that represents the object’s configuration
and state on the BIG-IP®.
- exists(**kwargs)[source]
Check for the existence of the named object on the BIG-IP
Sends an HTTP GET to the URI of the named object and if it fails with a :exc:~requests.HTTPError` exception it checks the exception for status code of 404 and returns
False
in that case.If the GET is successful it returns
True
.For any other errors are raised as-is.
- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args.
- Returns:
bool: True is the object exists. False otherwise.
- Raises:
requests.HTTPError: Any HTTP error that was not status code 404.
- delete(**kwargs)[source]
Delete the resource on the BIG-IP®.
Uses HTTP DELETE to delete the resource on the BIG-IP®.
After this method is called, and status_code 200 response is received
instance.__dict__
is replace with{'deleted': True}
- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
The only current use is to pass kwargs to the requests API.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
sync_status
Directory: cm module: sync-status.
- REST URI
https://localhost/mgmt/tm/cm/sync-status?ver=11.6.0
- GUI Path
XXX
- REST Kind
tm:cm:sync-status:*
traffic_group
BIG-IP® cluster traffic-group submodule
- REST URI
http://localhost/mgmt/tm/cm/traffic-group
- GUI Path
Device Management --> Traffic Groups
- REST Kind
tm:cm:traffic-group:*
trust
trust_domain
BIG-IP® cluster trust-domain submodule
- REST URI
http://localhost/mgmt/tm/cm/trust-domain
- GUI Path
Device Management --> Device Trust
- REST Kind
tm:cm:device-group:*