F5 Load Balancer F5 BIG-IP iControl REST API — Virtual Servers

naftiko: 1.0.0-alpha2
info:
  label: F5 Load Balancer F5 BIG-IP iControl REST API — Virtual Servers
  description: 'F5 Load Balancer F5 BIG-IP iControl REST API — Virtual Servers. 6 operations. Lead operation: F5 Load Balancer
    List all virtual servers. Self-contained Naftiko capability covering one F5 Load Balancer business surface.'
  tags:
  - F5 Load Balancer
  - Virtual Servers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    F5_LOAD_BALANCER_API_KEY: F5_LOAD_BALANCER_API_KEY
capability:
  consumes:
  - type: http
    namespace: icontrol-rest-virtual-servers
    baseUri: https://{bigip_host}/mgmt/tm
    description: F5 Load Balancer F5 BIG-IP iControl REST API — Virtual Servers business capability. Self-contained, no shared
      references.
    resources:
    - name: ltm-virtual
      path: /ltm/virtual
      operations:
      - name: listvirtualservers
        method: GET
        description: F5 Load Balancer List all virtual servers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createvirtualserver
        method: POST
        description: F5 Load Balancer Create a virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ltm-virtual-virtualName
      path: /ltm/virtual/{virtualName}
      operations:
      - name: getvirtualserver
        method: GET
        description: F5 Load Balancer Get a specific virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatevirtualserver
        method: PUT
        description: F5 Load Balancer Update a virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchvirtualserver
        method: PATCH
        description: F5 Load Balancer Partially update a virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletevirtualserver
        method: DELETE
        description: F5 Load Balancer Delete a virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-F5-Auth-Token
      value: '{{env.F5_LOAD_BALANCER_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: icontrol-rest-virtual-servers-rest
    port: 8080
    description: REST adapter for F5 Load Balancer F5 BIG-IP iControl REST API — Virtual Servers. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/ltm/virtual
      name: ltm-virtual
      description: REST surface for ltm-virtual.
      operations:
      - method: GET
        name: listvirtualservers
        description: F5 Load Balancer List all virtual servers
        call: icontrol-rest-virtual-servers.listvirtualservers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createvirtualserver
        description: F5 Load Balancer Create a virtual server
        call: icontrol-rest-virtual-servers.createvirtualserver
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ltm/virtual/{virtualname}
      name: ltm-virtual-virtualname
      description: REST surface for ltm-virtual-virtualName.
      operations:
      - method: GET
        name: getvirtualserver
        description: F5 Load Balancer Get a specific virtual server
        call: icontrol-rest-virtual-servers.getvirtualserver
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatevirtualserver
        description: F5 Load Balancer Update a virtual server
        call: icontrol-rest-virtual-servers.updatevirtualserver
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchvirtualserver
        description: F5 Load Balancer Partially update a virtual server
        call: icontrol-rest-virtual-servers.patchvirtualserver
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletevirtualserver
        description: F5 Load Balancer Delete a virtual server
        call: icontrol-rest-virtual-servers.deletevirtualserver
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: icontrol-rest-virtual-servers-mcp
    port: 9090
    transport: http
    description: MCP adapter for F5 Load Balancer F5 BIG-IP iControl REST API — Virtual Servers. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: f5-load-balancer-list-all
      description: F5 Load Balancer List all virtual servers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: icontrol-rest-virtual-servers.listvirtualservers
      outputParameters:
      - type: object
        mapping: $.
    - name: f5-load-balancer-create-virtual
      description: F5 Load Balancer Create a virtual server
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: icontrol-rest-virtual-servers.createvirtualserver
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: f5-load-balancer-get-specific
      description: F5 Load Balancer Get a specific virtual server
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: icontrol-rest-virtual-servers.getvirtualserver
      outputParameters:
      - type: object
        mapping: $.
    - name: f5-load-balancer-update-virtual
      description: F5 Load Balancer Update a virtual server
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: icontrol-rest-virtual-servers.updatevirtualserver
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: f5-load-balancer-partially-update
      description: F5 Load Balancer Partially update a virtual server
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: icontrol-rest-virtual-servers.patchvirtualserver
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: f5-load-balancer-delete-virtual
      description: F5 Load Balancer Delete a virtual server
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: icontrol-rest-virtual-servers.deletevirtualserver
      outputParameters:
      - type: object
        mapping: $.