f5.bigip.tm.ltm¶
Module contents¶
BIG-IP® Local Traffic Manager™ (LTM®) module.
- REST URI
http://localhost/mgmt/tm/ltm/
- GUI Path
Local Traffic
- REST Kind
tm:ltm:*
Submodule List¶
auth |
BIG-IP® LTM auth submodule. |
data_group |
BIG-IP® LTM data-group submodule. |
default_node_monitor |
BIG-IP® ltm default node monitor module |
ifile |
BIG-IP® LTM ifile submodule. |
lsn_pools |
BIG-IP® Local Traffic Manager™ (LTM®) LSN pool module. |
monitor |
BIG-IP® LTM monitor submodule. |
nat |
BIG-IP® Local Traffic Manager (LTM) Nat module. |
node |
BIG-IP® Local Traffic Manager (LTM) node module. |
persistence |
BIG-IP® Local Traffic Manager (LTM) persistence module. |
policy |
BIG-IP® Local Traffic Manager (LTM) policy module. |
pool |
BIG-IP® Local Traffic Manager™ (LTM®) pool module. |
profile |
BIG-IP® LTM profile submodule. |
rule |
BIG-IP® Local Traffic Manager (LTM) rule module. |
snat |
BIG-IP® Local Traffic Manager (LTM) Snat module. |
snat_translation |
BIG-IP Local Traffic Manager (LTM) SNAT Translation module. |
snatpool |
BIG-IP Local Traffic Manager (LTM) SNAT pool module. |
traffic_class |
BIG-IP Local Traffic Manager (LTM) Traffic Class module. |
virtual |
BIG-IP® Local Traffic Manager (LTM) virtual module. |
virtual_address |
Directory: ltm module: virtual-address. |
-
class
f5.bigip.tm.ltm.
Ltm
(tm)[source]¶ Bases:
f5.bigip.resource.OrganizingCollection
BIG-IP® Local Traffic Manager (LTM) organizing collection.
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
Submodules¶
auth¶
BIG-IP® LTM auth submodule.
- REST URI
http://localhost/mgmt/tm/ltm/auth/
- GUI Path
Local Traffic --> Profiles --> Authentication
- REST Kind
tm:ltm:auth:*
-
class
f5.bigip.tm.ltm.auth.
Auth
(ltm)[source]¶ Bases:
f5.bigip.resource.OrganizingCollection
BIG-IP® LTM Authentication organizing collection.
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Crldp_Servers
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth Crldp Server collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Crldp_Server
(crldp_servers)[source]¶ Bases:
f5.bigip.resource.Resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Kerberos_Delegations
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth Kerberos Delegation collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Kerberos_Delegation
(kerberos_delegations)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth Kerberos Delegation resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ldaps
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth Ldap collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ldap
(ldaps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth Ldap resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ocsp_Responders
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth Ocsp Responder collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ocsp_Responder
(ocsp_responders)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth Ocsp Responder resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Profiles
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth Profile collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Profile
(profiles)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth Profile resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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.ltm.auth.
Radius_s
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth Radius collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Radius
(radius_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth Radius resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Radius_Servers
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth Radius Server collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Radius_Server
(radius_server_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth Radius Server resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ssl_Cc_Ldaps
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth SSL CC LDAP collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ssl_Cc_Ldap
(ssl_cc_ldaps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth SSL CC LDAP resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ssl_Crldps
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth SSL CLRDP collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ssl_Crldp
(ssl_crldps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth SSL CLRDP resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ssl_Ocsps
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth SSL OCSP collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Ssl_Ocsp
(ssl_ocsps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth SSL OCSP resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Tacacs_s
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Auth TACACS+ Server collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.auth.
Tacacs
(tacacs_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Auth TACACS+ Server resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
data_group¶
BIG-IP® LTM data-group submodule.
- REST URI
http://localhost/mgmt/tm/ltm/data-group/
- GUI Path
Local Traffic --> iRules --> Data Group List
- REST Kind
tm:ltm:data-group*
-
class
f5.bigip.tm.ltm.data_group.
Data_Group
(ltm)[source]¶ 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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.data_group.
Internals
(data_groups)[source]¶ Bases:
f5.bigip.resource.Collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.data_group.
Internal
(internals)[source]¶ Bases:
f5.bigip.resource.Resource
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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.ltm.data_group.
Externals
(data_groups)[source]¶ Bases:
f5.bigip.resource.Collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.data_group.
External
(externals)[source]¶ Bases:
f5.bigip.resource.Resource
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)
-
default_node_monitor¶
BIG-IP® ltm default node monitor module
- REST URI
http://localhost/mgmt/tm/ltm/default-node-monitor
- GUI Path
Local Traffic --> Nodes --> Default Monitor
- REST Kind
tm:ltm:default-node-monitor:*
-
class
f5.bigip.tm.ltm.default_node_monitor.
Default_Node_Monitor
(ltm)[source]¶ Bases:
f5.bigip.resource.UnnamedResource
BIG-IP® ltm default node monitor resource
The default node monitor object only supports load and update because it is an unnamed resource.
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
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
ifile¶
BIG-IP® LTM ifile submodule.
- REST URI
http://localhost/mgmt/tm/ltm/ifile/
- GUI Path
Local Traffic --> iRules --> iFiles
- REST Kind
tm:ltm:ifile*
-
class
f5.bigip.tm.ltm.ifile.
Ifiles
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM iFiles collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.ifile.
Ifile
(ifile_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM iFiles resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
lsn_pools¶
BIG-IP® Local Traffic Manager™ (LTM®) LSN pool module.
- REST URI
http://localhost/mgmt/tm/ltm/lsn-pool
http://localhost/mgmt/tm/ltm/lsn-log-profile
- GUI Path
Carrier Grade NAT --> LSN Pools
Carrier Grade NAT --> Logging Profiles --> LSN
- REST Kind
tm:ltm:lsn-pool:*
tm:ltm:lsn-log-profile:*
-
class
f5.bigip.tm.ltm.lsn_pools.
LSN_Pools
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM LSN pool collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.lsn_pools.
LSN_Pool
(lsnpool_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM LSN pool resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.lsn_pools.
LSN_Log_Profiles
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM LSN pool log profile collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.lsn_pools.
LSN_Log_Profile
(LSNLogProfile_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM LSN pool log profile resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
monitor¶
BIG-IP® LTM monitor submodule.
- REST URI
http://localhost/mgmt/tm/ltm/monitor/
- GUI Path
Local Traffic --> Monitors
- REST Kind
tm:ltm:monitor*
-
class
f5.bigip.tm.ltm.monitor.
Monitor
(ltm)[source]¶ 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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Https
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Http monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Http
(https)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Http monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Https_s
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Https monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
HttpS
(https_s)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Https monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Diameters
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® diameter monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Diameter
(diameters)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® diameter monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Dns_s
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Dns monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Dns
(dns_s)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Dns monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Externals
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® external monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
External
(externals)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® external monitor resrouce.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Firepass_s
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Fire Pass monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Firepass
(firepass_s)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® external monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Ftps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Ftp monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Ftp
(ftps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Ftp monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Gateway_Icmps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Gateway Icmp monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Gateway_Icmp
(gateway_icmps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Gateway Icmp monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Icmps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Icmp monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Icmp
(icmps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Icmp monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Imaps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Imap monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Imap
(imaps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Imap monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Inbands
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® in band monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Inband
(inbands)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® in band monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Ldaps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Ldap monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Ldap
(ldaps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Ldap monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Module_Scores
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® module scores monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Module_Score
(gateway_icmps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® module scores monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Mysqls
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® MySQL monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Mysql
(mysqls)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® MySQL monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Mqtts
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Mqtt
(mqtts)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Mssqls
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Mssql monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Mssql
(mssqls)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Mssql monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Nntps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Nntps monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Nntp
(nntps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Nntps monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Nones
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® None monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
NONE
(nones)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® None monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Oracles
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Oracle monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Oracle
(oracles)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Oracle monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Pop3s
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Pop3 monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Pop3
(pop3s)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Pop3 monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Postgresqls
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® PostGRES SQL monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Postgresql
(postgresqls)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® PostGRES SQL monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Radius_s
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® radius monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Radius
(radius_s)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® radius monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Radius_Accountings
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® radius accounting monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Radius_Accounting
(radius_accountings)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® radius accounting monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Real_Servers
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® real-server monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Real_Server
(real_servers)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® real-server monitor resource.
-
update
(**kwargs)[source]¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
tmCommand
attribute removed prior to PUTagent
attribute removed prior to PUTpost
attribute removed prior to PUT
Parameters: kwargs – keys and associated values to alter on the device
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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.ltm.monitor.
Rpcs
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Rpc monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Rpc
(rpcs)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Rpc monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Sasps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Sasp monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Sasp
(sasps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Sasp monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Scripteds
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® scripted monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Scripted
(scripteds)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® scripted monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Sips
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Sip monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Sip
(sips)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Sip monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Smbs
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Smb monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Smb
(smbs)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Smb monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Smtps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Smtp monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Smtp
(smtps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Smtp monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Snmp_Dcas
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® SNMP DCA monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Snmp_Dca
(snmp_dcas)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® SNMP DCA monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Snmp_Dca_Bases
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® SNMP DCA bases monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Snmp_Dca_Base
(snmp_dca_bases)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® SNMP DCA monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Soaps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Soap monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Soap
(soaps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Soap monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Tcps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Tcp monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Tcp
(tcps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Tcp monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Tcp_Echos
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Tcp echo monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Tcp_Echo
(tcp_echos)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Tcp echo monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Tcp_Half_Opens
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Tcp half open monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Tcp_Half_Open
(tcp_half_opens)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Tcp half open monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Udps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Udp monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Udp
(udps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Udp monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Virtual_Locations
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® virtual-locations monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Virtual_Location
(virtual_locations)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® virtual-locations monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Waps
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Wap monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Wap
(waps)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Wap monitor resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
defaultsFrom
attribute is removed from JSON before the PUT
Parameters: kwargs – keys and associated values to alter on the device
-
-
class
f5.bigip.tm.ltm.monitor.
Wmis
(monitor)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Wmi monitor collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.monitor.
Wmi
(wmis)[source]¶ Bases:
f5.bigip.mixins.UpdateMonitorMixin
,f5.bigip.resource.Resource
BIG-IP® Wmi monitor resource.
-
update
(**kwargs)[source]¶ Change the configuration of the resource on the device.
This method uses Http PUT alter the service state on the device.
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
agent
attribute removed prior to PUTpost
attribute removed prior to PUTmethod
attribute removed prior to PUT
Parameters: kwargs – keys and associated values to alter on the device
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)
-
nat¶
BIG-IP® Local Traffic Manager (LTM) Nat module.
- REST URI
http://localhost/mgmt/tm/ltm/nat
- GUI Path
Local Traffic --> Nat
- REST Kind
tm:ltm:nat:*
-
class
f5.bigip.tm.ltm.nat.
Nats
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Nat collection object
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.nat.
Nat
(nat_s)[source]¶ Bases:
f5.bigip.resource.Resource
,f5.bigip.mixins.ExclusiveAttributesMixin
BIG-IP® LTM Nat collection resource
-
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.
Note
If you are creating with ``inheritedTrafficGroup` set to
False
you just also have a trafficGroup.Parameters: kwargs – All the key-values needed to create the resource Returns: self
- 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 underlyingrequests.session.put
method where it will be handled according to that API.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)
-
node¶
BIG-IP® Local Traffic Manager (LTM) node module.
- REST URI
http://localhost/mgmt/tm/ltm/node
- GUI Path
Local Traffic --> Nodes
- REST Kind
tm:ltm:node:*
-
class
f5.bigip.tm.ltm.node.
Nodes
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM node collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.node.
Node
(nodes)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM node resource
-
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 underlyingrequests.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]¶ Call this to change the configuration of the service on the device.
This method uses HTTP PUT alter the service state on the device.
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
- If
fqdn
is in the kwargs or set as an attribute, removes theautopopulate
andaddressFamily
keys from it if there.
Parameters: kwargs – keys and associated values to alter on the device
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)
-
persistence¶
BIG-IP® Local Traffic Manager (LTM) persistence module.
- REST URI
https://localhost/mgmt/tm/ltm/persistence/
- GUI Path
Local Traffic --> Profiles --> Persistence
- REST Kind
tm:ltm:persistence:*
-
class
f5.bigip.tm.ltm.persistence.
Persistence
(ltm)[source]¶ Bases:
f5.bigip.resource.OrganizingCollection
BIG-IP® LTM persistence collection.
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Source_Addrs
(persistence)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Source Address persistence collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Source_Addr
(source_addrs)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Source Address persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Hashs
(persistence)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Hash persistence collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Hash
(hashs)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Hash persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Sips
(persistence)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Sip persistence collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Sip
(sips)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Sip persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Ssls
(persistence)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® SSL persistence collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Ssl
(ssls)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® SSL persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Global_Settings
(Global_Settings_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Global-Settings persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Dest_Addrs
(persistence)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Destination Address persistence collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Dest_Addr
(dest_addrs)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Destination Address persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Msrdps
(persistence)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® MS RDP persistence collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Msrdp
(msrdps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® MS RDP persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Cookies
(persistence)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Cookie persistence collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Cookie
(cookies)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Cookie persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Universals
(persistence)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Universal persistence collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.persistence.
Universal
(universals)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Universal persistence resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
policy¶
BIG-IP® Local Traffic Manager (LTM) policy module.
- REST URI
http://localhost/mgmt/tm/ltm/policy
- GUI Path
Local Traffic --> policy
- REST Kind
tm:ltm:policy:*
-
class
f5.bigip.tm.ltm.policy.
Policys
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM policy collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.policy.
Policy
(policy_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM policy resource.
-
publish
(**kwargs)[source]¶ Publishing a draft policy is only applicable in TMOS 12.1 and up.
This operation updates the meta_data[‘uri’] of the existing object and effectively moves a draft into a published state on the device. The self object is also updated with the response from a GET to the device.
Raises: PolicyNotDraft
-
draft
(**kwargs)[source]¶ Allows for easily re-drafting a policy
After a policy has been created, it was not previously possible to re-draft the published policy. This method makes it possible for a user with existing, published, policies to create drafts from them so that they are modifiable. See https://github.com/F5Networks/f5-common-python/pull/1099
Parameters: kwargs – Returns:
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.policy.
Rules_s
(policy)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM policy rules sub-collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.policy.
Rules
(rules_s)[source]¶ Bases:
f5.bigip.resource.Resource
,f5.bigip.mixins.CheckExistenceMixin
BIG-IP® LTM policy rules sub-collection resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.policy.
Actions_s
(rules)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM policy actions sub-collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.policy.
Actions
(actions_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM policy actions sub-collection resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.policy.
Conditions_s
(rules)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM policy conditions sub-collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.policy.
Conditions
(conditions_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM policy conditions sub-collection resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
pool¶
BIG-IP® Local Traffic Manager™ (LTM®) pool module.
- REST URI
http://localhost/mgmt/tm/ltm/pool
- GUI Path
Local Traffic --> Pools
- REST Kind
tm:ltm:pools:*
-
class
f5.bigip.tm.ltm.pool.
Pools
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM pool collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.pool.
Pool
(pool_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM pool resource
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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.ltm.pool.
Members_s
(pool)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM pool members sub-collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.pool.
Members
(members_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM pool members sub-collection resource
-
update
(**kwargs)[source]¶ Call this to change the configuration of the service on the device.
This method uses HTTP PUT to alter the service state on the device.
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
- If
fqdn
is in the kwargs or set as an attribute, removes theautopopulate
andaddressFamily
keys from it.
Parameters: kwargs – keys and associated values to alter on the device
-
exists
(**kwargs)[source]¶ Check for the existence of the named object on the BigIP
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 must then check the contents of the json contained in the response, this is because the “pool/… /members” resource provided by the server returns a status code of 200 for queries that do not correspond to an existing configuration. Therefore this method checks for the presence of the “address” key in the response JSON… of course, this means that exists depends on an unexpected idiosyncrancy of the server, and might break with version updates, edge cases, or other unpredictable changes.
Parameters: kwargs – Keyword arguments required to get objects, “partition” and “name” are required
NOTE: 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. THIS IS HOW TO PASS QUERY-ARGS! :returns: bool – The objects exists on BigIP or not. :raises:
requests.HTTPError
, Any HTTP error that was not statuscode 404.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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)
-
profile¶
BIG-IP® LTM profile submodule.
- REST URI
http://localhost/mgmt/tm/ltm/profile/
- GUI Path
Local Traffic --> Profiles
- REST Kind
tm:ltm:profile*
-
class
f5.bigip.tm.ltm.profile.
Profile
(ltm)[source]¶ 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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Client_Ssls
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Client SSL profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Client_Ssl
(client_ssls)[source]¶ Bases:
f5.bigip.resource.Resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Analytics_s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Analytics profile collection.
Note
Profile and sub-collections require AVR provisioned.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Analytics
(Analytics_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Analytics profile resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Alerts_s
(Analytics)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Alerts sub-collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Traffic_Captures
(Analytics)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Traffic Capture sub-collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Alerts
(Alerts_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Alerts resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Traffic_Capture
(Traffic_Captures)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Traffic Capture resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Certificate_Authoritys
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Certificate Authority profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Certificate_Authority
(Certificate_Authoritys)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Certificate Authority resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Classifications
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Classification profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Classification
(Classifications)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Classification resource.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Client_Ldaps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Client Ldap profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Client_Ldap
(Client_Ldaps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Client Ldap resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Dhcpv4s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Dhcpv4 profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Dhcpv4
(Dhcpv4s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Dhcpv4 resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Dhcpv6s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Dhcpv6 profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Dhcpv6
(Dhcpv6s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Dhcpv6 resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Diameters
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Diameter profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Diameter
(Diameters)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Diameter resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Dns_s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® DNS profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Dns
(Dns_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® DNS resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Dns_Loggings
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® DNS Logging profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Dns_Logging
(Dns_Loggings)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® DNS Logging resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Fasthttps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Fasthttp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Fasthttp
(Fasthttps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Fasthttp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Fastl4s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Fastl4 profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Fastl4
(Fastl4s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Fastl4 resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Fixs
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Fix profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Fix
(Fixs)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Fix resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ftps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Ftp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ftp
(Ftps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Ftp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Gtps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Gtp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Gtp
(Gtps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Gtp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Htmls
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Html profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Html
(Htmls)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Html resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Https
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Http profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Http
(Https)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Http resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Http_Compressions
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Http_Compression profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Http_Compression
(Http_Compressions)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Http_Compression resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Http2s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Http2 profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Http2
(Http2s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Http2 resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Icaps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Icap profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Icap
(Icaps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Icap resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Iiops
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Iiop profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Iiop
(Iiops)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Iiop resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ipothers
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Ipother profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ipother
(Ipothers)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Ipother resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ipsecalgs
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® IPsecALG profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ipsecalg
(Ipsecalgs)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® IPsecALG resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Mblbs
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Mblb profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Mblb
(Mblbs)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Mblb resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Mssqls
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Mssql profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Mssql
(Mssqls)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Mssql resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Netflows
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Netflow profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Netflow
(Netflows)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Netflow resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ntlms
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Ntlm profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ntlm
(Ntlms)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Ntlm resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ocsp_Stapling_Params_s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Ocsp_Stapling_Params profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ocsp_Stapling_Params
(Ocsp_Stapling_Params_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Ocsp_Stapling_Params resource.
-
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.
As proxyServerPool parameter will be required only if useProxyServer is set to ‘enabled’ we have to use conditional to capture this logic during create.
-
update
(**kwargs)[source]¶ When setting useProxyServer to enable we need to supply
proxyServerPool value as well
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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.ltm.profile.
One_Connects
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® One_Connect profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
One_Connect
(One_Connects)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® One_Connect resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Pcps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Pcp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Pcp
(Pcps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Pcp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Pptps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Pptp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Pptp
(Pptps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Pptp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Qoes
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Qoe profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Qoe
(Qoes)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Qoe resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Radius_s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Radius profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Radius
(Radius_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Radius resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ramcaches
(container)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Ramcache profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Ramcache
(container)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Ramcache resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Request_Adapts
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Request_Adapt profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Request_Adapt
(Request_Adapts)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Request_Adapt resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Request_Logs
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Request_Log profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Request_Log
(Request_Logs)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Request_Log resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Response_Adapts
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Response_Adapt profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Response_Adapt
(Response_Adapts)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Response_Adapt resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Rewrites
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Rewrite profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Rewrite
(Rewrites)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Rewrite resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Uri_Rules_s
(Rewrite)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Rewrite sub-collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Uri_Rules
(Uri_Rules_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® URI Rules resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Rtsps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Rtsp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Rtsp
(Rtsps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Rtsp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Sctps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Sctp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Sctp
(Sctps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Sctp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Server_Ldaps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Server_Ldap profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Server_Ldap
(Server_Ldaps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Server_Ldap resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Server_Ssls
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Server_Ssl profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Server_Ssl
(Server_Ssls)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Server_Ssl resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Sips
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Sip profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Sip
(Sips)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Sip resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Smtps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Smtp profile collection.
Note
Profile requires ASM provisioned.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Smtp
(Smtps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Smtp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Smtps_s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Smtps profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
SmtpS
(Smtps_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Smtps resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Socks_s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Socks profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Socks
(Socks_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Socks resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Spdys
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Spdy profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Spdy
(Spdys)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Spdy resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Statistics_s
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Statistics profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Statistics
(Statistics_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Statistics resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Streams
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Stream profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Stream
(Streams)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Stream resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Tcps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Tcp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Tcp
(Tcps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Tcp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Tftps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Tftp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Tftp
(Tftps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Tftp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Udps
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Udp profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Udp
(Udps)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Udp resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Wa_Caches
(container)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Wa_Cache profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Wa_Cache
(container)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Wa_Cache resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Web_Accelerations
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Web_Acceleration profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Web_Acceleration
(Web_Accelerations)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Web_Acceleration resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Web_Securitys
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Web_Security profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Websecurity
(Web_Securitys)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Web_Security resource.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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
-
-
class
f5.bigip.tm.ltm.profile.
Xmls
(profile)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® Xml profile collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.profile.
Xml
(Xmls)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® Xml resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
rule¶
BIG-IP® Local Traffic Manager (LTM) rule module.
- REST URI
http://localhost/mgmt/tm/ltm/rule
- GUI Path
Local Traffic --> Rules
- REST Kind
tm:ltm:rule:*
-
class
f5.bigip.tm.ltm.rule.
Rules
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM rule collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.rule.
Rule
(rule_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM rule resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
snat¶
BIG-IP® Local Traffic Manager (LTM) Snat module.
- REST URI
http://localhost/mgmt/tm/ltm/snat
- GUI Path
Local Traffic --> Snat
- REST Kind
tm:ltm:snat:*
-
class
f5.bigip.tm.ltm.snat.
Snats
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Snat collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.snat.
Snat
(snat_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Snat resource
-
create
(**kwargs)[source]¶ Call this to create a new snat on the BIG-IP®.
Uses HTTP POST to ‘containing’ URI to create a service associated with a new URI on the device.
Note this is the one of two fundamental Resource operations that returns a different uri (in the returned object) than the uri the operation was called on. The returned uri can be accessed as Object.selfLink, the actual uri used by REST operations on the object is Object._meta_data[‘uri’]. The _meta_data[‘uri’] is the same as Object.selfLink with the substring ‘localhost’ replaced with the value of Object._meta_data[‘BIG-IP’]._meta_data[‘hostname’], and without query args, or hash fragments.
The following is done prior to the POST * Ensures that one of
automap
,snatpool
,translation
parameter is passed in.Parameters: kwargs – All the key-values needed to create the resource Returns: An instance of the Python object that represents the device’s uri-published resource. The uri of the resource is part of the object’s _meta_data.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
snat_translation¶
BIG-IP Local Traffic Manager (LTM) SNAT Translation module.
- REST URI
https://localhost/mgmt/tm/ltm/snat-translation?ver=11.6.0
- GUI Path
Local Traffic --> Address Translation --> Address Translation List
- REST Kind
tm:ltm:snat-translation:*
-
class
f5.bigip.tm.ltm.snat_translation.
Snat_Translations
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® SNAT Translation collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.snat_translation.
Snat_Translation
(Snat_Translations)[source]¶ Bases:
f5.bigip.mixins.ExclusiveAttributesMixin
,f5.bigip.resource.Resource
BIG-IP® SNAT Translation
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
snatpool¶
BIG-IP Local Traffic Manager (LTM) SNAT pool module.
- REST URI
https://localhost/mgmt/tm/ltm/snatpool?ver=11.6.0
- GUI Path
Local Traffic --> Address Translation --> SNAT Pool List
- REST Kind
tm:ltm:snatpool:*
-
class
f5.bigip.tm.ltm.snatpool.
Snatpools
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® SNAT Pool collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.snatpool.
Snatpool
(Snatpools)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® SNAT Pool resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
traffic_class¶
BIG-IP Local Traffic Manager (LTM) Traffic Class module.
- REST URI
https://localhost/mgmt/tm/ltm/traffic-class
- GUI Path
Local Traffic --> Traffic Class
- REST Kind
tm:ltm:traffic-class:*
-
class
f5.bigip.tm.ltm.traffic_class.
Traffic_Class_s
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Traffic Class collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.traffic_class.
Traffic_Class
(traffic_class_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM Traffic Class Resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
virtual¶
BIG-IP® Local Traffic Manager (LTM) virtual module.
- REST URI
http://localhost/mgmt/tm/ltm/virtual
- GUI Path
Local Traffic --> Virtual Servers
- REST Kind
tm:ltm:virtual:*
-
class
f5.bigip.tm.ltm.virtual.
Virtuals
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM virtual collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.virtual.
Virtual
(virtual_s)[source]¶ Bases:
f5.bigip.resource.Resource
,f5.bigip.mixins.ExclusiveAttributesMixin
BIG-IP® LTM virtual resource
-
load
(**kwargs)[source]¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.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 underlyingrequests.session.put
method where it will be handled according to that API.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
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.ltm.virtual.
Profiles
(Profiles_s)[source]¶ Bases:
f5.bigip.resource.Resource
,f5.bigip.mixins.CheckExistenceMixin
BIG-IP® LTM profile resource
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.virtual.
Profiles_s
(virtual)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM profile collection
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.virtual.
Policies
(Policies_s)[source]¶ Bases:
f5.bigip.resource.Resource
,f5.bigip.mixins.CheckExistenceMixin
BIG-IP® LTM Policies resource
-
create
(**kwargs)[source]¶ Custom _create method to accommodate for issue 11.5.4 and 12.1.1,
Where creation of an object would return 404, despite the object being created.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.virtual.
Policies_s
(virtual)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM Policies resource
-
get_collection
(**kwargs)[source]¶ We need special get collection method to address issue in 11.5.4
In 11.5.4 collection ‘items’ were nested under ‘policiesReference’ key. This has caused get_collection() calls to return empty list. This fix will update the list if the policiesReference key is found and ‘items’ key do not exists in __dict__.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
virtual_address¶
Directory: ltm module: virtual-address.
- REST URI
https://localhost/mgmt/tm/ltm/virtual-address?ver=11.6.0
- GUI Path
Local Traffic Manager --> Virtual Servers --> Virtual Address List
- REST Kind
tm:ltm:virtual-address:*
-
class
f5.bigip.tm.ltm.virtual_address.
Virtual_Address_s
(ltm)[source]¶ Bases:
f5.bigip.resource.Collection
BIG-IP® LTM virtual address collection.
-
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.
-
delete_collection
(**kwargs)¶ One can not simply delete a collection.
This is to support odata usage via the options request parameter:
requests_params={'params': 'options=glob_pattern'}
where glob_pattern can be used to delete one or all of a particular collection. Not submitting the requests params will fail, and specifying patterns that match default resources will fail as well.
-
get_collection
(**kwargs)¶ Get an iterator of Python
Resource
objects that represent URIs.The returned objects are Pythonic Resource`s that map to the most recently `refreshed state of uris-resources published by the device. In order to instantiate the correct types, the concrete subclass must populate its registry with acceptable types, based on the kind field returned by the REST server.
Note
This method implies a single REST transaction with the Collection subclass URI.
Raises: UnregisteredKind Returns: list of reference dicts and Python Resource
objects
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-
-
class
f5.bigip.tm.ltm.virtual_address.
Virtual_Address
(Virtual_Address_s)[source]¶ Bases:
f5.bigip.resource.Resource
BIG-IP® LTM virtual address resource.
-
create
(**kwargs)¶ 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 underlyingrequests.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®.
-
delete
(**kwargs)¶ 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 underlyingrequests.session.delete
method where it will be handled according to that API.Use the method above to pass query args.
-
exists
(**kwargs)¶ 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 underlyingrequests.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.
-
load
(**kwargs)¶ Load an already configured service into this instance.
This method uses HTTP GET to obtain a resource from the BIG-IP®.
The URI of the target service is constructed from the instance’s container and
**kwargs
.kwargs
typically requires the keysname
andpartition
. this may, or may not, be true for a specific service.- Args:
- **kwargs (dict): Arbitrary number of keyword arguments.
If kwargs has a
requests_params
key the corresponding dict will be passed to the underlyingrequests.session.get
method where it will be handled according to that API.Use the method above to pass query args
- Returns:
- Resource: A Resource Instance with a populated
_meta_data['uri']
-
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 underlyingrequests.session.put
method where it will be handled according to that API.
-