[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/nchekwa/python_ztp/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","nchekwa","reponame","python_ztp","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2020-08-24T13:22:43.187186Z","description","Python ZTP in docker (DHCP/TFTP/HTTP)","is_private","last_updated","2020-11-13T22:25:37.043559Z","last_modified","2025-08-28T04:50:40.277375Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",1502,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Zero touch provisioning (ZTP) (include DHCP/TFTP/HTTP)
\nPython3 script which using YAML file as host config to offer DHCP/IP for device.
\nSystem sniff DHCP packets and answer using own build DHCP responses (based on scapy library)
\nBuilt-in TFTP/HTTP servers allow host download config/firmware which was pointed in dhcp option.
\n
\nNo more installing Isc/Kea DHCP and configuring DHCP scopes/TFTP/HTTP... \n\n## Syntax:\n```console\n[root@server ztp]# ./ztp.py -h\nusage: ztp.py [-h] [-i INTERFACE] [-l LIMIT] [-p PATH] [--port_tftp PORT_TFTP]\n [--port_http PORT_HTTP] [-d PCAP]\n\noptional arguments:\n -h, --help show this help message and exit\n -i INTERFACE, --interface INTERFACE\n Interface to service requests\n -p PATH, --path PATH TFTP folder path. Set `None` to disable TFTP\n --port_tftp PORT_TFTP\n TFTP port\n --port_http PORT_HTTP\n HTTP port\n -d PCAP, --pcap PCAP collect PCAP file name for debug\n```\n\n## Memory consumption:\n```console\n[root@server ztp]# pmap 3068 | grep total\n total 410900K\n```\n\n## Example:\n![Screenshot](doc/img/example_1.png)\n\n### Config Yaml file example:\n```yaml\nVM0021210000:\n mac: 50:00:21:21:00:00\n hostname: Spine-21\n domain: juniper.lab\n ip: 10.240.40.21\n subnet_mask: 255.255.252.0\n router: 10.240.40.1\n name_server: 8.8.8.8 // (only SINGLE server supported)\n lease_time: 60\n tftp_server_name: 10.240.40.254\n boot-file-name: juniper.config\n tftp_server_address: 10.240.40.254\n vendor_specific: 0:junos.tgz,1:VM0021210000/juniper.sh,3:http\n```\n
\nConfig needs to be store in tftp folder in single / or multiple yaml files.
\nConfigs are checked/read everytime when new dhcp Discovery pacet would be capture.
This consuming some resorces (utlize disk) but allow you 'in fly' modyfie config without restarting ztp instance.
\nYAML Config format:
\n\n```yaml\n:\n mac: \n : \n```\nIn some cases new unboxed device report as hostname their serial number so in this situation, if script discovery that hostname inside Discovery message match this - it will use this config section to send Offer.
\n \n![DHCP_Discovery](doc/img/dhcp_discover.png)\n\nIf hostname/name will not be found in config files - it will check in 2nd step - mac match - for DHCP request in all configs.

\nparameters are related to scapy dhcp layer lib which can be found under this [Link](https://github.com/secdev/scapy/blob/master/scapy/layers/dhcp.py) -> DHCPOptions
\nPlease note that parameters tftp_server_name (option 66) and tftp_server_address (option 150) are missing in scapy layer lib so it needs to be added manually:
\n \n```bash\nsed -i 's/ 67: StrField/ 66: \"tftp_server_name\",\\n 67: StrField/g' /usr/local/lib/python3.6/site-packages/scapy/layers/dhcp.py\nsed -i 's/ 255: \"end\"/ 150: IPField(\"tftp_server_address\", \"0.0.0.0\"),\\n 255: \"end\"/g' /usr/local/lib/python3.6/site-packages/scapy/layers/dhcp.py\n```\nScapy issie [2747](https://github.com/secdev/scapy/issues/2747)\n\n\n# [Docker](https://hub.docker.com/r/nchekwa/python_ztp)\nPlease remember that this docker need to be exposed to net=host as we need to get access to broadcast packages (scapy promisc mode). Use *IFACE* env on which interface docker should be listening.
\n\n## Download docker image:\nDownload from [docker.hub](https://hub.docker.com/r/nchekwa/python_ztp)\n```bash\n[user@localhost ~]# docker pull nchekwa/python_ztp\n```\n\n## Run in interactive mode:\n```bash\n[user@localhost ~]# docker run --name ztp --net=host -e IFACE=\"eth1\" -v /tftp:/opt/ztp/tftp --rm -ti nchekwa/python_ztp\n```\n\n## Docker registration:\n```bash\n[user@localhost ~]# docker create \\\n --name=ztp \\\n --net=host \\\n -e IFACE=\"eth1\" \\\n -v /tftp:/opt/ztp/tftp \\\n --restart unless-stopped \\\n nchekwa/python_ztp:latest\n\n[user@localhost ~]# docker ps -a\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\n22cf97689207 nchekwa/python_ztp:latest \"/bin/sh -c '\\\"python…\" About a minute ago Created ztp\n\n[user@localhost ~]# docker start ztp\nztp\n[user@localhost ~]# docker logs -f --tail 10 ztp\nRunning. Press CTRL-C to exit.\n[facts] DHCP/TFTP interface: eth1\n[facts] eth1 IP: 10.240.40.254\n[facts] eth1 MAC: 50:00:00:33:00:01\n[facts] File folder status: exist\n[facts] File Path: /opt/ztp/tftp\n[OK] TFTP starting on 10.240.40.254 - port 69\n[Warning] HTTP 10.240.40.254:80 port in use\n[OK] DHCP starting sniffer eth1 - udp and (port 67 or 68)\neth1|<- [Rcv][Discover][0x61ec0f9e] Host VM0033330000 (50:00:33:33:00:00) asked for an IP\neth1|<- [Rcv][Discover][0x7c78d728] Host VM0033330000 (50:00:33:33:00:00) asked for an IP\n```\n\n## Docker Composer:\n\n### Install:\n```bash\ncurl -L \"https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)\" -o /usr/local/bin/docker-compose\nchmod +x /usr/local/bin/docker-compose\n\ndocker-compose --version\ndocker-compose version 1.26.2, build eefe0d31\n```\n\n### Run:\n#### **`docker-compose.yaml`**\n```yaml\n---\nversion: \"3\"\nservices:\n python_ztp:\n image: nchekwa/python_ztp\n container_name: ztp\n network_mode: host\n environment:\n - IFACE=eth1\n volumes:\n - /tftp:/opt/ztp/tftp\n restart: unless-stopped\n```\n\n```bash\n[user@localhost ~]# docker-compose -f docker-compose.yaml up -d\n[user@localhost ~]# docker-compose -f docker-compose.yaml down\n```\n\n\n\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",484302323,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",10415425,"full_size",78412888,"id",114624376,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:1581f7ef0f6302641e5db3444f7feac70ac641081c369e606f281ad2caf56b42","features","","last_pulled","2026-10-02T01:36:54.501043675Z","last_pushed","2020-11-12T13:25:29Z","os","linux","os_features","os_version","size","variant","2020-11-13T22:25:36.212752Z","last_updater","last_updater_username","media_type","latest","repository",9693722,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

nchekwa/python_ztp

Tags for nchekwa/python_ztp