Applies To:
Show VersionsBIG-IP APM
- 17.1.2, 17.1.1, 17.1.0, 17.0.0, 16.1.5, 16.1.4, 16.1.3, 16.1.2, 16.1.1, 16.0.1, 16.0.0, 15.1.10, 15.1.9, 15.1.8, 15.1.7, 15.1.6, 15.1.5, 15.1.4, 15.1.3, 15.1.2, 15.1.1, 15.1.0, 15.0.1, 15.0.0, 14.1.5, 14.1.4, 14.1.3, 14.1.2, 14.1.0
BIG-IP ASM
- 17.1.2, 17.1.1, 17.1.0, 17.0.0, 16.1.5, 16.1.4, 16.1.3, 16.1.2, 16.1.1, 16.0.1, 16.0.0, 15.1.10, 15.1.9, 15.1.8, 15.1.7, 15.1.6, 15.1.4, 15.1.3, 15.1.2, 15.1.1, 15.1.0, 15.0.1, 15.0.0, 14.1.5, 14.1.4, 14.1.3, 14.1.2, 14.1.0
Summary:
Guided Configurations for BIG-IP Access Policy Manager and Advanced Web Application Firewall provide simple, workflow-driven configuration templates that cover common use case scenarios. Guided configurations can be easily created using the configuration templates. These configurations can be further edited, adding more components and apps, using the Guided Configuration interface.
Contents:
- What are Guided Configurations?
- About Upgrading to Guided Configuration 6.0
- Known issues with Guided Configuration for BIG-IP Access Policy Manager
- Known issues with Guided Configuration for BIG-IP Advanced Web Application Firewall
- Fixed issues in Guided Configuration for BIG-IP Access Policy Manager
- Fixed issues in Guided Configuration for BIG-IP Advanced Web Application Firewall
- Contacting F5
- Legal notices
What are Guided Configurations?
Guided Configuration Overview
Guided Configurations for BIG-IP Access Policy Manager and Advanced Web Application Firewall provide simple, workflow-driven configuration templates that cover common use case scenarios. Guided configurations can be easily created using the configuration templates. These configurations can be further edited, adding more components and apps, using the Guided Configuration interface.
Guided Configurations are based on iAppLX technology, which is included with the Access Policy Manager and Advanced Web Application Firewall. Updates to Guided Configurations occur separately from BIG-IP upgrades, by installing use case packs, as detailed later.
Guided Configuration for Access Policy Manager
The Guided Configuration 6.0 release includes:
New enhancements to the Identity Aware Proxy configuration template for the Zero Trust use case. These include support for:
- Unsigned client posture data
- Allowing requests from domain managed devices
- Additional contextual triggers - IP Address Change, User Group Check, HTTP Connector Request, and Device Posture Check
- Adding multiple addresses in a virtual server
- Selecting an existing HTTP Profile and Persistence Profile
- Source session variable for a username and user group - AAA, OAuth, and SAML authentication
- Selecting an existing Active Directory Trusted Domain
- Multiple SSO methods
- HTTP Headers with SSO
- IP address in CIDR format
- SSO NTLMV2
- SSO OAuth Bearer for generating a JWT token or as a passthrough to use JWT from the client
- Multiple trigger rules in the policy
- Re-authenticating
To use the Logon Protection functionality in this template, you need to have a DataSafe license and FPS provisioned.
Configuration for the use case categories is available using
. Configuration steps for authentication, endpoint posture checks, pools, and virtual servers are common to many of the configuration templates.For a brief demonstration on creating a basic Identity Aware Proxy configuration, refer Identity Aware Proxy overview video.
Guided Configuration for Advanced Web Application Firewall
The Guided Configuration 6.0 release includes:
- Enhancements to the Bot Protection and Web Application Comprehensive Protection configuration templates. The templates now allow you to provide verification and mitigation actions for OWASP Automated Threats based on a URL and hostname and configure whitelist objects to be exempt from mitigation.
To use the IP Intelligence feature in the Web Application Comprehensive Protection template, you need to have the IP Intelligence license.
Configuration for the use case categories is available using
. Configuration steps for pools and virtual servers are common to many of the configuration templates.About Upgrading to Guided Configuration 6.0
Guided Configuration is upgraded with Use Case Packs provided on downloads.f5.com.
Upgrading the use case pack from the BIG-IP user interface
- On the Main tab, click or .
- On the top right of the page, click Upgrade Guided Configuration.
- Click Choose File and select the Use Case pack to upgrade.
- Click Upload and Install.
Known issues with Guided Configuration for BIG-IP Access Policy Manager
The following are known issues that affect Guided Configuration for BIG-IP Access Policy Manager.
ID number | Description |
---|---|
671037 | Guided Configuration does not currently conform to FIPS and Common Criteria requirements. Guided Configuration takes authentication server credentials (username and password) from the Secure Vault on the BIG-IP and stores them in an insecure ILX Restricted Storage, which does not conform with the secure storage requirements of FIPS, Common Criteria, PCI, HIPPA, or other modern security certifications, due to lack of protection for the master key. |
672538-1 | On a system configured with Access Guided Configuration objects, the command tmsh load sys config default, for loading the default config removes the BIG-IP configuration objects, but the AGC objects remain. To remove the AGC objects, use the command clear-rest-storage. To keep the AGC objects, undeploy all AGC applications before you run tmsh load sys config default. |
672791 | When Guided Configuration is deployed in an HA environment, the Guided Configuration Use case configurations (iApps) are not synced to the peer device. When HA is configured in Manual Sync Mode, use case configurations are not synced to the HA peer. To ensure that HA is correctly configured for Guided Configuration iApps to function as desired, use a workaround. Configure the following settings for HA. As a workaround, configure your settings for HA as follows:
|
676785 | When Manage Configuration is disabled in Guided Configuration on a deployed configuration, the associated policy changes to Apply Policy status, and is highlighted in yellow. As a workaround, use the BIG-IP UI to apply the policy. |
676902 | When you upgrade the BIG-IP system to a newer build, and select Install Config as No, sometimes the contents of /var/config/rest/iapps from the old partition are not copied to the new partition. This results in a 404 error when you access Guided Configuration using . As a workaround, use the command-line interface for Image upgrade:
|
677964 | When a user returns to Guided Configuration after navigating to other BIG-IP menus, the page fails to render in Internet Explorer, as it stops running JavaScript. As a workaround:
|
681485 | Only Common partition objects are supported. When objects from any other partition are selected, deployment fails. Only select objects from the Common partition when creating a configuration. |
682360 | In Guided Configurations, an iAppLX and an iApp can overwrite each other if they use the same app name. As a workaround, do not use the same name for a Guided Configuration iApp and an iApp (v1.0) instance. The same name cannot be used for two application configurations. |
683765 | Even if the configuration is locked, a user can modify customization settings outside of Guided Configurations. However, the customization settings from Guided Configurations can be restored simply by redeploying the configuration. |
714573 | When the device load is high, policy deployment might fail with a timeout error. As a workaround, wait until the device load is reduced, then deploy. |
719634 | Guided Configuration Synchronization in an HA environment has a particular set of configuration issues.
As a result of the configuration options, it is possible that the Guided Configuration application status (deployed, pending, or not-deployed) may not reflect the state of configuration objects when the sync mode is manual. It is recommended that the administrator should use auto-sync mode when devices are in an HA environment. |
720432-1 | When you undeploy a configuration created with Guided Configuration, the LTM Nodes are not deleted. As a workaround, delete the nodes manually from the BIG-IP UI, or with TMSH. |
720703 | In the OAuth Client & Resource Server Guided Configuration, if the administrator modifies the deployed configuration then attempts to redeploy, deployment may fail. As a workaround, either use the existing DNS resolver when configuring AGC or after modifying the configuration, undeploy, then deploy again. |
739996 | When you create an OAuth authorization server (AS) and a resource server (RS) together, and access RS as a client, using the Logon using Authorization Code grant type option, you are redirected to the AS logon page. This page sometimes repeatedly timeouts before opening an incorrect landing URI. |
744288 | The virtual servers displayed in Credential Protection AGC are the ones that had been created by Traffic Management User Interface (TMUI) with Access profiles. The virtual servers created and deployed with AGC are not available for adding to Credential Protection. You cannot add Credential Protection to an existing AGC deployment. For example, you cannot create an AGC SAML IdP deployment, then use AGC Credential Protection and add it to the AGC SAML IdP deployment. As a workaround, to create an AGC deployment with Credential Protection, follow these steps:
|
750761 | When you change the ADFS Pool Health Monitor value in a deployed configuration and redeploy, the new health monitor is set up on the pool, but the UI shows the old monitor value. As a workaround, to display the new monitor assignment in UI, follow the steps below:
|
752556 | When you deploy the API Protection Proxy configuration and then disable the Managed Configuration feature, the Apply Access Policy link is shown in the top left of the AGC screen. You cannot apply the policy using this link, as this link opens an empty page instead of displaying the list of access policies that can be applied. As a workaround, you can apply the access policy using the following TMSH command: tmsh modify apm profile access <profile-name> generation-action incrementPrepend the <profile-name> with the folder name of the app. For example, if you deployed an application using the name "apiProtection101", the command to run would be: tmsh modify apm profile access apiProtection101.app/apiProtection101_ap generation-action increment |
760946 | When you create a configuration with SAML metadata file, and then upgrade the Guided Configuration, the configuration fails to deploy. This occurs because the metadata file after the upgrade is not found in the desired location. As a workaround, upload the metadata file again using a different file name before deploying the configuration. |
761669 | The API Protection Proxy configuration currently supports the maximum number of 500 user groups. Configuring a configuration with 500+ user groups would result in unexpected behavior. |
766073 | The API Protection Proxy configuration deployed on the Guided Configuration version 4.1 fails to redeploy after upgrading to version 5.0. As a workaround, undeploy the configuration and deploy it again. |
767845 | On BIG-IP i5800 with APM and AVR provisioned, deploying an API Protection Proxy configuration with 200+ rate limiting overrides or 200+ whitelist/blacklist entries, may result in the following error message: error : transaction failed:<transaction_number>: The requested API Protection Profile (/<partition path>/<profile name>) already exists in partition Common. As a workaround, use TMUI when adding a large number of rate limiting overrides or whitelist/blacklist entries. |
768041 | The Exchange Proxy configuration deployed on the Guided Configuration version 3.0 fails to redeploy after upgrading to version 5.0. As a workaround, undeploy the configuration and deploy it again. |
768069 | The OAuth Authorization Server configuration deployed on the Guided Configuration version 4.1 fails to redeploy after upgrading to version 5.0, giving the following error message: error : transaction failed:<transaction_number>: Cannot delete customization group (/Common/OauthServer.app/OauthServer_act_logon_page) because it is used. As a workaround, undeploy the configuration and deploy it again. |
768093 | The Logon Protection configuration deployed on the Guided Configuration version 4.1 fails to redeploy after upgrading to version 5.0. As a workaround, undeploy the configuration and deploy it again. |
769365 | The API Protection Proxy configuration deployed on the Guided Configuration version 4.1 on the BIG-IP 14.1.0 system fails to redeploy after BIG-IP is upgraded to version 15.0, giving the following error message: error : transaction failed:<transaction_number>: The requested API Protection Profile (/<partition path>/<profile name>) already exists in partition Common. As a workaround:
Note: If you also have Advanced WAF licensed and provisioned, you would require an additional step of undeploying and redeploying the application after importing the configuration on step 3.
|
790109 | When an API Protection Proxy configuration is created with HTTP Basic Auth and HTTP Basic SSO, then the connection fails, giving the following error in the logs: Could not find SSO username, check SSO credential mapping agent setting |
814549 | When the API Protection Proxy configuration is configured and an LDAP Query is selected, the resulting deployed policy does not contain the LDAP Query Agent. |
823849 | The Oauth Authorization Server configuration deployed on the Guided Configuration version 4.1 fails to redeploy after upgrade to version 6.0. As a workaround, undeploy the configuration and deploy it again. |
823869 | When the API Authorization with OAuth and F5 as OAuth Client and Resource Server configurations are deployed using the Create New option to select a DNS Resolver, then the configurations fail to redeploy. This happens because the Choose DNS Resolver setting continues to have the Create New option selected and does not use the existing DNS resolver created earlier. As a workaround, select the existing DNS resolver before redeploying. |
831621 | The SAML Identity Provider for Applications and Oauth Authorization Server configurations deployed on the Guided Configuration version 5.0 fails to redeploy after upgrade to version 6.0. As a workaround, undeploy the configuration and deploy it again. |
835169 | When you update the External IdP Connector settings for a deployed SAML Service Provider configuration and redeploy, the old IdP connector settings are not replaced with the new settings. When you access the service provider configuration using , you receive the following error: Error: could not find an IdP connector for saml aaa server that matches IdP selection criteria As a workaround, undeploy the configuration and deploy it again. |
Known issues with Guided Configuration for BIG-IP Advanced Web Application Firewall
The following are known issues that affect Guided Configuration for BIG-IP Advanced Web Application Firewall.
Fixed issues in Guided Configuration for BIG-IP Access Policy Manager
The following are fixed issues in this version of Guided Configuration for BIG-IP Access Policy Manager.
ID Number | Description |
---|---|
720065-3 | Fixed the issue where a redeployment failed with an error message when the application required a file but was not provided before deployment: error : transaction failed:<transaction_number>: file <file_path> expected to exist. |
722774-1 | Previously, you could not configure a client certificate check and Workplace Join in the same ADFS Guided Configuration use case. This issue has been fixed, and now the connections to ADFS is successful. |
723642-1 | Previously, Guided configuration could get into a state where the configuration could not be deployed, undeployed, or deleted. This issue is now fixed. |
763233 | Previously, unlocking and re-locking a deployed API Protection Proxy configuration resulted in an error message, following which you could not undeploy or delete the configuration. This issue has been fixed, and now you can unlock and re-lock the deployed configuration without any error. |
769765 | Previously, the API Protection Proxy configuration deployed with Rate Limiting override failed to redeploy after deleting the override and gave an error. This issue has been fixed, and now you can redeploy without any error. |
778381 | Previously, when the Trusted Certificate Authorities for Client Authentication certificate is updated in a deployed Identity Aware Proxy configuration and redeployed, it did not update and remained the same. This issue has been fixed, and now the certificate is updated successfully. |
793305 | Previously, specifying a route domain with more than three digits in the Destination Address for a Virtual server, gave an error. This issue has been fixed, and now the valid range for route-domain is 0-65534. |
814201 | Previously, the API Protection Proxy configuration configured with LDAP may have missing SearchDN, SearchFilter, UserDN, and Show Extended Errors LDAP authentication properties. This issue has been fixed, and now the LDAP properties are present in the LDAP Auth agent of the deployed policy. |
835121 | Previously, in some cases, when a file with special characters in the file name was uploaded, Guided Configuration would freeze. This issue has been fixed, and now a file name with special characters and spaces can be uploaded successfully. |
Fixed issues in Guided Configuration for BIG-IP Advanced Web Application Firewall
The following are fixed issues in this version of Guided Configuration for Advanced Web Application Firewall.
ID Number | Description |
---|---|
763233 | Previously, unlocking and re-locking a deployed REST API security (Open API Spec) configuration resulted in an error message, following which you could not undeploy or delete the configuration. This issue has been fixed, and now you can unlock and re-lock the deployed configuration without any error. |
769765 | Previously, the REST API security (Open API Spec) configuration deployed with Rate Limiting override, failed to redeploy after deleting the override and gave an error. This issue has been fixed, and now you can redeploy without any error. |
Contacting F5
North America | 1-888-882-7535 or (206) 272-6500 |
Outside North America, Universal Toll-Free | +800 11 ASK 4 F5 or (800 11275 435) |
Additional phone numbers | Regional Offices |
Web | http://www.f5.com |
support@f5.com |
Additional resources
You can find additional support resources and technical documentation through a variety of sources.
F5 Support | Free self-service tools give you 24x7 access to a wealth of knowledge and technical support. Whether it is providing quick answers to questions, training your staff, or handling entire implementations from design to deployment, F5 services teams are ready to ensure that you get the most from your F5 technology. |
AskF5 Knowledge Base | The storehouse for thousands of knowledgebase articles that help you manage your F5 products more effectively. Whether you want to browse periodically to research a solution, or you need the most recent news about your F5 products, AskF5 is your source. |
BIG-IP iHealth Diagnostics and BIG-IP iHealth Viewer | BIG-IP iHealth Diagnostics identifies issues, including common configuration problems and known software issues. It also provides solutions and links to more information. With BIG-IP iHealth Viewer, you can see the status of your system at-a-glance, drill down for details, and view your network configuration. |
F5 DevCentral | Collaborate and share innovations including code samples, new techniques, and other tips, with more than 300,000 F5 users worldwide. DevCentral is the place to ask questions, find solutions, learn to harness the power of F5’s powerful scripting language, iRules, and much more. |
Communications Preference Center | Here, you can subscribe to a number of communications from F5. For information about the types of notifications F5 provides, see K9970: Subscribing to email notifications regarding F5 products. |