F5 BIG-IQ – Studio Project

Studio Project workflows for F5 BIG-IQ device discovery, onboarding, and licensing

F5 BIG-IQ is F5's centralized management platform for BIG-IP devices — device discovery and onboarding, licensing, and template-based provisioning.

This project provides an OpenAPI spec for automating against BIG-IQ's REST API via an Integration Model, plus a Studio Project of workflows built on that model. It also retains a set of pre-existing workflows built on the legacy F5 BIG-IQ Adapter.

Table of Contents

• Contents
• Requirements
• Integration Configuration
• OpenAPIs
  • f5_bigiq_api-latest.json
• Studio Projects
  • F5 BIG-IQ Project
    • Folder Structure
    • Dependencies

Contents

Requirements

Note: This project does not require Itential Gateway for the Integration Model-backed folders. All API calls are made directly from Itential Platform to BIG-IQ's REST API.

Integration Configuration

Import f5_bigiq_api-latest.json as an Integration Model in Admin > Integrations, then create an integration pointing at your BIG-IQ instance.

Authentication is HTTP Basic:

Authorization: Basic <base64(username:password)>

Use a BIG-IQ user account with appropriate role permissions for the resources you're automating.

The instance's authentication/server properties should look like this once configured:

{
  "authentication": {
    "basicAuth": {
      "username": "<your-bigiq-username>",
      "password": "<your-bigiq-password>"
    }
  },
  "server": {
    "protocol": "https",
    "host": "<your-bigiq-instance>",
    "base_path": "/mgmt"
  }
}

OpenAPIs

f5_bigiq_api-latest.json

Scoped to BIG-IQ's own fleet-management capabilities — device discovery/trust/import, device and service-catalog templates, device management IP pools, and license management (purchased-pool and RegKey licensing, utility billing). Excludes BIG-IP device configuration reached through BIG-IQ's working-config and rest-proxy mechanisms (LTM pools, virtual servers, nodes, network interfaces, etc.) — that's BIG-IP's own configuration surface; see F5/BIG-IP for direct BIG-IP device management.

Resources included, by category:

• Device Discovery & Trust: Discover, trust, import, and remove devices (including a combined discover+import task)
• Device Groups & IP Pools: Device management IP pools — list, create, get, update, delete
• Device Reference & Machine ID: Resolve a device reference or machine ID from a hostname/address
• Device Templates: Device onboarding templates — create, get, update, delete
• Global Templates & Config Sets: Service catalog templates and template-based application config deployment
• Licensing: Purchased-pool licenses, RegKey pools and offerings, license assignment by address, utility billing reports

Studio Projects

F5 BIG-IQ Project

Backed by the F5 BIG-IQ API:latest Integration Model (see f5_bigiq_api-latest.json above) for the new folders, plus the pre-existing legacy adapter folders.

Folder Structure

Dependencies