pavel/ansible-worker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

0847

Browse Source
This commit is contained in:
pavel
2026-02-10 08:47:35 +02:00
parent c65441b9ea
commit d602607ece
2 changed files with 464 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
files/nb_onedevice_update.py
View File

@@ -2,10 +2,13 @@
"""
nb_sync_one_device.py
Update a single NetBox device from Cloud by hostname — ONLY if device is online.
Update a single NetBox device from Cloud by hostname.
Behavior
- Liveness gate via /v1/devices/{cloud_id}/liveness (no changes if offline).
- Liveness gate via /v1/devices/{cloud_id}/liveness.
* If online: keep ORIGINAL behavior (Cloud is SoT, including IP).
* If offline: query Subsystem for the device and use Subsystem IP as fallback,
then continue with normal NetBox updates.
- Updates NetBox fields from Cloud:
custom_fields.fw_version ← firmwareVersion
custom_fields.nodeName ← nodeName
@@ -13,17 +16,17 @@ Behavior
custom_fields.smallCellName ← smallCellName
serial ← serialNumber
- IP handling:
If Cloud ipAddress is valid (not None/""/"0.0.0.0"):
If chosen IP (Cloud when online, Subsystem when offline) is valid (not None/""/"0.0.0.0"):
ensure eth0, ensure/create IP, MOVE from other device if needed, set primary_ip4,
then PRUNE all other IPs on this device (default).
If Cloud ipAddress is placeholder/invalid:
If chosen IP is placeholder/invalid:
skip IP changes and do not prune.
- --chatty logs step-by-step to stderr; stdout remains one-line OK/FAIL.
- NEW: Logs custom field upgrade_cmd as `NB: upgrade_cmd=<value>` when --chatty.
- Logs custom field upgrade_cmd as `NB: upgrade_cmd=<value>` when --chatty.
Exit codes:
0 = success
1 = not found / missing data / offline
1 = not found / missing data
3 = network/HTTP error
4 = NetBox update error
"""
@@ -31,7 +34,7 @@ Exit codes:
import sys
import json
import argparse
from typing import Optional, Union, List, Dict
from typing import Optional, Union, List, Dict, Any
import requests
from requests.adapters import HTTPAdapter
@@ -40,9 +43,15 @@ from urllib3.util.retry import Retry
# ------------ HARD-CODED CONFIG (per Pavel) ------------
NB_URL = "http://netbox.gt-tiso.ikeja.co.za"
NB_TOKEN = "7648e4f5ee370cda7834682e61b47c2ee8e95623"
CLOUD_API_BASE = "https://cloud.ikeja.co.za/v1/devices"
CLOUD_BEARER = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InBhdmVsLmxAOGRldmljZXMuY29tIiwic3ViIjoyMiwiaWF0IjoxNzY5MDA5NDU0LCJleHAiOjE3NzE2MDE0NTR9.2oovrovOmWq_Ht2s7F2ldXm-vZcxAkqWg6Mra9LUadE"
# NEW: Subsystem fallback (only used when Cloud liveness isConnected=false)
SUBSYSTEM_BASE = "https://subsystem.ikeja.co.za"
SUBSYSTEM_TOKEN = "HJL+&XRCoeHwh5?13@gxvg86qD#kQfgc"
SUBSYSTEM_OUTDOOR_ENDPOINT = "/customers/wave-devices/get-outdoor-devices"
REQ_TIMEOUT = 30
CHATTY = False
@@ -57,13 +66,14 @@ def _new_session() -> requests.Session:
respect_retry_after_header=True,
)
adapter = HTTPAdapter(max_retries=retries, pool_connections=8, pool_maxsize=16)
s.mount('http://', adapter)
s.mount('https://', adapter)
s.headers['Accept'] = 'application/json'
s.mount("http://", adapter)
s.mount("https://", adapter)
s.headers["Accept"] = "application/json"
return s
S_NB = _new_session()
S_CL = _new_session()
S_SUB = _new_session()
# ------------ Logging / status helpers ------------
def log(msg: str):
@@ -71,14 +81,21 @@ def log(msg: str):
print(msg, file=sys.stderr)
def die(code: int, msg: str):
# Single-line result: stdout on success, stderr on failure
print(msg, file=sys.stdout if code == 0 else sys.stderr)
raise SystemExit(code)
def _is_placeholder_ip(v: Any) -> bool:
return v in (None, "", "0.0.0.0")
def _clean_ip(v: Any) -> Any:
if isinstance(v, str):
return v.strip()
return v
# ------------ NetBox API ------------
class NetBox:
def __init__(self, base: str, token: str):
self.base = base.rstrip('/')
self.base = base.rstrip("/")
self.token = token
def _h(self):
@@ -132,7 +149,6 @@ class NetBox:
if r.status_code == 201:
return r.json()["id"]
if r.status_code == 400:
# race: read again
ifid = self.get_iface_id(dev_id, "eth0")
if ifid:
return ifid
@@ -162,10 +178,7 @@ class NetBox:
def assign_ip_to_iface(self, ip_id: int, iface_id: int) -> bool:
log(f"NB: assign IP id={ip_id} -> iface={iface_id}")
r = S_NB.patch(self._url(f"/api/ipam/ip-addresses/{ip_id}/"), headers=self._h(),
data=json.dumps({
"assigned_object_type": "dcim.interface",
"assigned_object_id": iface_id
}),
data=json.dumps({"assigned_object_type": "dcim.interface", "assigned_object_id": iface_id}),
timeout=REQ_TIMEOUT)
return 200 <= r.status_code < 300
@@ -182,24 +195,12 @@ class NetBox:
return (r.json().get("device") or {}).get("id")
return None
# --- Helpers for pruning ---
def list_device_ips(self, dev_id: int) -> List[Dict]:
r = S_NB.get(self._url("/api/ipam/ip-addresses/"), headers=self._h(),
params={"device_id": dev_id, "limit": 1000}, timeout=REQ_TIMEOUT)
if r.status_code == 200:
return r.json().get("results") or []
ips: List[Dict] = []
r2 = S_NB.get(self._url("/api/dcim/interfaces/"), headers=self._h(),
params={"device_id": dev_id, "limit": 1000}, timeout=REQ_TIMEOUT)
if r2.status_code == 200:
for iface in (r2.json().get("results") or []):
ifid = iface.get("id")
r3 = S_NB.get(self._url("/api/ipam/ip-addresses/"), headers=self._h(),
params={"assigned_object_type": "dcim.interface",
"assigned_object_id": ifid, "limit": 1000}, timeout=REQ_TIMEOUT)
if r3.status_code == 200:
ips.extend(r3.json().get("results") or [])
return ips
return []
def delete_ip(self, ip_id: int) -> None:
log(f"NB: delete IP id={ip_id}")
@@ -232,6 +233,33 @@ class Cloud:
die(3, f"FAIL Cloud GET {cloud_id}/liveness HTTP={r.status_code}")
return r.json()
# ------------ Subsystem fallback ------------
class Subsystem:
def __init__(self, base: str, token: str):
self.base = base.rstrip("/")
self.token = token
def _h(self):
return {"token": self.token, "Accept": "application/json"}
def fetch_outdoor_devices(self) -> List[Dict[str, Any]]:
url = f"{self.base}{SUBSYSTEM_OUTDOOR_ENDPOINT}"
log("SUBSYS: fetch outdoor devices list")
r = S_SUB.post(url, headers=self._h(), timeout=REQ_TIMEOUT)
if r.status_code != 200:
die(3, f"FAIL Subsystem POST get-outdoor-devices HTTP={r.status_code}")
data = r.json()
return data.get("device_list") or []
def find_by_name(self, name: str) -> Optional[Dict[str, Any]]:
devs = self.fetch_outdoor_devices()
want = name.lower()
for rec in devs:
n = rec.get("name")
if isinstance(n, str) and n.lower() == want:
return rec
return None
# ------------ Core ------------
def _primary_ip4_text(dev_json: dict) -> Optional[str]:
p = dev_json.get("primary_ip4") or {}
@@ -243,6 +271,7 @@ def _primary_ip4_text(dev_json: dict) -> Optional[str]:
def run(hostname: str) -> None:
nb = NetBox(NB_URL, NB_TOKEN)
cl = Cloud(CLOUD_API_BASE, CLOUD_BEARER)
sub = Subsystem(SUBSYSTEM_BASE, SUBSYSTEM_TOKEN)
dev = nb.get_device_by_name(hostname)
if not dev:
@@ -252,7 +281,6 @@ def run(hostname: str) -> None:
dev_full = nb.get_device(dev_id)
cf = dev_full.get("custom_fields") or {}
# NEW: log upgrade command if present
upgrade_cmd = cf.get("upgrade_cmd")
log(f"NB: upgrade_cmd={upgrade_cmd}")
@@ -260,17 +288,20 @@ def run(hostname: str) -> None:
if cloud_id in (None, "", "null"):
die(1, f"FAIL {hostname} has no custom_fields.cloud_id in NetBox")
# 1) Liveness gate
# 1) Cloud liveness gate (ONLINE path stays as-is)
live = cl.device_liveness(cloud_id)
if not bool(live.get("isConnected")):
die(1, f"FAIL {hostname} cloud_id={cloud_id} device is not online")
cloud_connected = bool(live.get("isConnected"))
if cloud_connected:
log(f"CL: liveness isConnected=true for cloud_id={cloud_id}; using Cloud ipAddress as source of truth")
else:
log(f"CL: liveness isConnected=false for cloud_id={cloud_id}; falling back to Subsystem for IP")
current_nb_ip = _primary_ip4_text(dev_full)
# 2) Cloud detail
# 2) Cloud detail (still used for fw/node/sector/small/serial)
d = cl.device_detail(cloud_id)
fw = d.get("firmwareVersion") or d.get("version")
ip_from_cloud = (d.get("ipAddress") or "").strip() if isinstance(d.get("ipAddress"), str) else d.get("ipAddress")
cloud_ip = _clean_ip(d.get("ipAddress"))
node = d.get("nodeName")
sector = d.get("sectorName")
small = d.get("smallCellName")
@@ -279,6 +310,20 @@ def run(hostname: str) -> None:
if not fw:
die(1, f"FAIL {hostname} cloud_id={cloud_id}: missing firmwareVersion")
# Choose IP source
chosen_ip = cloud_ip
ip_source = "cloud"
if not cloud_connected:
sub_rec = sub.find_by_name(hostname)
if not sub_rec:
# No subsystem record -> keep previous behavior: fail because offline and no fallback source
die(1, f"FAIL {hostname} cloud_id={cloud_id} device offline and not found in Subsystem")
sub_ip = _clean_ip(sub_rec.get("ip"))
chosen_ip = sub_ip
ip_source = "subsystem"
log(f"SUBSYS: {hostname} ip={sub_ip} (fallback)")
# 3) NetBox patch (idempotent)
cf_patch = {}
if cf.get("fw_version") != fw:
@@ -303,29 +348,30 @@ def run(hostname: str) -> None:
nb.patch_device(dev_id, dev_patch)
# 4) IP handling (skip if placeholder)
ip_is_placeholder = (ip_from_cloud in (None, "", "0.0.0.0"))
chosen_ip = _clean_ip(chosen_ip)
ip_is_placeholder = _is_placeholder_ip(chosen_ip)
ip_out_for_status = current_nb_ip # default to current NB IP
if ip_is_placeholder:
log(f"IP: cloud reported placeholder '{ip_from_cloud}', skipping IP changes; keeping NetBox ip(s) as-is")
log(f"IP: {ip_source} reported placeholder '{chosen_ip}', skipping IP changes; keeping NetBox ip(s) as-is")
else:
iface_id = nb.ensure_eth0(dev_id)
ip_rec = nb.get_ip_by_addr(ip_from_cloud)
ip_rec = nb.get_ip_by_addr(chosen_ip)
if ip_rec is None:
log(f"IP: create new {ip_from_cloud} on iface {iface_id}")
ip_id = nb.create_ip_for_iface(ip_from_cloud, iface_id)
log(f"IP: create new {chosen_ip} on iface {iface_id} (source={ip_source})")
ip_id = nb.create_ip_for_iface(chosen_ip, iface_id)
else:
ip_id = ip_rec["id"]
assigned_type = ip_rec.get("assigned_object_type") or ""
assigned_id = ip_rec.get("assigned_object_id")
if not assigned_type:
if not nb.assign_ip_to_iface(ip_id, iface_id):
die(4, f"FAIL assign IP {ip_from_cloud} to iface {iface_id}")
die(4, f"FAIL assign IP {chosen_ip} to iface {iface_id}")
elif assigned_type == "dcim.interface":
if str(assigned_id) != str(iface_id):
other_dev = nb.get_device_id_of_interface(assigned_id) if assigned_id else None
log(f"IP: moving {ip_from_cloud} from iface={assigned_id} dev={other_dev} -> iface={iface_id} dev={dev_id}")
log(f"IP: moving {chosen_ip} from iface={assigned_id} dev={other_dev} -> iface={iface_id} dev={dev_id} (source={ip_source})")
# Clear old device primary if necessary
if other_dev:
r = S_NB.get(nb._url(f"/api/dcim/devices/{other_dev}/"), headers=nb._h(), timeout=REQ_TIMEOUT)
@@ -336,16 +382,15 @@ def run(hostname: str) -> None:
headers=nb._h(), data=json.dumps({"primary_ip4": None}),
timeout=REQ_TIMEOUT)
if not nb.assign_ip_to_iface(ip_id, iface_id):
die(4, f"FAIL move IP {ip_from_cloud} to iface {iface_id}")
die(4, f"FAIL move IP {chosen_ip} to iface {iface_id}")
else:
die(4, f"FAIL IP {ip_from_cloud} assigned to {assigned_type}")
die(4, f"FAIL IP {chosen_ip} assigned to {assigned_type}")
nb.device_set_primary_ip4(dev_id, ip_id)
ip_out_for_status = ip_from_cloud
ip_out_for_status = chosen_ip
# PRUNE all other IPs on this device (default behavior)
all_ips = nb.list_device_ips(dev_id)
for rec in all_ips:
for rec in nb.list_device_ips(dev_id):
rid = rec.get("id")
if str(rid) == str(ip_id):
continue
@@ -357,12 +402,12 @@ def run(hostname: str) -> None:
# ------------ CLI ------------
if __name__ == "__main__":
ap = argparse.ArgumentParser(description="Sync one NetBox device from Cloud by hostname (only if online)")
ap = argparse.ArgumentParser(description="Sync one NetBox device from Cloud by hostname")
ap.add_argument("hostname", help="Device name in NetBox")
ap.add_argument("--chatty", action="store_true", help="Verbose step-by-step logging to stderr")
args = ap.parse_args()
CHATTY = bool(args.chatty) # module-scope assignment
CHATTY = bool(args.chatty)
try:
run(args.hostname)
except requests.RequestException as e: