f5.bigip.tm.sys.software

Module contents

BIG-IP® System Software module

REST URI

http://localhost/mgmt/tm/sys/software

GUI Path

System

REST Kind

tm:sys:software:*

Submodule List

update

BIG-IP® system software update module

class f5.bigip.tm.sys.software.Software(tm)

Bases: f5.bigip.resource.OrganizingCollection

create(**kwargs)

Implement this by overriding it in a subclass of Resource

Raises:

InvalidResource: If method is used.

delete(**kwargs)

Implement this by overriding it in a subclass of Resource

Raises:

InvalidResource: If method is used.

get_collection(**kwargs)

Call to obtain a list of the reference dicts in the instance items

Returns:

list: 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

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.

Submodules

update

BIG-IP® system software update module

REST URI

http://localhost/mgmt/tm/sys/software/update

GUI Path

System --> Software Management --> Update Check

REST Kind

tm:sys:software:update:updatestate

class f5.bigip.tm.sys.software.update.Update(sys)

Bases: f5.bigip.resource.UnnamedResource

BIG-IP® system software update unnamed resource

This is an unnamed resource so it has not ~Partition~Name pattern at the end of its URI.

create(**kwargs)

Create is not supported for unnamed resources

Raises:

UnsupportedMethod: If the method is used

delete(**kwargs)

Delete is not supported for unnamed resources

Raises:

UnsupportedMethod: If the method is used

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

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.