f5.bigip.tm.asm

Module contents

BIG-IP® Application Security Manager™ (ASM®) module.

REST URI

http://localhost/mgmt/tm/asm/

GUI Path

Security

REST Kind

tm:asm:*

Submodule List

attack_types

file_transfer

policy_templates

BIG-IP® Application Security Manager™ (ASM®) module.

signature_sets

signature_statuses

signature_update

signatures

tasks

BIG-IP® Application Security Manager™ (ASM®) tasks sub-module.

class f5.bigip.tm.asm.Asm(tm)[source]

BIG-IP® Application Security Manager (ASM) organizing

collection.

Submodules

attack_types

class f5.bigip.tm.asm.attack_types.Attack_Types_s(asm)[source]

BIG-IP® ASM Attack Types collection.

class f5.bigip.tm.asm.attack_types.Attack_Type(attack_types_s)[source]

BIG-IP® ASM Attack Type resource

create(**kwargs)[source]

Create is not supported for Attack Type resource

Raises:

UnsupportedOperation

delete(**kwargs)[source]

Delete is not supported for Attack Type resource

Raises:

UnsupportedOperation

modify(**kwargs)[source]

Modify is not supported for Attack Type resource

Raises:

UnsupportedOperation

file_transfer

class f5.bigip.tm.asm.file_transfer.File_Transfer(tm)[source]

BIG-IP® ASM File Transfer collection.

class f5.bigip.tm.asm.file_transfer.Uploads(file_transfer)[source]

A file upload resource.

class f5.bigip.tm.asm.file_transfer.Downloads(file_transfer)[source]

A file download resource.

policy_templates

BIG-IP® Application Security Manager™ (ASM®) module.

REST URI

http://localhost/mgmt/tm/asm/policy-templates

GUI Path

Security -> Options -> Advanced Configuration -> Policy Templates

REST Kind

tm:asm:policy-templates:*

class f5.bigip.tm.asm.policy_templates.Policy_Templates_s(asm)[source]

BIG-IP® ASM Policiy Templates collection.

class f5.bigip.tm.asm.policy_templates.Policy_Template(policy_templates_s)[source]

BIG-IP® ASM Policy Template resource.

create(**kwargs)[source]

Create is not supported for Policy Template resources

Raises:

UnsupportedOperation

delete(**kwargs)[source]

Delete is not supported for Policy Template resources

Raises:

UnsupportedOperation

modify(**patch)[source]

Modify is not supported for Policy Template resources

Raises:

UnsupportedOperation

signature_sets

class f5.bigip.tm.asm.signature_sets.Signature_Sets_s(asm)[source]

BIG-IP® ASM Signature Sets collection.

class f5.bigip.tm.asm.signature_sets.Signature_Set(signature_sets_s)[source]

BIG-IP® ASM Signature Set resource.

note:: Only user created sets can be modified/deleted.

Default sets are READ-ONLY

signature_statuses

class f5.bigip.tm.asm.signature_statuses.Signature_Statuses_s(asm)[source]

BIG-IP® ASM Signature Statuses collection.

class f5.bigip.tm.asm.signature_statuses.Signature_Status(signature_statuses_s)[source]

BIG-IP® ASM Signature Status resource

create(**kwargs)[source]

Create is not supported for Signature Status resource

Raises:

UnsupportedOperation

delete(**kwargs)[source]

Delete is not supported for Signature Status resource

Raises:

UnsupportedOperation

modify(**kwargs)[source]

Modify is not supported for Signature Status resource

Raises:

UnsupportedOperation

signature_udpate

class f5.bigip.tm.asm.signature_update.Signature_Update(asm)[source]

BIG-IP® ASM Signature Update resource

update(**kwargs)[source]

Update is not supported for Signature Update resource

Raises:

UnsupportedOperation

signatures

class f5.bigip.tm.asm.signatures.Signatures_s(asm)[source]

BIG-IP® ASM Signatures collection.

class f5.bigip.tm.asm.signatures.Signature(signatures_s)[source]

BIG-IP® ASM Signature resource.

note:: Only user created signatures can be modified/deleted.

Default signatures are READ-ONLY

create(**kwargs)[source]

