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
BIG-IP® LTM auth submodule. |
|
BIG-IP® LTM data-group submodule. |
|
BIG-IP® ltm default node monitor module |
|
BIG-IP® LTM ifile submodule. |
|
BIG-IP® Local Traffic Manager™ (LTM®) LSN pool module. |
|
BIG-IP® LTM monitor submodule. |
|
BIG-IP® Local Traffic Manager (LTM) Nat module. |
|
BIG-IP® Local Traffic Manager (LTM) node module. |
|
BIG-IP® Local Traffic Manager (LTM) persistence module. |
|
BIG-IP® Local Traffic Manager (LTM) policy module. |
|
BIG-IP® Local Traffic Manager™ (LTM®) pool module. |
|
BIG-IP® LTM profile submodule. |
|
BIG-IP® Local Traffic Manager (LTM) rule module. |
|
BIG-IP® Local Traffic Manager (LTM) Snat module. |
|
BIG-IP Local Traffic Manager (LTM) SNAT Translation module. |
|
BIG-IP Local Traffic Manager (LTM) SNAT pool module. |
|
BIG-IP Local Traffic Manager (LTM) Traffic Class module. |
|
BIG-IP® Local Traffic Manager (LTM) virtual module. |
|
Directory: ltm module: virtual-address. |
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.Kerberos_Delegations(ltm)[source]
BIG-IP® LTM Auth Kerberos Delegation collection
- class f5.bigip.tm.ltm.auth.Kerberos_Delegation(kerberos_delegations)[source]
BIG-IP® LTM Auth Kerberos Delegation resource
- class f5.bigip.tm.ltm.auth.Ocsp_Responder(ocsp_responders)[source]
BIG-IP® LTM Auth Ocsp Responder resource
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.Internal(internals)[source]
- 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.
- class f5.bigip.tm.ltm.data_group.External(externals)[source]
- 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.
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]
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.
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*
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:*
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.Gateway_Icmps(monitor)[source]
BIG-IP® Gateway Icmp monitor collection.
- class f5.bigip.tm.ltm.monitor.Gateway_Icmp(gateway_icmps)[source]
BIG-IP® Gateway Icmp monitor resource.
- class f5.bigip.tm.ltm.monitor.Module_Scores(monitor)[source]
BIG-IP® module scores monitor collection.
- class f5.bigip.tm.ltm.monitor.Module_Score(gateway_icmps)[source]
BIG-IP® module scores monitor resource.
- class f5.bigip.tm.ltm.monitor.Postgresqls(monitor)[source]
BIG-IP® PostGRES SQL monitor collection.
- class f5.bigip.tm.ltm.monitor.Postgresql(postgresqls)[source]
BIG-IP® PostGRES SQL monitor resource.
- class f5.bigip.tm.ltm.monitor.Radius_Accountings(monitor)[source]
BIG-IP® radius accounting monitor collection.
- class f5.bigip.tm.ltm.monitor.Radius_Accounting(radius_accountings)[source]
BIG-IP® radius accounting monitor resource.
- class f5.bigip.tm.ltm.monitor.Real_Servers(monitor)[source]
BIG-IP® real-server monitor collection.
- class f5.bigip.tm.ltm.monitor.Real_Server(real_servers)[source]
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
- class f5.bigip.tm.ltm.monitor.Snmp_Dca_Bases(monitor)[source]
BIG-IP® SNMP DCA bases monitor collection.
- class f5.bigip.tm.ltm.monitor.Snmp_Dca_Base(snmp_dca_bases)[source]
BIG-IP® SNMP DCA monitor resource.
- class f5.bigip.tm.ltm.monitor.Tcp_Half_Opens(monitor)[source]
BIG-IP® Tcp half open monitor collection.
- class f5.bigip.tm.ltm.monitor.Tcp_Half_Open(tcp_half_opens)[source]
BIG-IP® Tcp half open monitor resource.
- class f5.bigip.tm.ltm.monitor.Virtual_Locations(monitor)[source]
BIG-IP® virtual-locations monitor collection.
- class f5.bigip.tm.ltm.monitor.Virtual_Location(virtual_locations)[source]
BIG-IP® virtual-locations monitor resource.
- class f5.bigip.tm.ltm.monitor.Wmi(wmis)[source]
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
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.Nat(nat_s)[source]
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.
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.Node(nodes)[source]
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
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.Source_Addrs(persistence)[source]
BIG-IP® Source Address persistence collection.
- class f5.bigip.tm.ltm.persistence.Source_Addr(source_addrs)[source]
BIG-IP® Source Address persistence resource.
- class f5.bigip.tm.ltm.persistence.Global_Settings(Global_Settings_s)[source]
BIG-IP® Global-Settings persistence resource.
- class f5.bigip.tm.ltm.persistence.Dest_Addrs(persistence)[source]
BIG-IP® Destination Address persistence collection.
- class f5.bigip.tm.ltm.persistence.Dest_Addr(dest_addrs)[source]
BIG-IP® Destination Address persistence resource.
- class f5.bigip.tm.ltm.persistence.Msrdps(persistence)[source]
BIG-IP® MS RDP persistence collection.
- class f5.bigip.tm.ltm.persistence.Cookies(persistence)[source]
BIG-IP® Cookie persistence collection.
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.Policy(policy_s)[source]
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:
- class f5.bigip.tm.ltm.policy.Rules(rules_s)[source]
BIG-IP® LTM policy rules sub-collection resource.
- class f5.bigip.tm.ltm.policy.Actions(actions_s)[source]
BIG-IP® LTM policy actions sub-collection resource.
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.Members(members_s)[source]
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.
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.Analytics_s(profile)[source]
BIG-IP® Analytics profile collection.
Note
Profile and sub-collections require AVR provisioned.
- class f5.bigip.tm.ltm.profile.Traffic_Captures(Analytics)[source]
BIG-IP® Traffic Capture sub-collection.
- class f5.bigip.tm.ltm.profile.Traffic_Capture(Traffic_Captures)[source]
BIG-IP® Traffic Capture resource.
- class f5.bigip.tm.ltm.profile.Certificate_Authoritys(profile)[source]
BIG-IP® Certificate Authority profile collection.
- class f5.bigip.tm.ltm.profile.Certificate_Authority(Certificate_Authoritys)[source]
BIG-IP® Certificate Authority resource.
- class f5.bigip.tm.ltm.profile.Classifications(profile)[source]
BIG-IP® Classification profile collection.
- class f5.bigip.tm.ltm.profile.Classification(Classifications)[source]
BIG-IP® Classification resource.
- class f5.bigip.tm.ltm.profile.Client_Ldaps(profile)[source]
BIG-IP® Client Ldap profile collection.
- class f5.bigip.tm.ltm.profile.Dns_Loggings(profile)[source]
BIG-IP® DNS Logging profile collection.
- class f5.bigip.tm.ltm.profile.Http_Compressions(profile)[source]
BIG-IP® Http_Compression profile collection.
- class f5.bigip.tm.ltm.profile.Http_Compression(Http_Compressions)[source]
BIG-IP® Http_Compression resource.
- class f5.bigip.tm.ltm.profile.Ocsp_Stapling_Params_s(profile)[source]
BIG-IP® Ocsp_Stapling_Params profile collection.
- class f5.bigip.tm.ltm.profile.Ocsp_Stapling_Params(Ocsp_Stapling_Params_s)[source]
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.
- class f5.bigip.tm.ltm.profile.One_Connects(profile)[source]
BIG-IP® One_Connect profile collection.
- class f5.bigip.tm.ltm.profile.Request_Adapts(profile)[source]
BIG-IP® Request_Adapt profile collection.
- class f5.bigip.tm.ltm.profile.Request_Adapt(Request_Adapts)[source]
BIG-IP® Request_Adapt resource.
- class f5.bigip.tm.ltm.profile.Request_Logs(profile)[source]
BIG-IP® Request_Log profile collection.
- class f5.bigip.tm.ltm.profile.Response_Adapts(profile)[source]
BIG-IP® Response_Adapt profile collection.
- class f5.bigip.tm.ltm.profile.Response_Adapt(Response_Adapts)[source]
BIG-IP® Response_Adapt resource.
- class f5.bigip.tm.ltm.profile.Server_Ldaps(profile)[source]
BIG-IP® Server_Ldap profile collection.
- class f5.bigip.tm.ltm.profile.Smtps(profile)[source]
BIG-IP® Smtp profile collection.
Note
Profile requires ASM provisioned.
- class f5.bigip.tm.ltm.profile.Web_Accelerations(profile)[source]
BIG-IP® Web_Acceleration profile collection.
- class f5.bigip.tm.ltm.profile.Web_Acceleration(Web_Accelerations)[source]
BIG-IP® Web_Acceleration resource.
- class f5.bigip.tm.ltm.profile.Web_Securitys(profile)[source]
BIG-IP® Web_Security profile collection.
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:*
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.Snat(snat_s)[source]
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.
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:*
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:*
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:*
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.Virtual(virtual_s)[source]
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.
- class f5.bigip.tm.ltm.virtual.Policies_s(virtual)[source]
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
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:*