f5.bigip.tm.shared

Module contents

BIG-IP® Shared (shared) module

REST URI

http://localhost/mgmt/tm/shared/

GUI Path

System

REST Kind

N/A – HTTP GET returns an error

Submodule List

bigip_failover_state	BIG-IP® shared failover state module
licensing	BIG-IP® system failover module

class f5.bigip.tm.shared.Shared(bigip)

Bases: f5.bigip.resource.PathElement

BIG-IP® System Shared Utility (shared) collection.

raw

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

Returns:A dictionary of attributes and their values

Submodules

bigip_failover_state

BIG-IP® shared failover state module

REST URI

http://localhost/mgmt/tm/shared/bigip-failover-state

GUI Path

N/A

REST Kind

tm:shared:licensing:*

class f5.bigip.tm.shared.bigip_failover_state.Bigip_Failover_State(shared)

Bases: f5.bigip.resource.UnnamedResource

BIG-IP® failover state information

Failover state objects only support the load() method because they cannot be modified via the API.

Note

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

update(**kwargs)

Update is not supported for BIG-IP® failover state.

Raises:UnsupportedOperation

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)

licensing

BIG-IP® system failover module

REST URI

http://localhost/mgmt/tm/shared/license

GUI Path

System --> License

REST Kind

tm:shared:licensing:*

class f5.bigip.tm.shared.licensing.Licensing(shared)

Bases: f5.bigip.resource.PathElement

BIG-IP® licensing stats and states.

Licensing objects themselves do not support any methods and are just containers for lower level objects.

Note

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

raw

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

Returns:A dictionary of attributes and their values

class f5.bigip.tm.shared.licensing.Activation(licensing)

Bases: f5.bigip.resource.UnnamedResource

BIG-IP® license activation status

Activation state objects only support the load() method because they cannot be modified via the API.

Note

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

update(**kwargs)

Update is not supported for License Activation

Raises:UnsupportedOperation

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)

class f5.bigip.tm.shared.licensing.Registration(licensing)

Bases: f5.bigip.resource.UnnamedResource

BIG-IP® license registration status

Registration state objects only support the load() method because they cannot be modified via the API.

Note

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

update(**kwargs)

Update is not supported for License Registration

Raises:UnsupportedOperation

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)