Skip to content
F5 Distributed Cloud Tools for Visual Studio Code

F5 Distributed Cloud Tools for Visual Studio Code

The F5 Distributed Cloud Tools (vscode-xcsh) extension integrates F5 Distributed Cloud (XC) platform capabilities directly into Visual Studio Code. The extension provides a unified control plane to author declarative configuration manifests, manage live cloud resources through a virtual file system, inspect telemetry streams, and collaborate with an embedded agentic artificial intelligence (AI) assistant.

Architecture Overview

Section titled “Architecture Overview”

The extension bridges your local developer environment and the F5 Distributed Cloud APIs through three architectural subsystems:

+-------------------------------------------------------------------------+
|                       Visual Studio Code Workspace                      |
|                                                                         |
|  +--------------------+  +--------------------+  +-------------------+  |
|  |  Resource Explorer |  | Virtual FileSystem |  | Schema Engine &   |  |
|  |   & Cloud Status   |  |     (xcsh://)      |  | Conflict Analyzer |  |
|  +---------+----------+  +---------+----------+  +---------+---------+  |
|            |                       |                       |            |
|  +---------+-----------------------+-----------------------+---------+  |
|  |                       Context Manager                             |  |
|  |       3-Tier Resolution: Environment -> Workspace -> Global       |  |
|  +---------------------------------+---------------------------------+  |
|                                    |                                    |
|  +---------------------------------+---------------------------------+  |
|  |                     Agent Process Manager                         |  |
|  |     Bi-directional JSON-RPC Bridge to embedded xcsh engine        |  |
|  +---------------------------------+---------------------------------+  |
+------------------------------------|------------------------------------+
                                     |
               HTTPS (API Tokens / PKCS#12 Certificates)
                                     |
                                     v
+-------------------------------------------------------------------------+
|                     F5 Distributed Cloud Platform                       |
|   Configuration API  |  Data Plane Telemetry  |  Global Status API      |
+-------------------------------------------------------------------------+
  1. Context and Credential Manager: Resolves target tenants and credentials using a 3-tier hierarchy (env variables, workspace-local configurations in .xcsh/contexts/, and secure user storage in VS Code SecretStorage).
  2. Virtual File System (xcsh://): Exposes remote F5 Distributed Cloud resources as local JSON documents. Saving buffer changes immediately serializes and applies the resource definition to the target tenant API.
  3. OpenAPI Schema and Diagnostic Engine: Pre-warms resource schemas derived from F5 Distributed Cloud OpenAPI specifications, providing real-time autocompletion, field requirement validation, and mutual exclusivity conflict diagnostics.
  4. Embedded Agent Subprocess: Operates an integrated xcsh background process communicating via a bi-directional Remote Procedure Call (RPC) bridge over standard input/output (stdio), powering the @xcsh Copilot Chat Participant and Language Model Tools.

Core Capabilities

Section titled “Core Capabilities”
CapabilityDescriptionTarget Workflows
Resource ExplorerNavigate 236+ resource types across 25 domains with curated Console and Full catalog views.Day-2 operations, resource discovery, live inventory inspection.
Direct Resource EditingOpen and edit live cloud configurations using the xcsh:// virtual file system.Immediate updates, configuration reviews, inline adjustments.
Declarative File OperationsValidate, diff, apply, and delete local JSON and YAML manifests against live tenant state.GitOps workflows, automated deployments, configuration reviews.
Schema Validation & IntelliSenseAuthor manifests with autocompletion, hover docs, and instant conflict detection.Safe configuration authoring, compliance checking.
Real-Time ObservabilityQuery access logs, request metrics, and generate visual topology diagrams.Incident triage, performance analysis, architecture validation.
Platform Health MonitoringTrack global service health, active incidents, maintenance windows, and Points of Presence (PoPs).Availability monitoring, maintenance awareness.
Subscription & Quota TrackingInspect active plan tiers, track resource quota consumption, and manage add-ons.Capacity planning, quota management.
Agentic AI AssistanceQuery infrastructure, generate manifests, and troubleshoot using @xcsh in VS Code Chat.Guided configuration, accelerated diagnosis.

Documentation Roadmap

Section titled “Documentation Roadmap”

Navigate the documentation sections below based on your current operational stage:

  • Installation: Verify environment requirements and install the extension via the Marketplace or manual VSIX package.
  • Profile Setup: Configure API tokens or PKCS#12 (.p12) certificates across 3-tier resolution contexts.
  • Resource Management: Browse namespaces, inspect properties, edit live resources, and export configurations.
  • Manifest Operations: Perform declarative apply, diff, and delete operations on workspace files.
  • JSON & YAML IntelliSense: Use OpenAPI-driven autocompletion, hover documentation, and conflict resolution Code Actions.
  • Observability & Diagrams: Stream access logs, query performance metrics, and visualize load balancer architectures.
  • Cloud Status: Monitor platform component availability and regional Point of Presence health.
  • Subscription & Quotas: Monitor plan utilization and manage platform add-ons.
  • Agentic AI Integration: Leverage the @xcsh chat participant, Language Model Tools, and Chat Skills.
  • How-To Guides: Follow step-by-step procedural guides for deploying load balancers and fixing schema conflicts.
  • Troubleshooting: Diagnose and resolve authentication errors, RPC bridge disconnects, and schema rejections.
  • Settings Reference: Consult the complete catalog of all xcsh.* configuration properties.
  • Commands Reference: Review all extension commands, menu actions, and default keyboard shortcuts.
  • Supported Resources: Inspect the complete matrix of 236+ supported resource types across all 25 domains.