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]

BIG-IP® Local Traffic Manager (LTM) organizing collection.

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]

BIG-IP® LTM Authentication organizing collection.

class f5.bigip.tm.ltm.auth.Crldp_Servers(ltm)[source]

BIG-IP® LTM Auth Crldp Server collection

class f5.bigip.tm.ltm.auth.Crldp_Server(crldp_servers)[source]
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.Ldaps(ltm)[source]

BIG-IP® LTM Auth Ldap collection

class f5.bigip.tm.ltm.auth.Ldap(ldaps)[source]

BIG-IP® LTM Auth Ldap resource

class f5.bigip.tm.ltm.auth.Ocsp_Responders(ltm)[source]

BIG-IP® LTM Auth Ocsp Responder collection

class f5.bigip.tm.ltm.auth.Ocsp_Responder(ocsp_responders)[source]

BIG-IP® LTM Auth Ocsp Responder resource

class f5.bigip.tm.ltm.auth.Profiles(ltm)[source]

BIG-IP® LTM Auth Profile collection

class f5.bigip.tm.ltm.auth.Profile(profiles)[source]

BIG-IP® LTM Auth Profile resource

update(**kwargs)[source]

Update is not supported for LTM Auth Profiles

Raises:

UnsupportedOperation

class f5.bigip.tm.ltm.auth.Radius_s(ltm)[source]

BIG-IP® LTM Auth Radius collection

class f5.bigip.tm.ltm.auth.Radius(radius_s)[source]

BIG-IP® LTM Auth Radius resource

class f5.bigip.tm.ltm.auth.Radius_Servers(ltm)[source]

BIG-IP® LTM Auth Radius Server collection

class f5.bigip.tm.ltm.auth.Radius_Server(radius_server_s)[source]

BIG-IP® LTM Auth Radius Server resource

class f5.bigip.tm.ltm.auth.Ssl_Cc_Ldaps(ltm)[source]

BIG-IP® LTM Auth SSL CC LDAP collection

class f5.bigip.tm.ltm.auth.Ssl_Cc_Ldap(ssl_cc_ldaps)[source]

BIG-IP® LTM Auth SSL CC LDAP resource

class f5.bigip.tm.ltm.auth.Ssl_Crldps(ltm)[source]

BIG-IP® LTM Auth SSL CLRDP collection

class f5.bigip.tm.ltm.auth.Ssl_Crldp(ssl_crldps)[source]

BIG-IP® LTM Auth SSL CLRDP resource

class f5.bigip.tm.ltm.auth.Ssl_Ocsps(ltm)[source]

BIG-IP® LTM Auth SSL OCSP collection

class f5.bigip.tm.ltm.auth.Ssl_Ocsp(ssl_ocsps)[source]

BIG-IP® LTM Auth SSL OCSP resource

class f5.bigip.tm.ltm.auth.Tacacs_s(ltm)[source]

BIG-IP® LTM Auth TACACS+ Server collection

class f5.bigip.tm.ltm.auth.Tacacs(tacacs_s)[source]

BIG-IP® LTM Auth TACACS+ Server 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.Data_Group(ltm)[source]
class f5.bigip.tm.ltm.data_group.Internals(data_groups)[source]
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 underlying requests.session.put method where it will be handled according to that API.

class f5.bigip.tm.ltm.data_group.Externals(data_groups)[source]
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 underlying requests.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*

class f5.bigip.tm.ltm.ifile.Ifiles(ltm)[source]

BIG-IP® LTM iFiles collection

class f5.bigip.tm.ltm.ifile.Ifile(ifile_s)[source]

BIG-IP® LTM iFiles resource

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]

BIG-IP® LTM LSN pool collection

class f5.bigip.tm.ltm.lsn_pools.LSN_Pool(lsnpool_s)[source]

BIG-IP® LTM LSN pool resource

class f5.bigip.tm.ltm.lsn_pools.LSN_Log_Profiles(profile)[source]

BIG-IP® LTM LSN pool log profile collection

class f5.bigip.tm.ltm.lsn_pools.LSN_Log_Profile(LSNLogProfile_s)[source]

BIG-IP® LTM LSN pool log profile resource

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]
class f5.bigip.tm.ltm.monitor.Https(monitor)[source]

BIG-IP® Http monitor collection.

class f5.bigip.tm.ltm.monitor.Http(https)[source]

BIG-IP® Http monitor resource.

class f5.bigip.tm.ltm.monitor.Https_s(monitor)[source]

BIG-IP® Https monitor collection.

class f5.bigip.tm.ltm.monitor.HttpS(https_s)[source]

BIG-IP® Https monitor resource.

class f5.bigip.tm.ltm.monitor.Diameters(monitor)[source]

BIG-IP® diameter monitor collection.

class f5.bigip.tm.ltm.monitor.Diameter(diameters)[source]

BIG-IP® diameter monitor resource.

class f5.bigip.tm.ltm.monitor.Dns_s(monitor)[source]

BIG-IP® Dns monitor collection.

class f5.bigip.tm.ltm.monitor.Dns(dns_s)[source]

BIG-IP® Dns monitor resource.

class f5.bigip.tm.ltm.monitor.Externals(monitor)[source]

BIG-IP® external monitor collection.

class f5.bigip.tm.ltm.monitor.External(externals)[source]

BIG-IP® external monitor resrouce.

class f5.bigip.tm.ltm.monitor.Firepass_s(monitor)[source]

BIG-IP® Fire Pass monitor collection.

class f5.bigip.tm.ltm.monitor.Firepass(firepass_s)[source]

BIG-IP® external monitor resource.

class f5.bigip.tm.ltm.monitor.Ftps(monitor)[source]

BIG-IP® Ftp monitor collection.

class f5.bigip.tm.ltm.monitor.Ftp(ftps)[source]

BIG-IP® Ftp monitor resource.

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.Icmps(monitor)[source]

BIG-IP® Icmp monitor collection.

class f5.bigip.tm.ltm.monitor.Icmp(icmps)[source]

BIG-IP® Icmp monitor resource.

class f5.bigip.tm.ltm.monitor.Imaps(monitor)[source]

BIG-IP® Imap monitor collection.

class f5.bigip.tm.ltm.monitor.Imap(imaps)[source]

BIG-IP® Imap monitor resource.

class f5.bigip.tm.ltm.monitor.Inbands(monitor)[source]

BIG-IP® in band monitor collection.

class f5.bigip.tm.ltm.monitor.Inband(inbands)[source]

BIG-IP® in band monitor resource.

class f5.bigip.tm.ltm.monitor.Ldaps(monitor)[source]

BIG-IP® Ldap monitor collection.

class f5.bigip.tm.ltm.monitor.Ldap(ldaps)[source]

BIG-IP® Ldap 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.Mysqls(monitor)[source]

BIG-IP® MySQL monitor collection.

class f5.bigip.tm.ltm.monitor.Mysql(mysqls)[source]

BIG-IP® MySQL monitor resource.

class f5.bigip.tm.ltm.monitor.Mqtts(monitor)[source]
class f5.bigip.tm.ltm.monitor.Mqtt(mqtts)[source]
class f5.bigip.tm.ltm.monitor.Mssqls(monitor)[source]

BIG-IP® Mssql monitor collection.

class f5.bigip.tm.ltm.monitor.Mssql(mssqls)[source]

BIG-IP® Mssql monitor resource.

class f5.bigip.tm.ltm.monitor.Nntps(monitor)[source]

BIG-IP® Nntps monitor collection.

class f5.bigip.tm.ltm.monitor.Nntp(nntps)[source]

BIG-IP® Nntps monitor resource.

class f5.bigip.tm.ltm.monitor.Nones(monitor)[source]

BIG-IP® None monitor collection.

class f5.bigip.tm.ltm.monitor.NONE(nones)[source]

BIG-IP® None monitor resource.

class f5.bigip.tm.ltm.monitor.Oracles(monitor)[source]

BIG-IP® Oracle monitor collection.

class f5.bigip.tm.ltm.monitor.Oracle(oracles)[source]

BIG-IP® Oracle monitor resource.

class f5.bigip.tm.ltm.monitor.Pop3s(monitor)[source]

BIG-IP® Pop3 monitor collection.

class f5.bigip.tm.ltm.monitor.Pop3(pop3s)[source]

BIG-IP® Pop3 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_s(monitor)[source]

BIG-IP® radius monitor collection.

