Applies To:

Show Versions Show Versions

Release Note: Guided Configuration 3.0
Release Note

Original Publication Date: 09/18/2018

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 Guided Configuration
- Upgrading the use case pack from the BIG-IP user interface
- Upgrading the use case pack with the REST API
- Known issues with Guided Configuration for BIG-IP Access Policy Manager
- Known issues with Guided Configuration for BIG-IP Advanced Web Application Firewall
- Legal notices

What are Guided Configurations?

Guided Configurations 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 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 Configurations for Access

This release of Guided Configurations includes several configuration templates for Federation use cases.
  1. F5 As OAuth Client and Resource Server
  2. OAuth Authorization Server
  3. SAML Identity Provider for Applications (includes catalog of templates for SaaS app configurations)
  4. SAML Service Provider (includes a catalog of Identity Provider Connector templates)

This release of Guided Configuration for Access includes configuration templates for Microsoft Product Proxy use cases.

  1. ADFS Proxy
  2. Exchange Proxy

Additional use case categories will be implemented in later releases of Guided Configurations. Configuration for the use case categories is available using Access > Guided Configuration . Configuration steps for authentication, endpoint posture checks, pools, and virtual servers are common to many of the configuration templates.

Guided Configurations for Advanced Web Application Firewall

This release of Guided Configurations includes Advanced Web Application Firewall configuration templates for Security use cases.

  1. Web Application Protection
  2. Behavioral DoS Protection
  3. REST API Protection

    Additional use case categories will be implemented in later releases of Guided Configurations. Configuration for the use case categories are available using Security > Guided Configuration . Configuration steps for virtual servers and pools are common to many of the configuration templates.

About Upgrading Guided Configuration

Guided Configuration is upgraded with Use Case Packs. Such packs contain the latest templates for identity providers and SAML applications. Use case packs will be provided on downloads.f5.com.

Note: There are currently no use case packs available for Guided Configuration.

Upgrading the use case pack from the BIG-IP user interface

Download the use case pack from downloads.f5.com.
You can upgrade use case packs to get the latest guided configurations, and the latest templates for applications and IdP connectors.
  1. On the Main tab, click Access > Guided Configuration or Security > Guided Configuration .
  2. On the top right of the page, click Upgrade Guided Configuration.
  3. Click Choose File and select the Use Case pack to upgrade.
  4. Click Upload and Install.

Upgrading the use case pack with the REST API

