{"id":20593736,"url":"https://github.com/robertcsapo/cat9kthousandeyesctl","last_synced_at":"2025-04-14T23:02:15.137Z","repository":{"id":52900920,"uuid":"357661747","full_name":"robertcsapo/cat9kthousandeyesctl","owner":"robertcsapo","description":"Cisco ThousandEyes Agents on Cisco Catalyst 9000","archived":false,"fork":false,"pushed_at":"2022-01-08T09:23:46.000Z","size":23,"stargazers_count":9,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-28T11:04:57.748Z","etag":null,"topics":["agent","apphosting","catalyst-9k","cisco","cloud","container","netconf","python","thousandeyes"],"latest_commit_sha":null,"homepage":"https://www.thousandeyes.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robertcsapo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-13T19:07:28.000Z","updated_at":"2025-03-25T14:05:47.000Z","dependencies_parsed_at":"2022-08-23T09:50:26.644Z","dependency_job_id":null,"html_url":"https://github.com/robertcsapo/cat9kthousandeyesctl","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertcsapo%2Fcat9kthousandeyesctl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertcsapo%2Fcat9kthousandeyesctl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertcsapo%2Fcat9kthousandeyesctl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertcsapo%2Fcat9kthousandeyesctl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertcsapo","download_url":"https://codeload.github.com/robertcsapo/cat9kthousandeyesctl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248975316,"owners_count":21192208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","apphosting","catalyst-9k","cisco","cloud","container","netconf","python","thousandeyes"],"created_at":"2024-11-16T07:49:35.660Z","updated_at":"2025-04-14T23:02:15.108Z","avatar_url":"https://github.com/robertcsapo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cat9kthousandeyesctl\n\nCisco ThousandEyes is a digital experience monitoring platform to see, understand, and improve digital experiences over any network. ThousandEyes offers global vantage points from which users can run a variety of tests to gain more insights and to monitor the performance of their business-critical applications or the network itself.\n- [ThousandEyes Enterprise Agent Deployment Guide on Catalyst 9300 and 9400 Switching Platforms](https://www.cisco.com/c/en/us/products/collateral/switches/catalyst-9400-series-switches/guide-c07-2431113.html)\n- [Installing Enterprise Agents on Cisco Catalyst 9000 Series Switches](https://docs.thousandeyes.com/product-documentation/global-vantage-points/enterprise-agents/installing/cisco-devices/installing-enterprise-agents-on-cisco-catalyst-9000-series-switches)\n\nDeploy Cisco ThousandEyes agent on Cisco Catalyst 9000 with ```cat9kthousandeyesctl```\n\n```\ncat9kthousandeyesctl deploy -c config.yaml  \nDeploying Thousand Eyes Agents\n100.118.1.71:   Thousand eyes agent deployed  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:02:15\n100.118.1.69:   Thousand eyes agent deployed  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:02:13\n100.118.1.81:   Thousand eyes agent deployed  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:02:14\n```\n\n```\ncat9kthousandeyesctl status -c config.yaml            \nCollecting status of Thousand Eyes Agents\n100.118.1.71:   Status completed  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:03\n100.118.1.69:   Status completed  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:03\n100.118.1.81:   Status completed  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:03\n                                                                         \n                       Status Thousand Eyes Agents                       \n┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓\n┃ Host         ┃ Hardware   ┃ Subscription  ┃ Version  ┃ Iox  ┃ Apps                          ┃\n┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩\n│ 100.118.1.71 │ C9300-24UX │ dna-advantage │ 17.03.03 │ True │ thousandeyes_enterprise_agent │\n│ 100.118.1.69 │ C9300-24UX │ dna-advantage │ 17.03.03 │ True │ thousandeyes_enterprise_agent │\n│ 100.118.1.81 │ C9300-24UX │ dna-advantage │ 17.03.03 │ True │ thousandeyes_enterprise_agent │\n└──────────────┴────────────┴───────────────┴──────────┴──────┴───────────────────────────────┘\n```\n\n## Prerequisites\n- Network connectivity\n    - Internet\n    - DNS\n    - DHCP\n- Cisco ThousandEyes Account ([Free trial](https://www.thousandeyes.com/signup/))\n    - Token\n- Cisco Catalyst 9000\n    - C9300\n    - C9400\n- Cisco IOS-XE Software\n    - 17.3.3+\n- ```netconf-yang``` enabled\n- Python 3\n  - Version: 3.7+\n\n## Installation\n\n### Python Package Index (PyPI)\n```pip install cat9kthousandeyesctl```\n\n```cat9kthousandeyesctl --help```\n\n### Config\nDownload [config.yaml](./config.yaml) sample config\n* Edit settings in ```config.yaml```\n  * Username\n  * Password\n  * VLAN\n  * ThousandEyes Token\n  * Hosts (Catalyst 9300/9400 devices)\n\n### Deploy\n```cat9kthousandeyesctl deploy --config config.yaml```\n\n### Status\n```cat9kthousandeyesctl status --config config.yaml```\n\n### Undeploy (remove)\n```cat9kthousandeyesctl undeploy --config config.yaml```\n\n## Features\n\nInclude a succinct summary of the features/capabilities of your project.\n\n- [x] Deploy\n- [x] Status\n- [x] Undeploy\n- [x] YAML Config\n    - VLAN\n    - Agent Download URL\n- [x] Interactive mode (prompt)\n\n## Technologies \u0026 Frameworks Used\n\n**Cisco Products \u0026 Services:**\n\n- Cisco Catalyst 9000\n- Cisco ThousandEyes\n\n**Tools \u0026 Frameworks:**\n\n- Python\n    - click\n    - ncclient\n    - rich\n- Docker\n\n## Usage\n\n```\nUsage: cat9kthousandeyesctl [OPTIONS] COMMAND [ARGS]...\n\n  Manage ThousandEyes Agent on Catalyst 9000\n\nOptions:\n  --version  Show the version and exit.\n  --debug    Enable logging\n  --help     Show this message and exit.\n\nCommands:\n  deploy       Deploy ThousandEyes Agent\n  interactive  Interactive TTY mode\n  status       Status of Application Hosting on the devices\n  undeploy     Remove ThousandEyes Agent\n```\n\n## Config\n\n```\n# Netconf Settings\nusername: admin\npassword: password\nport: 830\ntimeout: 600\n\n# Thousand Eyes Agent Settings\ndownload_url: https://downloads.thousandeyes.com/enterprise-agent/thousandeyes-enterprise-agent-3.0.cat9k.tar\nappid: thousandeyes_enterprise_agent\nvlan: 1\ntoken: thousandeyes_token\n\n# Devices to manage\nhosts:\n  192.168.1.1:\n  192.168.1.2:\n    vlan: 100 # Override global vlan\n  10.0.0.1:\n    vlan: 200\n  10.0.0.2:\n    vlan: 200\n```\n\n## Authors \u0026 Maintainers\n\n- Robert Csapo \u003crcsapo@cisco.com\u003e\n\n## License\n\nThis project is licensed to you under the terms of the [Cisco Sample\nCode License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertcsapo%2Fcat9kthousandeyesctl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertcsapo%2Fcat9kthousandeyesctl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertcsapo%2Fcat9kthousandeyesctl/lists"}