class f5.bigip.tm.ltm.monitor.Radius(radius_s)[source]

BIG-IP® radius 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 PUT

  • agent attribute removed prior to PUT

  • post attribute removed prior to PUT

Parameters:

kwargs – keys and associated values to alter on the device

class f5.bigip.tm.ltm.monitor.Rpcs(monitor)[source]

BIG-IP® Rpc monitor collection.

class f5.bigip.tm.ltm.monitor.Rpc(rpcs)[source]

BIG-IP® Rpc monitor resource.

class f5.bigip.tm.ltm.monitor.Sasps(monitor)[source]

BIG-IP® Sasp monitor collection.

class f5.bigip.tm.ltm.monitor.Sasp(sasps)[source]

BIG-IP® Sasp monitor resource.

class f5.bigip.tm.ltm.monitor.Scripteds(monitor)[source]

BIG-IP® scripted monitor collection.

class f5.bigip.tm.ltm.monitor.Scripted(scripteds)[source]

BIG-IP® scripted monitor resource.

class f5.bigip.tm.ltm.monitor.Sips(monitor)[source]

BIG-IP® Sip monitor collection.

class f5.bigip.tm.ltm.monitor.Sip(sips)[source]

BIG-IP® Sip monitor resource.

class f5.bigip.tm.ltm.monitor.Smbs(monitor)[source]

BIG-IP® Smb monitor collection.

class f5.bigip.tm.ltm.monitor.Smb(smbs)[source]

BIG-IP® Smb monitor resource.

class f5.bigip.tm.ltm.monitor.Smtps(monitor)[source]

BIG-IP® Smtp monitor collection.

class f5.bigip.tm.ltm.monitor.Smtp(smtps)[source]

BIG-IP® Smtp monitor resource.

class f5.bigip.tm.ltm.monitor.Snmp_Dcas(monitor)[source]

BIG-IP® SNMP DCA monitor collection.

class f5.bigip.tm.ltm.monitor.Snmp_Dca(snmp_dcas)[source]

BIG-IP® SNMP DCA monitor resource.

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.Soaps(monitor)[source]

BIG-IP® Soap monitor collection.

class f5.bigip.tm.ltm.monitor.Soap(soaps)[source]

BIG-IP® Soap monitor resource.

class f5.bigip.tm.ltm.monitor.Tcps(monitor)[source]

BIG-IP® Tcp monitor collection.

class f5.bigip.tm.ltm.monitor.Tcp(tcps)[source]

BIG-IP® Tcp monitor resource.

class f5.bigip.tm.ltm.monitor.Tcp_Echos(monitor)[source]

BIG-IP® Tcp echo monitor collection.

class f5.bigip.tm.ltm.monitor.Tcp_Echo(tcp_echos)[source]

BIG-IP® Tcp echo 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.Udps(monitor)[source]

BIG-IP® Udp monitor collection.

class f5.bigip.tm.ltm.monitor.Udp(udps)[source]

BIG-IP® Udp 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.Waps(monitor)[source]

BIG-IP® Wap monitor collection.

class f5.bigip.tm.ltm.monitor.Wap(waps)[source]

BIG-IP® Wap monitor resource.

class f5.bigip.tm.ltm.monitor.Wmis(monitor)[source]

BIG-IP® Wmi monitor collection.

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 PUT

  • post attribute removed prior to PUT

  • method 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.Nats(ltm)[source]

BIG-IP® LTM Nat collection object

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 underlying requests.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.Nodes(ltm)[source]

BIG-IP® LTM node collection

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 underlying requests.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 the autopopulate and addressFamily 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.Persistence(ltm)[source]

BIG-IP® LTM persistence collection.

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.Hashs(persistence)[source]

BIG-IP® Hash persistence collection.

class f5.bigip.tm.ltm.persistence.Hash(hashs)[source]

BIG-IP® Hash persistence resource.

class f5.bigip.tm.ltm.persistence.Sips(persistence)[source]

BIG-IP® Sip persistence collection.

class f5.bigip.tm.ltm.persistence.Sip(sips)[source]

BIG-IP® Sip persistence resource.

class f5.bigip.tm.ltm.persistence.Ssls(persistence)[source]

BIG-IP® SSL persistence collection.

class f5.bigip.tm.ltm.persistence.Ssl(ssls)[source]

