f5.bigip.tm.security

Module contents

BIG-IP® Security module.

REST URI

http://localhost/mgmt/tm/security

GUI Path

Security

REST Kind

tm:security:*

Submodule List

analytics

BIG-IP® Advanced Firewall Manager™ (AFM®) module.

dos

BIG-IP® Advanced Firewall Manager™ (AFM®) module.

firewall

BIG-IP® Advanced Firewall Manager™ (AFM®) module.

protocol_inspection

BIG-IP® Advanced Firewall Manager™ (AFM®) module.

class f5.bigip.tm.security.Security(tm)[source]

BIG-IP® Security organizing collection.

Submodules

analytics

BIG-IP® Advanced Firewall Manager™ (AFM®) module.

REST URI

http://localhost/mgmt/tm/security/analytics

GUI Path

Security --> Network Firewall

REST Kind

tm:security:analytics:*

class f5.bigip.tm.security.analytics.Analytics(security)[source]

BIG-IP® AFM® Analytics organizing collection.

class f5.bigip.tm.security.analytics.Settings(settings)[source]

BIG-IP® Analytics settings resource

dos

BIG-IP® Advanced Firewall Manager™ (AFM®) module.

REST URI

http://localhost/mgmt/tm/security/dos

GUI Path

Security --> Dos Protection

REST Kind

tm:security:dos*

class f5.bigip.tm.security.dos.Dos(security)[source]

BIG-IP® DOS organizing collection.

class f5.bigip.tm.security.dos.Profiles(dos)[source]

BIG-IP® Dos Profile collection

class f5.bigip.tm.security.dos.Profile(profile_s)[source]

BIG-IP® Dos Profile resource

class f5.bigip.tm.security.dos.Applications(profile)[source]

BIG-IP® Dos Profile Application sub-collection

class f5.bigip.tm.security.dos.Application(applications)[source]

BIG-IP® Dos Profile Application resource

load(**kwargs)[source]

Custom load method to address issue in 11.6.0 Final,

where non existing objects would be True.

exists(**kwargs)[source]

Some objects when deleted still return when called by their

direct URI, this is a known issue in 11.6.0.

class f5.bigip.tm.security.dos.Dos_Networks(profile)[source]

BIG-IP® Dos Profile Dos Networks sub-collection

class f5.bigip.tm.security.dos.Dos_Network(dos_networks)[source]

BIG-IP® Dos Profile Dos Network resource

load(**kwargs)[source]

Custom load method to address issue in 11.6.0 Final,

where non existing objects would be True.

exists(**kwargs)[source]

Some objects when deleted still return when called by their

direct URI, this is a known issue in 11.6.0.

class f5.bigip.tm.security.dos.Protocol_Dns_s(profile)[source]

BIG-IP® Dos Profile Protocol Dns sub-collection

class f5.bigip.tm.security.dos.Protocol_Dns(protocol_dns_s)[source]

BIG-IP® Dos Profile Protocol Dns resource

load(**kwargs)[source]

Custom load method to address issue in 11.6.0 Final,

where non existing objects would be True.

exists(**kwargs)[source]

Some objects when deleted still return when called by their

direct URI, this is a known issue in 11.6.0.

class f5.bigip.tm.security.dos.Protocol_Sips(profile)[source]

BIG-IP® Dos Profile Protocol Sip sub-collection

class f5.bigip.tm.security.dos.Protocol_Sip(protocol_sips)[source]

BIG-IP® Dos Profile Protocol Sip resource

load(**kwargs)[source]

Custom load method to address issue in 11.6.0 Final,

where non existing objects would be True.

exists(**kwargs)[source]

Some objects when deleted still return when called by their

direct URI, this is a known issue in 11.6.0.

class f5.bigip.tm.security.dos.Device_Configs(dos)[source]

BIG-IP® Dos Device collection

class f5.bigip.tm.security.dos.Device_Config(device_configs)[source]

BIG-IP® Dos Device resource

create(**kwargs)[source]

Create is not supported for Device_Config

Raises:

UnsupportedOperation

delete(**kwargs)[source]

Delete is not supported for Device_Config

Raises:

UnsupportedOperation

firewall

BIG-IP® Advanced Firewall Manager™ (AFM®) module.

REST URI

http://localhost/mgmt/tm/security/firewall

GUI Path

Security --> Network Firewall

REST Kind

tm:security:firewall:*

