ska-network-deploy-automation documentation
Contents:
API Reference
- GET /api/device/mgmt_intf
Get Mgmt Intf
Request Netbox platform for device’s mgmt interface name, IP and netmask based on serial number query parameter
- Query Parameters:
serial (string) – Device serial number (Required)
- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request: missing or invalid query parameteres
404 Not Found – Entity not found in Netbox
500 Internal Server Error – General error
422 Unprocessable Entity – Validation Error
- GET /api/device/os
Get Os
Request Netbox platform for the OS version that should be installed in the device based on serial, model and current version query parameter
- Query Parameters:
serial (string) – Device serial number (Required)
model (string) – Device model (Required)
version (string) – current OS Version installed (Required)
- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request: missing or invalid query parameteres
404 Not Found – Entity not found in Netbox
500 Internal Server Error – General error
422 Unprocessable Entity – Validation Error
- POST /api/device/config
Post Init Conf
ZTP server is notified with the following HTTP POST that target OS and bootstrap.cfg were installed
- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request: missing or invalid body data
422 Unprocessable Entity – Validation Error
- POST /api/config/test
Post Test Conf
Trigger the testing device pipeline
- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request: missing or invalid body data
403 Forbidden – Device in invalid status for testing config
404 Not Found – Entity not found in Netbox
500 Internal Server Error – General error
422 Unprocessable Entity – Validation Error
- POST /api/config/deploy
Post Deploy Conf
Trigger the configuration deployment (merge)
- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request: missing or invalid body data
403 Forbidden – Device in invalid status for deploying config
404 Not Found – Entity not found in Netbox
500 Internal Server Error – General error
422 Unprocessable Entity – Validation Error
- POST /api/config/render
Post Render Conf
Trigger the configuration rendering in Netbox and save the file in /opt/ska-network-deploy/configs
- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request: missing or invalid body data
403 Forbidden – Device in invalid status for rendering config
404 Not Found – Entity not found in Netbox
500 Internal Server Error – General error
422 Unprocessable Entity – Validation Error