BIG-IP® SSL 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.Msrdp(msrdps)[source]

BIG-IP® MS RDP persistence resource.

class f5.bigip.tm.ltm.persistence.Cookies(persistence)[source]

BIG-IP® Cookie persistence collection.

class f5.bigip.tm.ltm.persistence.Cookie(cookies)[source]

BIG-IP® Cookie persistence resource.

class f5.bigip.tm.ltm.persistence.Universals(persistence)[source]

BIG-IP® Universal persistence collection.

class f5.bigip.tm.ltm.persistence.Universal(universals)[source]

BIG-IP® Universal persistence resource.

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]

BIG-IP® LTM policy collection.

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_s(policy)[source]

BIG-IP® LTM policy rules sub-collection.

class f5.bigip.tm.ltm.policy.Rules(rules_s)[source]

BIG-IP® LTM policy rules sub-collection resource.

exists(**kwargs)[source]

Check rule existence on device.

class f5.bigip.tm.ltm.policy.Actions_s(rules)[source]

BIG-IP® LTM policy actions sub-collection.

class f5.bigip.tm.ltm.policy.Actions(actions_s)[source]

BIG-IP® LTM policy actions sub-collection resource.

class f5.bigip.tm.ltm.policy.Conditions_s(rules)[source]

BIG-IP® LTM policy conditions sub-collection.

class f5.bigip.tm.ltm.policy.Conditions(conditions_s)[source]

BIG-IP® LTM policy conditions 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.Pools(ltm)[source]

BIG-IP® LTM pool collection

class f5.bigip.tm.ltm.pool.Pool(pool_s)[source]

BIG-IP® LTM pool resource

create(**kwargs)[source]

Custom create method to implement monitor parameter formatting.

update(**kwargs)[source]

Custom update method to implement monitor parameter formatting.

modify(**patch)[source]

Custom modify method to implement monitor parameter formatting.

class f5.bigip.tm.ltm.pool.Members_s(pool)[source]

BIG-IP® LTM pool members sub-collection

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 the autopopulate and addressFamily 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 status

code 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.Profile(ltm)[source]
class f5.bigip.tm.ltm.profile.Client_Ssls(profile)[source]

BIG-IP® Client SSL profile collection.

class f5.bigip.tm.ltm.profile.Client_Ssl(client_ssls)[source]
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.Analytics(Analytics_s)[source]

BIG-IP® Analytics profile resource.

class f5.bigip.tm.ltm.profile.Alerts_s(Analytics)[source]

BIG-IP® Alerts sub-collection.

class f5.bigip.tm.ltm.profile.Traffic_Captures(Analytics)[source]

BIG-IP® Traffic Capture sub-collection.

class f5.bigip.tm.ltm.profile.Alerts(Alerts_s)[source]

BIG-IP® Alerts resource.

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.

create(**kwargs)[source]

Create is not supported for Classification

Raises:

UnsupportedOperation

delete(**kwargs)[source]

Delete is not supported for Classification

Raises:

UnsupportedOperation

class f5.bigip.tm.ltm.profile.Client_Ldaps(profile)[source]

BIG-IP® Client Ldap profile collection.

class f5.bigip.tm.ltm.profile.Client_Ldap(Client_Ldaps)[source]

BIG-IP® Client Ldap resource.

class f5.bigip.tm.ltm.profile.Dhcpv4s(profile)[source]

BIG-IP® Dhcpv4 profile collection.

class f5.bigip.tm.ltm.profile.Dhcpv4(Dhcpv4s)[source]

BIG-IP® Dhcpv4 resource.

class f5.bigip.tm.ltm.profile.Dhcpv6s(profile)[source]

BIG-IP® Dhcpv6 profile collection.

class f5.bigip.tm.ltm.profile.Dhcpv6(Dhcpv6s)[source]

BIG-IP® Dhcpv6 resource.

class f5.bigip.tm.ltm.profile.Diameters(profile)[source]

BIG-IP® Diameter profile collection.

class f5.bigip.tm.ltm.profile.Diameter(Diameters)[source]

BIG-IP® Diameter resource.

class f5.bigip.tm.ltm.profile.Dns_s(profile)[source]

BIG-IP® DNS profile collection.

