f5.bigip.tm.util

Module contents

BIG-IP® Utility (util) module

REST URI

http://localhost/mgmt/tm/util/

GUI Path

System

REST Kind

N/A – HTTP GET returns an error

Submodule List

bash	BIG-IP® utility module
clientssl_ciphers	BIG-IP® utility module
dig	BIG-IP® utility module
get_dossier	BIG-IP® utility module
qkview	BIG-IP® utility module
serverssl_ciphers	BIG-IP® utility module
unix_ls	BIG-IP® utility module
unix_mv	BIG-IP® utility module
unix_rm	BIG-IP® utility module

class f5.bigip.tm.util.Util(bigip)

Bases: f5.bigip.resource.PathElement

raw

Display the attributes that the current object has and their values.

Returns:A dictionary of attributes and their values

Submodules

bash

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/bash

GUI Path

N/A

REST Kind

tm:util:bash:*

class f5.bigip.tm.util.bash.Bash(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

BIG-IP® utility command

Note

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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.

clientssl_ciphers

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/clientssl-ciphers

GUI Path

N/A

REST Kind

tm:util:clientssl-ciphers:*

class f5.bigip.tm.util.clientssl_ciphers.Clientssl_Ciphers(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

BIG-IP® utility command

Note

This is an unnamed resource so it has no ~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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.

dig

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/dig

GUI Path

N/A

REST Kind

tm:util:dig:*

class f5.bigip.tm.util.dig.Dig(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

BIG-IP® utility command

Note

This is an unnamed resource so it has no ~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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.

get_dossier

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/get-dossier

GUI Path

N/A

REST Kind

tm:util:get-dossier:*

class f5.bigip.tm.util.get_dossier.Get_Dossier(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

BIG-IP® utility command

Note

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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.

qkview

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/qkview

GUI Path

N/A

REST Kind

tm:util:qkview:*

class f5.bigip.tm.util.qkview.Qkview(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

BIG-IP® utility command

Note

This is an unnamed resource so it has no ~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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.

serverssl_ciphers

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/serverssl-ciphers

GUI Path

N/A

REST Kind

tm:util:serverssl-ciphers:*

class f5.bigip.tm.util.serverssl_ciphers.Serverssl_Ciphers(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

BIG-IP® utility command

Note

This is an unnamed resource so it has no ~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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.

unix_ls

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/unix-ls

GUI Path

N/A

REST Kind

tm:util:unix-ls:*

class f5.bigip.tm.util.unix_ls.Unix_Ls(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.

unix_mv

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/unix-mv

GUI Path

N/A

REST Kind

tm:util:unix-mv:*

class f5.bigip.tm.util.unix_mv.Unix_Mv(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.

unix_rm

BIG-IP® utility module

REST URI

http://localhost/mgmt/tm/util/unix-rm

GUI Path

N/A

REST Kind

tm:util:unix-rm:*

class f5.bigip.tm.util.unix_rm.Unix_Rm(util)

Bases: f5.bigip.resource.UnnamedResource, f5.bigip.mixins.CommandExecutionMixin

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

exec_cmd(command, **kwargs)

Wrapper method that can be changed in the inheriting classes.

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.