f5.bigip.tm.vcmp

Module contents

BIG-IP® VCMP (vcmp) module

REST URI

http://localhost/mgmt/tm/vcmp/

GUI Path

vCMP

REST Kind

tm:vcmp:*

Submodule List

guest

BIG-IP® Guest (vcmp) module

virtual_disk

BIG-IP® Guest (vcmp) module

class f5.bigip.tm.vcmp.Vcmp(tm)[source]

Submodules

guest

BIG-IP® Guest (vcmp) module

REST URI

http://localhost/mgmt/tm/vcmp/guest/

GUI Path

Guest List

REST Kind

tm:vcmp:guest:*

class f5.bigip.tm.vcmp.guest.Guests(vcmp)[source]

BIG-IP® Guests collection.

class f5.bigip.tm.vcmp.guest.Guest(guests)[source]

BIG-IP® Guest resource.

virtual_disk

BIG-IP® Guest (vcmp) module

REST URI

http://localhost/mgmt/tm/vcmp/virtual-disk/

GUI Path

Virtual Disk List

REST Kind

tm:vcmp:virtual-disk:*

class f5.bigip.tm.vcmp.virtual_disk.Virtual_Disks(vcmp)[source]
class f5.bigip.tm.vcmp.virtual_disk.Virtual_Disk(collection)[source]
load(**kwargs)[source]

Loads a given resource

Loads a given resource provided a ‘name’ and an optional ‘slot’ parameter. The ‘slot’ parameter is not a required load parameter because it is provided as an optional way of constructing the correct ‘name’ of the vCMP resource.

Parameters:

kwargs

Returns:

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

Use the method above to pass query args.

modify(**kwargs)[source]

Modify the configuration of the resource on device based on patch

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.