Custom creation logic to handle edge cases

This shouldn’t be needed, but ASM has a tendency to raise various errors that are painful to handle from a customer point-of-view. These errors are especially pronounced when doing things concurrently with asm.

The error itself are described in their exception handler

To address these failure, we try a number of exception handling cases to catch and reliably deal with the error.

Parameters:

kwargs

Returns:

delete(**kwargs)[source]

Custom deletion logic to handle edge cases

This shouldn’t be needed, but ASM has a tendency to raise various errors that are painful to handle from a customer point-of-view. These errors are especially pronounced when doing things concurrently with asm.

The error itself are described in their exception handler

To address these failure, we try a number of exception handling cases to catch and reliably deal with the error.

Parameters:

kwargs

Returns:

modify(**kwargs)[source]

Modify the configuration of the resource on device based on patch

update(**kwargs)[source]

Update is not supported for ASM Resources

Raises:

UnsupportedOperation: If method is used.

tasks

BIG-IP® Application Security Manager™ (ASM®) tasks sub-module.

REST URI

http://localhost/mgmt/tm/asm/tasks/

GUI Path

Security

REST Kind

tm:asm:tasks:

class f5.bigip.tm.asm.tasks.Tasks(asm)[source]

BIG-IP® ASM Tasks organizing collection.

class f5.bigip.tm.asm.tasks.Apply_Policy_s(tasks)[source]

BIG-IP® ASM Apply Policy Collection.

class f5.bigip.tm.asm.tasks.Apply_Policy(apply_policy_s)[source]

BIG-IP® ASM Apply Policy Resource.

modify(**kwargs)[source]

Modify is not supported for Apply Policy resource

Raises:

UnsupportedOperation

class f5.bigip.tm.asm.tasks.Export_Policy_s(tasks)[source]

BIG-IP® ASM Export Policy Collection.

class f5.bigip.tm.asm.tasks.Export_Policy(export_policy_s)[source]

BIG-IP® ASM Export Policy Resource.

modify(**kwargs)[source]

Modify is not supported for Apply Policy resource

Raises:

UnsupportedOperation

class f5.bigip.tm.asm.tasks.Import_Policy_s(tasks)[source]

BIG-IP® ASM Import Policy Collection.

class f5.bigip.tm.asm.tasks.Import_Policy(import_policy_s)[source]

BIG-IP® ASM Import Policy 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®.

modify(**kwargs)[source]

Modify is not supported for Apply Policy resource

Raises:

UnsupportedOperation

class f5.bigip.tm.asm.tasks.Check_Signatures_s(tasks)[source]

BIG-IP® ASM Tasks Check Signatures Collection.

class f5.bigip.tm.asm.tasks.Check_Signature(check_signatures_s)[source]

BIG-IP® ASM Tasks Check Signature Resource

To create this resource on the ASM, one must utilize fetch() method from AsmTaskResource class, create() is not supported.

class f5.bigip.tm.asm.tasks.Export_Signatures_s(tasks)[source]

BIG-IP® ASM Tasks Export Signatures Collection.

class f5.bigip.tm.asm.tasks.Export_Signature(export_signatures_s)[source]

BIG-IP® ASM Tasks Export Signature Resource

modify(**kwargs)[source]

Modify is not supported for Export Signature resource

Raises:

UnsupportedOperation

class f5.bigip.tm.asm.tasks.Update_Signatures_s(tasks)[source]

BIG-IP® ASM Tasks Update Signatures Collection.

class f5.bigip.tm.asm.tasks.Update_Signature(update_signatures_s)[source]

BIG-IP® ASM Tasks Update Signature Resource resource

To create this resource on the ASM, one must utilize fetch() method from AsmTaskResource class, create() is not supported.

class f5.bigip.tm.asm.tasks.Import_Vulnerabilities_s(tasks)[source]

BIG-IP® ASM Import Vulnerabilities Collection.

class f5.bigip.tm.asm.tasks.Import_Vulnerabilities(import_vulnerabilities_s)[source]

BIG-IP® ASM Import Vulnerabilities Resource.

modify(**kwargs)[source]

Modify is not supported for Import Vulnerabilities resource

Raises:

UnsupportedOperation