class f5.bigip.tm.security.firewall.Firewall(security)[source]

BIG-IP® AFM® Firewall organizing collection.

class f5.bigip.tm.security.firewall.Address_Lists(firewall)[source]

BIG-IP® AFM® Address List collection

class f5.bigip.tm.security.firewall.Address_List(address_lists)[source]

BIG-IP® Address List resource

class f5.bigip.tm.security.firewall.Port_Lists(firewall)[source]

BIG-IP® AFM® Port List collection

class f5.bigip.tm.security.firewall.Port_List(port_lists)[source]

BIG-IP® Port List resource

class f5.bigip.tm.security.firewall.Rule_Lists(firewall)[source]

BIG-IP® AFM® Rule List collection

class f5.bigip.tm.security.firewall.Rule_List(rule_lists)[source]

BIG-IP® Rule List resource

class f5.bigip.tm.security.firewall.Rules_s(policy)[source]

BIG-IP® AFM® Rules sub-collection.

class f5.bigip.tm.security.firewall.Rule(rules_s)[source]

BIG-IP® AFM® Rule resource.

NOTE:: The ‘place-before’ and ‘place-after’ attribute are

mandatory but cannot be present with one another. Those attributes will not be visible when the class is created, they exist for the sole purpose of rule ordering in the BIGIP. The ordering of the rules corresponds to the index in the ‘items’ of the Rules_s sub-collection.

update(**kwargs)[source]

We need to implement the custom exclusive parameter check.

modify(**kwargs)[source]

We need to implement the custom exclusive parameter check.

load(**kwargs)[source]

Custom load method to address issue in 11.6.0 Final,

where non existing objects would be True.

exists(**kwargs)[source]

Some objects when deleted still return when called by their

direct URI, this is a known issue in 11.6.0.

class f5.bigip.tm.security.firewall.Policy_s(firewall)[source]

BIG-IP® AFM® Policy collection

class f5.bigip.tm.security.firewall.Policy(policy_s)[source]

BIG-IP® AFM® Policy resource

class f5.bigip.tm.security.firewall.Global_Rules(global_rules)[source]

BIG-IP® AFM® Global Rules resource

class f5.bigip.tm.security.firewall.Global_Fqdn_Policy(global_fqdn_policy)[source]

BIG-IP® AFM® Global FQDN policy resource

protocol_inspection

BIG-IP® Advanced Firewall Manager™ (AFM®) module.

REST URI

http://localhost/mgmt/tm/security/protocol-inspection

GUI Path
``Security –> Protocol Security –> Inspection_Profiles

Security –> Protocol Security –> Inspection_List

``

REST Kind

tm:security:protocol-inspection*

class f5.bigip.tm.security.protocol_inspection.Protocol_Inspection(security)[source]

BIG-IP® Protocol Inspection Organizing collection

class f5.bigip.tm.security.protocol_inspection.Profiles(protocol_inspection)[source]

“BIG-IP® Protocol Inspection Profile collection

class f5.bigip.tm.security.protocol_inspection.Profile(profiles)[source]

BIG-IP® Protocol Inspection Profile resource

class f5.bigip.tm.security.protocol_inspection.Compliances(protocol_inspection)[source]
class f5.bigip.tm.security.protocol_inspection.Compliance(compliances)[source]

BIG-IP® Protocol Inspection Compliance 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®.

delete(**kwargs)[source]

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 underlying requests.session.delete method where it will be handled according to that API.

Use the method above to pass query args.

modify(**kwargs)[source]

Modify the configuration of the resource on device based on patch

class f5.bigip.tm.security.protocol_inspection.Learning_Suggestions(protocol_inspection)[source]

BIG-IP® Protocol Inspection Compliance resource

class f5.bigip.tm.security.protocol_inspection.Staging(protocol_inspection)[source]

BIG-IP® Protocol Inspection Compliance resource

class f5.bigip.tm.security.protocol_inspection.Profile_Status(protocol_inspection)[source]

BIG-IP® Protocol Inspection Compliance resource

update(**kwargs)[source]

Update is not supported.

Raises:

UnsupportedMethod

class f5.bigip.tm.security.protocol_inspection.Signatures(protocol_inspection)[source]

BIG-IP® Protocol Inspection Signature collection

class f5.bigip.tm.security.protocol_inspection.Signature(signatures)[source]

BIG-IP® Protocol Inspection Signature resource