From 9fb5b65e4a1219b3822c94190e5355af2469a887 Mon Sep 17 00:00:00 2001 From: Guillaume BOURGEOIS Date: Sun, 12 Jul 2026 15:44:28 +0200 Subject: [PATCH] feat(f5-bigip): new F5 BIG-IP integration iControl REST, 6 commands: list virtual servers/pools, get pool members, disable pool member, add data-group record (block). HTTP Basic auth, stdlib-only. Co-Authored-By: Claude Opus 4.8 (1M context) --- integrations/f5-bigip/manifest.yaml | 83 +++++++++++++++++++ .../f5-bigip/scripts/add_datagroup_record.py | 72 ++++++++++++++++ .../f5-bigip/scripts/disable_pool_member.py | 71 ++++++++++++++++ .../f5-bigip/scripts/get_pool_members.py | 63 ++++++++++++++ integrations/f5-bigip/scripts/list_pools.py | 60 ++++++++++++++ .../f5-bigip/scripts/list_virtual_servers.py | 60 ++++++++++++++ .../f5-bigip/scripts/test_connection.py | 61 ++++++++++++++ 7 files changed, 470 insertions(+) create mode 100644 integrations/f5-bigip/manifest.yaml create mode 100644 integrations/f5-bigip/scripts/add_datagroup_record.py create mode 100644 integrations/f5-bigip/scripts/disable_pool_member.py create mode 100644 integrations/f5-bigip/scripts/get_pool_members.py create mode 100644 integrations/f5-bigip/scripts/list_pools.py create mode 100644 integrations/f5-bigip/scripts/list_virtual_servers.py create mode 100644 integrations/f5-bigip/scripts/test_connection.py diff --git a/integrations/f5-bigip/manifest.yaml b/integrations/f5-bigip/manifest.yaml new file mode 100644 index 0000000..6965ee6 --- /dev/null +++ b/integrations/f5-bigip/manifest.yaml @@ -0,0 +1,83 @@ +id: f5_bigip +name: F5 BIG-IP +version: 1.0.0 +description: "F5 BIG-IP (iControl REST) — application-delivery visibility and containment: list virtual servers and pools, read pool members, disable a pool member, and add an IP to an internal data-group (block list). HTTP Basic authentication; stdlib-only, no extra Python dependencies." +changelog: "1.0.0 — Initial release: list virtual servers/pools, get pool members, disable pool member, add data-group record." +category: network + +# Per-instance configuration. HTTP Basic auth against the iControl REST API. +config_schema: + properties: + base_url: + type: string + description: "BIG-IP management URL (e.g. https://bigip.example.com)" + username: + type: string + description: "Admin username" + password: + type: string + description: "Admin password" + x-soar-sensitive: true + insecure: + type: boolean + description: "Trust any TLS certificate (not secure)" + default: false + required: + - base_url + - username + - password + +commands: + - id: list_virtual_servers + name: f5-list-virtual-servers + description: "List virtual servers." + risk: read + inputs_schema: + properties: {} + required: [] + outputs_schema: { properties: {} } + - id: list_pools + name: f5-list-pools + description: "List load-balancing pools." + risk: read + inputs_schema: + properties: {} + required: [] + outputs_schema: { properties: {} } + - id: get_pool_members + name: f5-get-pool-members + description: "List a pool's members." + risk: read + inputs_schema: + properties: + pool_name: { type: string, description: "Pool name (partition path, e.g. ~Common~web_pool)" } + required: [pool_name] + outputs_schema: { properties: {} } + - id: disable_pool_member + name: f5-disable-pool-member + description: "Disable a pool member (drains it — containment)." + inputs_schema: + properties: + pool_name: { type: string, description: "Pool name (partition path)" } + member_name: { type: string, description: "Member name (e.g. ~Common~10.0.0.5:80)" } + required: [pool_name, member_name] + outputs_schema: { properties: {} } + - id: add_datagroup_record + name: f5-add-datagroup-record + description: "Add a record (e.g. an IP) to an internal data-group used by a block iRule." + inputs_schema: + properties: + datagroup_name: { type: string, description: "Internal data-group name (partition path)" } + record_name: { type: string, description: "Record key (e.g. an IP or CIDR)" } + record_data: { type: string, description: "Optional record value" } + required: [datagroup_name, record_name] + outputs_schema: { properties: {} } + + - id: test_connection + name: f5-test-connection + description: "Verify connectivity and credentials (used by the Test button)." + risk: read + inputs_schema: + properties: {} + required: [] + outputs_schema: { properties: {} } diff --git a/integrations/f5-bigip/scripts/add_datagroup_record.py b/integrations/f5-bigip/scripts/add_datagroup_record.py new file mode 100644 index 0000000..5cb98f1 --- /dev/null +++ b/integrations/f5-bigip/scripts/add_datagroup_record.py @@ -0,0 +1,72 @@ +import json, os, sys, base64, ssl, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _ctx(cfg): + if cfg.get("insecure"): + c = ssl.create_default_context() + c.check_hostname = False + c.verify_mode = ssl.CERT_NONE + return c + return None + + +def _auth(cfg): + raw = str(cfg.get("username", "")) + ":" + str(cfg.get("password", "")) + return "Basic " + base64.b64encode(raw.encode("utf-8")).decode("utf-8") + + +def request(method, path, cfg, body=None, params=None): + url = str(cfg.get("base_url", "")).rstrip("/") + "/mgmt/tm" + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": _auth(cfg), "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=60, context=_ctx(cfg)) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + print(json.dumps(fn(_cfg(), _inputs()))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +qn = lambda v: urllib.parse.quote(str(v), safe="~") + + +def main(cfg, inputs): + datagroup_name = inputs.get("datagroup_name") + if not datagroup_name: + raise Exception("datagroup_name is required") + record_name = inputs.get("record_name") + if not record_name: + raise Exception("record_name is required") + record_data = inputs.get("record_data") + return request( + "PATCH", + "/ltm/data-group/internal/" + qn(datagroup_name), + cfg, + body={"records": [{"name": record_name, "data": (record_data or "")}]}, + ) + + +_run(main) diff --git a/integrations/f5-bigip/scripts/disable_pool_member.py b/integrations/f5-bigip/scripts/disable_pool_member.py new file mode 100644 index 0000000..efad74b --- /dev/null +++ b/integrations/f5-bigip/scripts/disable_pool_member.py @@ -0,0 +1,71 @@ +import json, os, sys, base64, ssl, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _ctx(cfg): + if cfg.get("insecure"): + c = ssl.create_default_context() + c.check_hostname = False + c.verify_mode = ssl.CERT_NONE + return c + return None + + +def _auth(cfg): + raw = str(cfg.get("username", "")) + ":" + str(cfg.get("password", "")) + return "Basic " + base64.b64encode(raw.encode("utf-8")).decode("utf-8") + + +def request(method, path, cfg, body=None, params=None): + url = str(cfg.get("base_url", "")).rstrip("/") + "/mgmt/tm" + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": _auth(cfg), "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=60, context=_ctx(cfg)) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + print(json.dumps(fn(_cfg(), _inputs()))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +qn = lambda v: urllib.parse.quote(str(v), safe="~") + + +def main(cfg, inputs): + pool_name = inputs.get("pool_name") + if not pool_name: + raise Exception("pool_name is required") + member_name = inputs.get("member_name") + if not member_name: + raise Exception("member_name is required") + return request( + "PATCH", + "/ltm/pool/" + qn(pool_name) + "/members/" + qn(member_name), + cfg, + body={"session": "user-disabled", "state": "user-down"}, + ) + + +_run(main) diff --git a/integrations/f5-bigip/scripts/get_pool_members.py b/integrations/f5-bigip/scripts/get_pool_members.py new file mode 100644 index 0000000..cf91c3a --- /dev/null +++ b/integrations/f5-bigip/scripts/get_pool_members.py @@ -0,0 +1,63 @@ +import json, os, sys, base64, ssl, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _ctx(cfg): + if cfg.get("insecure"): + c = ssl.create_default_context() + c.check_hostname = False + c.verify_mode = ssl.CERT_NONE + return c + return None + + +def _auth(cfg): + raw = str(cfg.get("username", "")) + ":" + str(cfg.get("password", "")) + return "Basic " + base64.b64encode(raw.encode("utf-8")).decode("utf-8") + + +def request(method, path, cfg, body=None, params=None): + url = str(cfg.get("base_url", "")).rstrip("/") + "/mgmt/tm" + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": _auth(cfg), "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=60, context=_ctx(cfg)) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + print(json.dumps(fn(_cfg(), _inputs()))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +qn = lambda v: urllib.parse.quote(str(v), safe="~") + + +def main(cfg, inputs): + pool_name = inputs.get("pool_name") + if not pool_name: + raise Exception("pool_name is required") + return request("GET", "/ltm/pool/" + qn(pool_name) + "/members", cfg) + + +_run(main) diff --git a/integrations/f5-bigip/scripts/list_pools.py b/integrations/f5-bigip/scripts/list_pools.py new file mode 100644 index 0000000..291a731 --- /dev/null +++ b/integrations/f5-bigip/scripts/list_pools.py @@ -0,0 +1,60 @@ +import json, os, sys, base64, ssl, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _ctx(cfg): + if cfg.get("insecure"): + c = ssl.create_default_context() + c.check_hostname = False + c.verify_mode = ssl.CERT_NONE + return c + return None + + +def _auth(cfg): + raw = str(cfg.get("username", "")) + ":" + str(cfg.get("password", "")) + return "Basic " + base64.b64encode(raw.encode("utf-8")).decode("utf-8") + + +def request(method, path, cfg, body=None, params=None): + url = str(cfg.get("base_url", "")).rstrip("/") + "/mgmt/tm" + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": _auth(cfg), "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=60, context=_ctx(cfg)) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + print(json.dumps(fn(_cfg(), _inputs()))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +qn = lambda v: urllib.parse.quote(str(v), safe="~") + + +def main(cfg, inputs): + return request("GET", "/ltm/pool", cfg) + + +_run(main) diff --git a/integrations/f5-bigip/scripts/list_virtual_servers.py b/integrations/f5-bigip/scripts/list_virtual_servers.py new file mode 100644 index 0000000..af10f0f --- /dev/null +++ b/integrations/f5-bigip/scripts/list_virtual_servers.py @@ -0,0 +1,60 @@ +import json, os, sys, base64, ssl, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _ctx(cfg): + if cfg.get("insecure"): + c = ssl.create_default_context() + c.check_hostname = False + c.verify_mode = ssl.CERT_NONE + return c + return None + + +def _auth(cfg): + raw = str(cfg.get("username", "")) + ":" + str(cfg.get("password", "")) + return "Basic " + base64.b64encode(raw.encode("utf-8")).decode("utf-8") + + +def request(method, path, cfg, body=None, params=None): + url = str(cfg.get("base_url", "")).rstrip("/") + "/mgmt/tm" + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": _auth(cfg), "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=60, context=_ctx(cfg)) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + print(json.dumps(fn(_cfg(), _inputs()))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +qn = lambda v: urllib.parse.quote(str(v), safe="~") + + +def main(cfg, inputs): + return request("GET", "/ltm/virtual", cfg) + + +_run(main) diff --git a/integrations/f5-bigip/scripts/test_connection.py b/integrations/f5-bigip/scripts/test_connection.py new file mode 100644 index 0000000..dd39118 --- /dev/null +++ b/integrations/f5-bigip/scripts/test_connection.py @@ -0,0 +1,61 @@ +import json, os, sys, base64, ssl, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _ctx(cfg): + if cfg.get("insecure"): + c = ssl.create_default_context() + c.check_hostname = False + c.verify_mode = ssl.CERT_NONE + return c + return None + + +def _auth(cfg): + raw = str(cfg.get("username", "")) + ":" + str(cfg.get("password", "")) + return "Basic " + base64.b64encode(raw.encode("utf-8")).decode("utf-8") + + +def request(method, path, cfg, body=None, params=None): + url = str(cfg.get("base_url", "")).rstrip("/") + "/mgmt/tm" + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": _auth(cfg), "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=60, context=_ctx(cfg)) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + print(json.dumps(fn(_cfg(), _inputs()))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +qn = lambda v: urllib.parse.quote(str(v), safe="~") + + +def main(cfg, inputs): + request("GET", "/sys/version", cfg) + return {"ok": True} + + +_run(main)