f5.bigip.cm

Module Contents

Classes and functions for configuring BIG-IP

Submodule List

system

class f5.bigip.cm.Cm(bigip)[source]

An organizing collection for CM resources.

Subpackages

Classes and functions for configuring BIG-IP

class f5.bigip.cm.autodeploy.Autodeploy(cm)[source]

An organizing collection for Autodeploy resources.

Submodules

system

class f5.bigip.cm.system.System(shared)[source]
class f5.bigip.cm.system.Authn(system)[source]
class f5.bigip.cm.system.Providers(authn)[source]
class f5.bigip.cm.system.Tmos_s(container)[source]
class f5.bigip.cm.system.Tmos(container)[source]
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 underlying requests.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®.

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 underlying requests.session.put method where it will be handled according to that API.

modify(**kwargs)[source]

Modify the configuration of the resource on device based on patch

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 underlying requests.session.delete method where it will be handled according to that API.

Use the method above to pass query args.