Applies To:
Show VersionsBIG-IP APM
- 17.1.0, 17.0.0, 16.1.5, 16.1.4, 16.1.3, 16.1.2, 16.1.1, 16.1.0, 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
BIG-IP ASM
- 17.1.0, 17.0.0, 16.1.5, 16.1.4, 16.1.3, 16.1.2, 16.1.1, 16.1.0, 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
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
- 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 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 7.0 release includes:
- A new Azure AD Application configuration template for the Microsoft Integration use case
This integration with Microsoft Azure AD provides seamless access for all modern and classic mission-critical applications. You can now onboard new on-premise applications (SAP and Oracle applications) to Azure AD and modernize application access deployment with single sign-on for secure access through the Guided Configuration interface. - Several enhancements to the Identity Aware Proxy (IAP) configuration template for the Zero Trust use case
- Ability to host a dynamic IAP webtop for web application access: You can now host all your web applications in a webtop and provide end-users with single portal access based on their user groups. Additional functionalities such as defining access based user groups for applications,, selecting primary authentication and MFA for the Webtop, and customizing webtop sections and layout are included in our enhanced Zero Trust solution. You can also customize application links by adding icons, captions, and descriptions for the webtop. End-users have a single sign-on experience when accessing applications configured with the same authentication mechanism as the web portal.
- MFA API Integration with Okta: The new Okta Factors API MFA method allows you to provide API-based access control by integration with Okta MFA for Push, TOTP, and Yubikey factors.
- New Configuration Properties step: This initial step allows you to select the settings to be configured in the IAP workflow.
- Modern customization support
Guided Configuration now gives you the ability to switch use cases between Modern and Standard customization. To change the customization type in a deployed application, you must first un-deploy the application.Note: Modern customization is only supported for the BIG-IP system running 16.0.0 and above. - Ability to select existing virtual servers - You can now select a previously configured virtual server in all the Guided Configuration templates except for the ADFS-Proxy and API Protection Proxy use cases.
Guided Configuration for Advanced Web Application Firewall
The Guided Configuration 7.0 release includes:
A new Traffic Security Policy configuration template for the Web Application Protection use case. The configuration allows you to protect traffic with existing ASM policies by the best match strategy based on the match conditions (URI path, Host, or both).
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
Guided Configuration is upgraded with Use Case Packs provided on downloads.f5.com.
Refer to the article Supported upgrade path for Guided Configuration to get an overview and recommendations before planning for an upgrade to Guided Configuration.
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.
Upgrading the use case pack with the REST API
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 a non-secure 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 (AGC) 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 a 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 the Credential Protection use case are the ones that had been created by Traffic Management User Interface (TMUI) with Access profiles. The virtual servers created and deployed with Guided Configuration 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 a 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. With 200 rate-limiting overrides, and no whitelist/blacklists , the configuration is able to deploy on the i5800 platform. As a workaround,
Refer to the following AskF5 articles for information on how to increase the restjavad heap space: K26427018: Overview of Management provisioning K06150134: The restjavad process may run out of memory when processing a large amount of data |
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. |
769365 | The API Protection Proxyconfiguration 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.
|
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. |
920733 | The Azure AD Applicationconfiguration fails to redeploy after importing giving the following error message: Resource <resource_number> does not exist or one of its queried reference-property objects are not present. As a workaround, undeploy the configuration and deploy it again. |
920885 | If there is only one network interface assigned on the BIG-IP device, the Access Guided Configuration (AGC) deployment may fail giving the following error message: transaction failed:<transaction_number>: Configuration error: Application (/Common/saml_sp.app/saml_sp) with traffic group (/Common/traffic-group-1) may not use the existing virtual address (/Common/10.10.10.100) with traffic group (/Common/traffic-group-local-only) because they use different traffic groups This issue occurs when the BIG-IP VE platform has only one network interface assigned, and the self IP address that belongs to the traffic-group-local-only traffic group is used as the Virtual Server address during deployment. As a workaround:
|
920889 | When you deploy an Azure AD Application configuration, and the Manage Configuration setting is enabled/locked on the AGC landing page, strictUpdates are not enabled, and the corresponding configuration objects can be modified in the BIG-IP Traffic Management User Interface (TMUI). As a workaround,
|
922125 | When you select Address List as the destination address in the Virtual Server step, the Identity Aware Proxy configuration deployment fails, giving the following error message: transaction failed: Invalid IP address: As a workaround,
|
922925 | When you deploy an Identity Aware Proxy configuration by creating a new Virtual Server and a new Client SSL profile, then connecting to the virtual server displays an Access Denied page. This occurs because the URL branching rule in the per-request policy has the application URL pointing to HTTP instead of HTTPS. As a workaround, use an existing Client SSL profile in the Virtual Server step. |
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.
ID number | Description |
---|---|
714573 | New policies cannot be deployed when the device is at the full workload. Trying to deploy a policy at such time generates a Timeout error. The existing deployed policies are not affected. Wait until the load on the device decreases and then deploy new policies. |
719842 | The Guided Configuration cannot activate Behavioral DoS after the failover of an HA configuration while the standby node is active. Behavioral DoS can be activated by the guided configuration only after the initial node recovers, and the HA state is resolved. |
725507 | After deploying a Web Application Firewall configuration, the "Differentiate between HTTP/WS and HTTPS/WSS URLs" checkbox cannot be edited in the Guided Configurations interface. This checkbox can be edited from the BIG-IP UI. |
748910 | After a failover on a multi-blade chassis, some guided configurations are sometimes not available for viewing or editing. To view or edit all configurations after a failover:
|
748912 | After a failover on a multi-blade chassis, the following error message may sometimes appear when attempting to access the guided configurations: error: The requested URL /iapps/f5-iappslx-waf-app-comp-protection/index.html was not found on this server. To successfully access the guided configurations:
|
752179 | Attempting to deploy a Bot Protection configuration imported from a BIG-IP device to a BIG-IP device running a different BIG-IP version deploys successfully, and then returns error messages. To successfully deploy this configuration without error messages:
|
752556 | When you deploy the REST API security (Open API Spec) configuration and then disable the Managed Configuration feature, the Apply Access Policy link is shown in the upper left of the AGC screen. The user will not be able to apply the policy using this link as clicking this link opens an empty list page, which normally would display the name of access policies that need to 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 "apiSecurity101", the command to run would be: tmsh modify apm profile access apiProtection101.app/apiProtection101_ap generation-action increment |
754672 | When you click on Guided Configuration or navigate back and forth too many times after navigating to other BIG-IP menus, the page stops running JavaScript and fails to render in Internet Explorer giving an out of memory error. As a workaround:
|
761669 | The REST API security (Open API Spec) configuration currently supports the maximum number of 500 user groups. Configuring a configuration with 500+ user groups would result in unexpected behavior. |
766597 | When you create the Bot Protection configuration or the Web Application Comprehensive Protection configuration with Bot Defense enabled, the newly created configurations are not displayed in the list. You can view the configuration either from the Guided configuration summary page or by navigating to . |
767845 | On BIG-IP i5800 with APM and AVR provisioned, deploying a REST API security (Open API Spec) configuration with 200 or more rate-limiting overrides or 200 or more whitelist/blacklist entries, may result in an error message. With 200 rate-limiting overrides, and no whitelist/blacklists, the configuration is able to deploy on the i5800 platform. As a workaround,
Refer to the following AskF5 articles for information on how to increase the restjavad heapspace: K26427018: Overview of Management provisioning K06150134: The restjavad process may run out of memory when processing a large amount of data |
920693 | After configuring and deploying a REST API security (Open API Spec) configuration, clicking the View Security Policy link directs you to an ASM policy list with a warning Requested security policy not found even when the security policy is listed on the page. Click the security policy name in the Policies List page to view its properties. |
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 |
---|---|
768041 | Fixed the issue where the Exchange Proxy configuration deployed on the Guided Configuration version 3.0 fails to redeploy after upgrading to version 5.0. |
768093 | Fixed the issue where the Logon Protection configuration deployed on the Guided Configuration version 4.1 failed to redeploy after upgrading to version 5.0. |
790109 | Previously when an API Protection Proxy configuration was created with HTTP Basic Auth and HTTP Basic SSO, the connection failed and gave error due to missing SSO credentials. Now, the default session variable values for the SSO username and password have been modified, and this issue is fixed. |
814549 | Previously, when deploying API Protection Proxy configuration with LDAP Query selected, the deployed policy did not contain the LDAP Query agent. Now, configuring LDAP Query Properties is no longer supported for API Protection Proxy and this issue is fixed. |
831621-1 | Previously, the SAML Identity Provider for Applications and Oauth Authorization Server configurations deployed on the Guided Configuration version 5.0 failed to redeploy after upgrade to version 6.0. This issue has been fixed. |
835169 | Fixed the issue where when the External IdP Connector settings were updated for a deployed SAML Service Provider configuration and then redeployed, the old IdP connector settings are not replaced with the new settings. |
869461 | Previously, when the F5 as OAuth Client and Resource Server configuration was deployed using Azure AD as the provider, then Token Request and Token Refresh Request parameters were not configured for the Oauth client agent. Now, you can add custom Token Request Resource Parameter and Token Refresh Request Resource Parameter values in the Provider Settings step when choosing Azure AD as provider and this issue is resolved. Note: These changes apply only to requests made to the Microsoft identity platform v1.0. Requests containing the resource parameter made to the Microsoft identity platform (v2.0) will fail.
|
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 |
---|---|
785525 | Previously, there were no quick links on the Summary page in the Web Application Comprehensive Protection configuration for the related pages on the BIG-IP security side. Now, the links to related objects are present and this issue is fixed. To manually navigate to the actual pages on the BIG-IP system, use the following navigation paths and locate the objects the operation creates:
|
785553 | Previously, there were no links on the Summary page in the Web Application Comprehensive Protection configuration provided to access Bot and DoS profile-related pages on the BIG-IP security side. Now, the links to related objects are present and this issue is fixed. To manually navigate to the actual pages on the BIG-IP system, use the following navigation paths and locate the objects the operation creates:
|
824689 | Previously, the Bot Protection profiles were not properly synced between the Guided Configuration 6.0 and the BIG-IP version 15.0.0, because the Redirect to Pool mitigation action was not supported in Guided Configuration, but was supported in the BIG-IP version. Now, the Bot Protection configuration has support for Redirect to Pool mitigation, and this issue is fixed. |
825745 | Previously, In BIG-IP 15.0.0, when a Bot Defence profile was updated to include Microservices and Whitelist using the screen, after upgrading to BIG-IP 15.1.0, the Guided Configuration 6.0 did not reflect those changed settings. This happened because the microservices and whitelist settings were not supported in Guided Configuration 5.0 (BIG-IP 15.0.0), and after upgrading to the new version, the profiles were not correctly synced. This issue has been fixed. |
862057 | Fixed the issue where the IP Intelligence step was hidden and was not available for the Web Application Comprehensive Protection configuration, even though the user had the correct license. This issue was seen after performing an upgrade from BIG-IQ. |
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 |
How to Contact F5 Support or the Anti-Fraud SOC
- By phone in the U.S. (accessible 24x7): 888-88askf5 (888-882-7535).
- International contact numbers: http://www.f5.com/training-support/customer-support/contact/.
- The Support Coordinator can contact the SOC as needed.
You can manage service requests and other web-based support online at F5 My Support (registration required). To register email CSP@F5.com with your F5 hardware serial numbers and contact information.
You can contact the Anti-Fraud SOC as follows:
- By phone in the U.S. (accessible 24x7): 866-329-4253 (Option #3 for Anti-Fraud)
- International contact numbers: https://f5.com/products/platforms/silverline/f5-silverline-ddos-protection
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. |