class f5.bigip.tm.ltm.profile.Dns(Dns_s)[source]

BIG-IP® DNS resource.

class f5.bigip.tm.ltm.profile.Dns_Loggings(profile)[source]

BIG-IP® DNS Logging profile collection.

class f5.bigip.tm.ltm.profile.Dns_Logging(Dns_Loggings)[source]

BIG-IP® DNS Logging resource.

class f5.bigip.tm.ltm.profile.Fasthttps(profile)[source]

BIG-IP® Fasthttp profile collection.

class f5.bigip.tm.ltm.profile.Fasthttp(Fasthttps)[source]

BIG-IP® Fasthttp resource.

class f5.bigip.tm.ltm.profile.Fastl4s(profile)[source]

BIG-IP® Fastl4 profile collection.

class f5.bigip.tm.ltm.profile.Fastl4(Fastl4s)[source]

BIG-IP® Fastl4 resource.

class f5.bigip.tm.ltm.profile.Fixs(profile)[source]

BIG-IP® Fix profile collection.

class f5.bigip.tm.ltm.profile.Fix(Fixs)[source]

BIG-IP® Fix resource.

class f5.bigip.tm.ltm.profile.Ftps(profile)[source]

BIG-IP® Ftp profile collection.

class f5.bigip.tm.ltm.profile.Ftp(Ftps)[source]

BIG-IP® Ftp resource.

class f5.bigip.tm.ltm.profile.Gtps(profile)[source]

BIG-IP® Gtp profile collection.

class f5.bigip.tm.ltm.profile.Gtp(Gtps)[source]

BIG-IP® Gtp resource.

class f5.bigip.tm.ltm.profile.Htmls(profile)[source]

BIG-IP® Html profile collection.

class f5.bigip.tm.ltm.profile.Html(Htmls)[source]

BIG-IP® Html resource.

class f5.bigip.tm.ltm.profile.Https(profile)[source]

BIG-IP® Http profile collection.

class f5.bigip.tm.ltm.profile.Http(Https)[source]

BIG-IP® Http resource.

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.Http2s(profile)[source]

BIG-IP® Http2 profile collection.

class f5.bigip.tm.ltm.profile.Http2(Http2s)[source]

BIG-IP® Http2 resource.

class f5.bigip.tm.ltm.profile.Icaps(profile)[source]

BIG-IP® Icap profile collection.

class f5.bigip.tm.ltm.profile.Icap(Icaps)[source]

BIG-IP® Icap resource.

class f5.bigip.tm.ltm.profile.Iiops(profile)[source]

BIG-IP® Iiop profile collection.

class f5.bigip.tm.ltm.profile.Iiop(Iiops)[source]

BIG-IP® Iiop resource.

class f5.bigip.tm.ltm.profile.Ipothers(profile)[source]

BIG-IP® Ipother profile collection.

class f5.bigip.tm.ltm.profile.Ipother(Ipothers)[source]

BIG-IP® Ipother resource.

class f5.bigip.tm.ltm.profile.Ipsecalgs(profile)[source]

BIG-IP® IPsecALG profile collection.

class f5.bigip.tm.ltm.profile.Ipsecalg(Ipsecalgs)[source]

BIG-IP® IPsecALG resource.

class f5.bigip.tm.ltm.profile.Mblbs(profile)[source]

BIG-IP® Mblb profile collection.

class f5.bigip.tm.ltm.profile.Mblb(Mblbs)[source]

BIG-IP® Mblb resource.

class f5.bigip.tm.ltm.profile.Mssqls(profile)[source]

BIG-IP® Mssql profile collection.

class f5.bigip.tm.ltm.profile.Mssql(Mssqls)[source]

BIG-IP® Mssql resource.

class f5.bigip.tm.ltm.profile.Netflows(profile)[source]

BIG-IP® Netflow profile collection.

class f5.bigip.tm.ltm.profile.Netflow(Netflows)[source]

BIG-IP® Netflow resource.

class f5.bigip.tm.ltm.profile.Ntlms(profile)[source]

BIG-IP® Ntlm profile collection.

class f5.bigip.tm.ltm.profile.Ntlm(Ntlms)[source]

BIG-IP® Ntlm 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.

update(**kwargs)[source]

When setting useProxyServer to enable we need to supply