Download the use case pack from downloads.f5.com.
You can upgrade use case packs using a REST API.
  1. Make a POST request to install the use case pack, as detailed in the table. For purposes of this example, the use case pack is f5-iappslx-agc-usecase-pack-2-0.0.143.tar.gz.
    Item Description
    URI https://<bigip_address>/mgmt/tm/access/bundle-install-tasks
    METHOD POST
    Request Body {"filePath": "/var/config/rest/downloads/f5-iappslx-agc-usecase-pack-2-0.0.143.tar.gz"}
    Response Body { "filePath": "/var/config/rest/downloads/f5-iappslx-agc-usecase-pack-1-0.0.37.tar.gz", "toBeInstalledAppRpmsIndex": -1, "id": "49c61e18-46e4-4501-bc2d-a4833e93833c", "status": "CREATED", "userReference": { "link": "https://localhost/mgmt/shared/authz/users/admin" }, "identityReferences": [ { "link": "https://localhost/mgmt/shared/authz/users/admin" } ], "ownerMachineId": "3f365fd8-81f8-4312-b837-f0080119635a", "generation": 1, "lastUpdateMicros": 1510767727481955, "kind": "tm:access:bundle-install-tasks:iappbundleinstalltaskstate", "selfLink": "https://localhost/mgmt/tm/access/bundle-install-tasks/49c61e18-46e4-4501-bc2d-a4833e93833cā€ }
  2. Issue a GET command to check the use case pack installation, as detailed in the table. For purposes of this example, the use case pack is f5-iappslx-agc-usecase-pack-2-0.0.143.tar.gz.
    Item Description
    URI https://<bigip_address>/mgmt/tm/access/bundle-install-tasks
    METHOD GET
    Request Body {"filePath": "/var/config/rest/downloads/f5-iappslx-agc-usecase-pack-2-0.0.143.tar.gz"}
    Response Body (displays the installation status of each use-case RPM) { "filePath": "/var/config/rest/downloads/f5-iappslx-agc-usecase-pack-2-0.0.143.tar.gz", "frameworkRpmInfo": { "name": "f5-iappslx-access-framework-1.0.1-0.0.143.noarch.rpm", "status": "INSTALLED", "error": "" }, "appRpmsInfo": [ { "name": "f5-iappslx-access-oauth-auth-server-2.0.0-0.0.143.noarch.rpm", "status": "INSTALLED", "error": "" }, { "name": "f5-iappslx-access-oauth-client-rs-2.0.0-0.0.143.noarch.rpm", "status": "INSTALLED", "error": "" }, { "name": "f5-iappslx-access-saml-idp-1.1.0-0.0.143.noarch.rpm", "status": "INSTALLED", "error": "" }, { "name": "f5-iappslx-access-saml-sp-1.0.0-0.0.143.noarch.rpm", "status": "INSTALLED", "error": "" } ], "toBeInstalledAppRpmsIndex": 4, "alreadyInstalledRpmsInfo": [], "step": "DONE", "manifestFileName": "pack-manifest.json", "manifest": { "description": "manifest of the AGC usecase pack", "usecasePackVersion": 2, "packages": [ { "name": "f5-iappslx-access-framework", "version": "1.0.1", "minBigIpVersion": "13.1.0", "type": "framework" }, { "name": "f5-iappslx-access-saml-idp", "version": "1.1.0", "minBigIpVersion": "13.1.0", "type": "usecase" }, { "name": "f5-iappslx-access-oauth-auth-server", "version": "1.0.0", "minBigIpVersion": "13.1.0", "type": "usecase" }, { "name": "f5-iappslx-access-oauth-client-rs", "version": "1.0.0", "minBigIpVersion": "13.1.0", "type": "usecase" } ] }, "id": "49c61e18-46e4-4501-bc2d-a4833e93833c", "status": "FINISHED", "startTime": "2017-11-15T09:51:30.787-0800", "endTime": "2017-11-15T09:51:45.736-0800", "userReference": { "link": "https://localhost/mgmt/shared/authz/users/admin" }, "identityReferences": [ { "link": "https://localhost/mgmt/shared/authz/users/admin" } ], "ownerMachineId": "3f365fd8-81f8-4312-b837-f0080119635a", "generation": 17, "lastUpdateMicros": 1510768305736676, "kind": "tm:access:bundle-install-tasks:iappbundleinstalltaskstate", "selfLink": "https://localhost/mgmt/tm/access/bundle-install-tasks/49c61e18-46e4-4501-bc2d-a4833e93833c" }

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
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:
  • Reload the page by refreshing the browser
  • Close all Internet Explorer browser instances, restart the browser, and navigate to Guided Configurations again.
712432 The Access Guided Configuration use cases for SAML IDP, ADFS Proxy, and OAuth Authorization Server can enable F5 Adaptive Auth MFA. If this MFA method is enabled, and a DNS resolver is created in the guided configuration workflow, a subsequent redeployment of the use-case, even when no MFA changes are made, fails. As a workaround, create a DNS resolver from the user interface, and use that DNS resolver in Guided Configuration, from the F5 Adaptive Auth MFA configuration step. Alternatively, undeploy the configuration and deploy it again.
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 HA environment has a particular set of configuration issues.

  • The administrator provides configuration properties using the Guided Configuration interface.
  • When the Guided Configuration is deployed, the iAppsLx framework deploys the configuration. A specific Guided Configuration processor deploys the configuration on the device.
  • The configuration is synced to peer HA devices regardless of HA mode (auto-sync or manual).
  • IF HA mode is auto-sync, when a deploy or undeploy action is taken, the configuration is deployed, and changes are synced to peer HA devices.
  • If HA mode is manual sync, the user must manually sync these changes to other devices when a configuration is deployed or undeployed.

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 HA environment.

720065 On redeployment, the redeployment fails with the following error message: error : transaction failed:<transaction_number>: file <file_path> expected to exist. An example file path is /var/config/rest/iapps/f5-iappslx-access-saml-idp/securid-files/Saml_IDP_secrID/defaultSecuridConfig.rec. This failure occurs because a file was not provided before deployment. As a workaround, provide the input file required by the application and noted in the error message.
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 configure AGC, or after modifying the configuration, undeploy, then deploy again.
720432 LTM Nodes are not deleted when a guided configuration created config is undeployed. As a workaround, delete the nodes manually from the BIG-IP UI, or with tmsh.
722774 You cannot configure a certificate check and Workplace Join in the same ADFS Guided Configuration use case. In such a scenario, connections fail. As a workaround, create a second application with a different virtual server, and configure one application for workplace join and the other for the certificate check.
723642 A guided configuration can get "stuck" in a state where it cannot be deployed, undeployed, or deleted. When this happens, as a workaround, navigate to iApps > Application Services > Applications LX , select the application, and click Delete. If the iApps menu is not available, in the linux shell run the command touch /var/config/rest/iapps/enable.
725061

When a user tries to use the Centrify IdP connector template, the entity ID field always throws a validation error, as the validator is incorrect for this field. The user can therefore not finish the step.

As a workaround:
  • Go to /var/config/rest/iapps/f5-iappslx-access-saml-sp/presentation/js/idpTemplates/idpTemplates.json
  • Go to the centrify template section, and change the validator section for Entity ID as follows."validator": [ { "type": "url-validator" } ] Then save the file.

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
715357 In the Web Application Protection and REST API Protection Guided Configuration use cases, when configuring custom XFF headers on the Security Policy Page, the Save and Next buttons are disabled. As a workaround, save a draft of the configuration, return to the landing page, and return to the Guided Configuration in progress from the list. Resume the workflow to complete the configuration.
719842

Behavioral DoS cannot be activated by the guided configuration after a failover of a HA configuration while the stand-by node is active. Behavioral DoS can be activated by the guided configuration only after the initial node recovers and HA state is resolved.

716174

Applications created by iApp cannot be deleted in guided configuration.

714573 New policies cannot be deployed when the device is at full workload. Trying to deploy a policy at such time generates a Timeout error. Existing deployed policies are not affected. Wait until the load on the device decreases and then deploy new policies.

Legal notices

ā€‹
ā€‹

Contacting F5 Networks

Phone - North America: 1-888-882-7535 or (206) 272-6500
Phone - Outside North America, Universal Toll-Free: +800 11 ASK 4 F5 or (800 11275 435)
Fax: See Regional Support for your area.
Web: https://support.f5.com/csp/home
Email: support@f5.com

For additional information, please visit http://www.f5.com.

Additional resources

You can find additional support resources and technical documentation through a variety of sources.

F5 Networks Technical 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

AskF5 is your 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.

F5 DevCentral

The F5 DevCentral community helps you get more from F5 products and technologies. You can connect with user groups, learn about the latest F5 tools, and discuss F5 products and technology.

AskF5 Publication Preference Center

To subscribe, click AskF5 Publication Preference Center, enter your email address, select the publications you want, and click the Submit button. You will receive a confirmation email. You can unsubscribe at any time by clicking the Unsubscribe link at the bottom of the email, or on the AskF5 Publication Preference Center screen.

  • TechNews Weekly eNewsletters: Up-to-date information about product and hotfix releases, new and updated articles, and new feature notices.
  • TechNews Notifications: Periodic plain text TechNews, sent any time F5 releases a product or hotfix. (This information is always included in the next weekly HTML TechNews email.)
  • Security Alerts: Timely security updates and ASM attack signature updates from F5.

Was this resource helpful in solving your issue?




NOTE: Please do not provide personal information.

Additional Comments (optional)