User Guide

This User Guide contains information on BIG-IP AS3 and how to install and use it.

About BIG-IP AS3

The Application Services 3 Extension uses a declarative model, meaning you send a declaration file using a single Rest API call. This guide gives an overview of the major components of BIG-IP AS3, with references to more information later in this document. See Document Revision History for information on document changes.

Use the following index and/or the Next/Previous buttons and left and right navigation to explore this User Guide.

Note

As of 3.17.0, BIG-IP AS3 provides feature support for LTM, GTM/DNS, APM, AFM, ASM, and PEM modules. Refer to the product documentation for details on the capabilities supported in these modules.

User Guide Index

• Prerequisites and Requirements
• BIG-IP AS3 Frequently Asked Questions (FAQ)
• Components
  • BIG-IP AS3 Declaration
  • BIG-IP AS3 JSON Schema
• Warnings, Notes, & Tips
  • Warnings
  • Notes and Tips
• Known Issues
• Quick Start
  • Quick start example declaration
• BIG-IP AS3 Best Practices
  • Architecture overview
  • Best Practices
  • Workarounds
• HTTP Methods
  • POST
  • GET
  • DELETE
  • PATCH
• Authentication and Authorization
  • Basic Auth
  • Token Auth
• Downloading and installing the BIG-IP AS3 package
  • Downloading the RPM file
  • Uploading and installing the BIG-IP AS3 file on the BIG-IP
  • Checking for a successful installation
• Uninstalling BIG-IP AS3
  • Uninstalling BIG-IP AS3 from the Configuration utility
  • Uninstalling BIG-IP AS3 from Postman
  • Uninstalling BIG-IP AS3 using cURL
• Upgrading BIG-IP versions when BIG-IP AS3 is installed
• Composing a BIG-IP AS3 Declaration
  • Sample declaration
  • Components of the declaration
• Validating a declaration
• Using BIG-IP AS3 with BIG-IQ
  • Requirements for using BIG-IP AS3 with BIG-IQ
  • Other important notes and warnings
  • Downgrading BIG-IP AS3 on BIG-IQ
• Settings Endpoint
  • Available options for the settings endpoint
  • Using serializeFileUploads to upload a large number of certificates
• Burst handling
  • Burst handling in BIG-IP AS3 v3.23 and later
  • Enabling burst handling in BIG-IP AS3 v3.19 - 3.22
• Unchecked mode
  • Risks with using Unchecked mode
  • Using Unchecked mode
  • Example of Unchecked mode
• Per-Application Declarations
  • Enabling/disabling the per-application feature
  • Example per-application declaration
  • POSTing a per-application
  • Using GET to view applications
  • Deleting a per-application declaration
  • Additional per-application declarations
• Example declarations
  • Example 1: Simple HTTP application
  • Example 2: HTTPS application
  • Example 3: TCP virtual server to ICAP with custom monitor
  • Example 4: Calling resources from a URL source
  • Example 4a: Using PATCH to add a new server to the pool
• Logging
• Troubleshooting
  • BIG-IP AS3 general troubleshooting tips
  • Troubleshooting