proxyServerPool value as well

class f5.bigip.tm.ltm.profile.One_Connects(profile)[source]

BIG-IP® One_Connect profile collection.

class f5.bigip.tm.ltm.profile.One_Connect(One_Connects)[source]

BIG-IP® One_Connect resource.

class f5.bigip.tm.ltm.profile.Pcps(profile)[source]

BIG-IP® Pcp profile collection.

class f5.bigip.tm.ltm.profile.Pcp(Pcps)[source]

BIG-IP® Pcp resource.

class f5.bigip.tm.ltm.profile.Pptps(profile)[source]

BIG-IP® Pptp profile collection.

class f5.bigip.tm.ltm.profile.Pptp(Pptps)[source]

BIG-IP® Pptp resource.

class f5.bigip.tm.ltm.profile.Qoes(profile)[source]

BIG-IP® Qoe profile collection.

class f5.bigip.tm.ltm.profile.Qoe(Qoes)[source]

BIG-IP® Qoe resource.

class f5.bigip.tm.ltm.profile.Radius_s(profile)[source]

BIG-IP® Radius profile collection.

class f5.bigip.tm.ltm.profile.Radius(Radius_s)[source]

BIG-IP® Radius resource.

class f5.bigip.tm.ltm.profile.Ramcaches(container)[source]

BIG-IP® Ramcache profile collection.

class f5.bigip.tm.ltm.profile.Ramcache(container)[source]

BIG-IP® Ramcache resource.

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.Request_Log(Request_Logs)[source]

BIG-IP® Request_Log resource.

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.Rewrites(profile)[source]

BIG-IP® Rewrite profile collection.

class f5.bigip.tm.ltm.profile.Rewrite(Rewrites)[source]

BIG-IP® Rewrite resource.

class f5.bigip.tm.ltm.profile.Uri_Rules_s(Rewrite)[source]

BIG-IP® Rewrite sub-collection.

class f5.bigip.tm.ltm.profile.Uri_Rules(Uri_Rules_s)[source]

BIG-IP® URI Rules resource

class f5.bigip.tm.ltm.profile.Rtsps(profile)[source]

BIG-IP® Rtsp profile collection.

class f5.bigip.tm.ltm.profile.Rtsp(Rtsps)[source]

BIG-IP® Rtsp resource.

class f5.bigip.tm.ltm.profile.Sctps(profile)[source]

BIG-IP® Sctp profile collection.

class f5.bigip.tm.ltm.profile.Sctp(Sctps)[source]

BIG-IP® Sctp resource.

class f5.bigip.tm.ltm.profile.Server_Ldaps(profile)[source]

BIG-IP® Server_Ldap profile collection.

class f5.bigip.tm.ltm.profile.Server_Ldap(Server_Ldaps)[source]

BIG-IP® Server_Ldap resource.

class f5.bigip.tm.ltm.profile.Server_Ssls(profile)[source]

BIG-IP® Server_Ssl profile collection.

class f5.bigip.tm.ltm.profile.Server_Ssl(Server_Ssls)[source]

BIG-IP® Server_Ssl resource.

class f5.bigip.tm.ltm.profile.Sips(profile)[source]

BIG-IP® Sip profile collection.

class f5.bigip.tm.ltm.profile.Sip(Sips)[source]

BIG-IP® Sip resource.

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.Smtp(Smtps)[source]

BIG-IP® Smtp resource.

class f5.bigip.tm.ltm.profile.Smtps_s(profile)[source]

BIG-IP® Smtps profile collection.

class f5.bigip.tm.ltm.profile.SmtpS(Smtps_s)[source]

BIG-IP® Smtps resource.

class f5.bigip.tm.ltm.profile.Socks_s(profile)[source]

BIG-IP® Socks profile collection.

class f5.bigip.tm.ltm.profile.Socks(Socks_s)[source]

BIG-IP® Socks resource.

class f5.bigip.tm.ltm.profile.Spdys(profile)[source]

BIG-IP® Spdy profile collection.

class f5.bigip.tm.ltm.profile.Spdy(Spdys)[source]

BIG-IP® Spdy resource.

class f5.bigip.tm.ltm.profile.Statistics_s(profile)[source]

BIG-IP® Statistics profile collection.

class f5.bigip.tm.ltm.profile.Statistics(Statistics_s)[source]

BIG-IP® Statistics resource.

class f5.bigip.tm.ltm.profile.Streams(profile)[source]

BIG-IP® Stream profile collection.

class f5.bigip.tm.ltm.profile.Stream(Streams)[source]

BIG-IP® Stream resource.

class f5.bigip.tm.ltm.profile.Tcps(profile)[source]

BIG-IP® Tcp profile collection.

class f5.bigip.tm.ltm.profile.Tcp(Tcps)[source]

BIG-IP® Tcp resource.

class f5.bigip.tm.ltm.profile.Tftps(profile)[source]

BIG-IP® Tftp profile collection.

class f5.bigip.tm.ltm.profile.Tftp(Tftps)[source]

BIG-IP® Tftp resource.

class f5.bigip.tm.ltm.profile.Udps(profile)[source]

BIG-IP® Udp profile collection.

class f5.bigip.tm.ltm.profile.Udp(Udps)[source]

BIG-IP® Udp resource.

class f5.bigip.tm.ltm.profile.Wa_Caches(container)[source]

BIG-IP® Wa_Cache profile collection.

class f5.bigip.tm.ltm.profile.Wa_Cache(container)[source]

BIG-IP® Wa_Cache resource.

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.

class f5.bigip.tm.ltm.profile.Websecurity(Web_Securitys)[source]

BIG-IP® Web_Security resource.

create(**kwargs)[source]

Create is not supported for Web Security

Raises:

UnsupportedOperation

update(**kwargs)[source]

Update is not supported for Web Security

Raises:

UnsupportedOperation

refresh(**kwargs)[source]

Refresh is not supported for Web Security

Raises:

UnsupportedOperation

delete(**kwargs)[source]

Delete is not supported for Web Security

Raises:

UnsupportedOperation

class f5.bigip.tm.ltm.profile.Xmls(profile)[source]

BIG-IP® Xml profile collection.

class f5.bigip.tm.ltm.profile.Xml(Xmls)[source]

BIG-IP® Xml resource.

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]

BIG-IP® LTM rule collection

class f5.bigip.tm.ltm.rule.Rule(rule_s)[source]

BIG-IP® LTM rule resource

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

exception f5.bigip.tm.ltm.snat.RequireOneOf(*args, **kwargs)[source]
class f5.bigip.tm.ltm.snat.Snats(ltm)[source]

BIG-IP® LTM Snat collection

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

class f5.bigip.tm.ltm.snat_translation.Snat_Translations(ltm)[source]

BIG-IP® SNAT Translation collection.

class f5.bigip.tm.ltm.snat_translation.Snat_Translation(Snat_Translations)[source]

BIG-IP® 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:*

class f5.bigip.tm.ltm.snatpool.Snatpools(ltm)[source]

BIG-IP® SNAT Pool collection

class f5.bigip.tm.ltm.snatpool.Snatpool(Snatpools)[source]

BIG-IP® SNAT Pool resource

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]

BIG-IP® LTM Traffic Class collection

class f5.bigip.tm.ltm.traffic_class.Traffic_Class(traffic_class_s)[source]

BIG-IP® LTM Traffic Class Resource

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]

BIG-IP® LTM virtual collection

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 keys name and partition. 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 underlying requests.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 underlying requests.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 underlying requests.session.put method where it will be handled according to that API.

modify(**kwargs)[source]

Modify the configuration of the resource on device based on patch

class f5.bigip.tm.ltm.virtual.Profiles(Profiles_s)[source]

BIG-IP® LTM profile resource

class f5.bigip.tm.ltm.virtual.Profiles_s(virtual)[source]

BIG-IP® LTM profile collection

class f5.bigip.tm.ltm.virtual.Policies(Policies_s)[source]

BIG-IP® LTM Policies resource

exists(**kwargs)[source]

check existence of policy under virtual.

load(**kwargs)[source]

Override load to retrieve object based on exists above.

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.

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

class f5.bigip.tm.ltm.virtual_address.Virtual_Address_s(ltm)[source]

BIG-IP® LTM virtual address collection.

class f5.bigip.tm.ltm.virtual_address.Virtual_Address(Virtual_Address_s)[source]

BIG-IP® LTM virtual address resource.