{"id":22394354,"url":"https://github.com/akamai/cli-gtm","last_synced_at":"2025-07-31T10:32:40.095Z","repository":{"id":48993062,"uuid":"185437515","full_name":"akamai/cli-gtm","owner":"akamai","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-21T05:11:36.000Z","size":115,"stargazers_count":3,"open_issues_count":7,"forks_count":6,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-07T00:41:34.410Z","etag":null,"topics":["akamai-cli","cli"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akamai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-07T16:12:35.000Z","updated_at":"2025-02-28T00:31:19.000Z","dependencies_parsed_at":"2024-06-19T09:16:50.677Z","dependency_job_id":null,"html_url":"https://github.com/akamai/cli-gtm","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/akamai/cli-gtm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-gtm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-gtm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-gtm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-gtm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akamai","download_url":"https://codeload.github.com/akamai/cli-gtm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-gtm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268024618,"owners_count":24183149,"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","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["akamai-cli","cli"],"created_at":"2024-12-05T05:09:55.374Z","updated_at":"2025-07-31T10:32:39.738Z","avatar_url":"https://github.com/akamai.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Akamai CLI for Global Traffic Management (GTM)\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/akamai/cli-gtm)](https://goreportcard.com/report/github.com/akamai/cli-gtm) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fakamai%2Fcli-gtm.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fakamai%2Fcli-gtm?ref=badge_shield)\n\nAn [Akamai CLI](https://developer.akamai.com/cli) package for managing GTM Domains and associated objects.\n\n## Getting Started\n\n### Installing\n\nTo install this package, use Akamai CLI:\n\n```sh\n$ akamai install gtm\n```\n\nYou may also use this as a stand-alone command by downloading the\n[latest release binary](https://github.com/akamai/cli-gtm/releases)\nfor your system, or by cloning this repository and compiling it yourself.\n\n### Compiling from Source\n\nIf you want to compile it from source, you will need Go 1.18 or later:\n\n1. Create a clone of the target repository:  \n  `git clone https://github.com/akamai/cli-gtm.git`\n2. Change to the package directory and compile the binary:\n   - Linux/macOS/nix: `go build -o akamai-gtm`\n   - Windows: `go build -o akamai-gtm.exe`\n\n## Usage\n\n```\n  akamai-gtm [--edgerc] [--section] \u003ccommand\u003e [sub-command]\n\nDescription:\n   Manage GTM Domains and assoc objects\n\nGlobal Flags:\n   --edgerc value      Location of the credentials file (default: \"/home/testuser/.edgerc\") [$AKAMAI_EDGERC]\n   --section value     Section of the credentials file (default: \"gtm\") [$AKAMAI_EDGERC_SECTION]\n\nBuilt-In Commands:\n  update-datacenter\n  update-property\n  query-status\n  list\n  help\n```\n\n### update-datacenter\n\n```\n$ akamai gtm update-datacenter -help\nName:\n   akamai-gtm update-datacenter\n\nDescription:\n   Update datacenter configuration\n\nUsage:\n   akamai-gtm update-datacenter \u003cdomain\u003e [--datacenter] [--enable] [--disable] [--verbose] [--json] [--complete] [--timeout] [--dryrun]\n\nFlags:\n   --datacenter value      Apply change to specified datacenter traffic target in all property references by id or nickname.\n   --enable                Enable specified datacenter traffic target(s) in all property references.\n   --disable               Disable specified datacenter traffic target(s) in all property references.\n   --verbose               Display verbose result status.\n   --json                  Return status in JSON format.\n   --complete              Wait for change completion.\n   --timeout value         Change completion wait timeout in seconds. (default: 300)\n   --dryrun                Return planned datacenter traffic target change(s).\n```\n\n### update-property\n\n```\n$ akamai gtm update-property -help\nName:\n   akamai-gtm update-property\n\nDescription:\n   Update property configuration\n\nUsage:\n   akamai-gtm update-property [domain, property] [--datacenter] [--liveness_test] [--enable] [--disable] [--weight] [--target] [--server] [--verbose] [--json] [--complete] [--timeout] [--dryrun]\n\nFlags:\n   --datacenter value      Apply change to specified datacenter traffic target by id or nickname. Multiple datacenters may be specified.\n   --liveness_test value   Apply change to specified liveness test. Multiple liveness tests may be specified.\n   --enable                Enable specified datacenter traffic target or property liveness_test.\n   --disable               Disable specified datacenter traffic target or property liveness_test.\n   --weight value          Apply 'weight' to specified datacenter traffic target. (default: 0)\n   --target value          Update specified target field values or add target if doesn't exist. Multiple target flags may be specified.\n   --server value          Update server for specified datacenter traffic target. Multiple server flags may be specified.\n   --verbose               Display verbose result status.\n   --json                  Return status in JSON format.\n   --complete              Wait for change completion.\n   --timeout value         Change completion wait timeout in seconds. (default: 300)\n   --dryrun                Return planned property change(s).\n```\n\n#### Target modifications\n\nProperty targets may be modified or added to properties by using the `target` argument. An example is provided in the following Examples section. The tool will modify the fields specified only. The target value is valid json. Mispselled field names will be ignored, possibly leading to and invalid target configuration. Valid fields are:\n\n* datacenterId: int - Required\n* weight: float64 - Required\n* enabled: bool - Required\n* servers: string list - Optional\n* name: string - Optional\n* handoutCName: string - Optional\n\n### query-status\n\n```\n$ akamai gtm query-status -help\nName:\n   akamai-gtm query-status\n\nDescription:\n   Query current status of domain, property or datacenter\n\nUsage:\n   akamai-gtm query-status \u003cdomain\u003e [--datacenter] [--property] [--verbose] [--json]\n\nFlags:\n   --datacenter value  Report status of specified datacenter by id or nickname.\n   --property value        Report status of specified property.\n   --verbose               Display verbose status.\n   --json                  Return status in JSON format.\n```\n\n## Examples\n\n### Enable datacenters in domain\n\nTo enable one or more datacenters references in all property targets:\n\n```\n$ akamai gtm update-datacenter example.akadns.net --datacenter 3131 --datacenter 3132 --enable\n```\n\n### Update traffic target in property\n\nTo enable a traffic target in a property:\n\n```\n$ akamai gtm update-property example.akadns.net testproperty --datacenter 3131 --disable\n```\n\nTo modify a property target's weight:                                    \n\n```\n$ akamai gtm update-property example.akadns.net testproperty --datacenter 3131 --weight 20\n```\n\nTo modify a property target's servers:\n\n```\n$ akamai gtm update-property example.akadns.net testproperty --datacenter 3131 --server 1.2.3.6 --server 1.2.1.1\n```\n\nTo modify (3131) and add (3134) property traffic targets:\n\n```\n$ akamai gtm update-property test_property.com.akadns.net targettest --dryrun -target '{\"datacenterId\": 3131,\"weight\":30,\"enabled\":true,\"servers\":[\"1.5.6.7\"]}' -target '{\"datacenterId\": 3134,\"weight\":30,\"enabled\":true,\"servers\":[\"1.5.6.8\"]}'\n```\n\nNote: On Windows platforms, use double quotes to enclose the target JSON string and escape the double quotes within the JSON. E.g.\n\n```\nC:\\temp\u003e akamai-gtm.exe --edgerc c:\\scratch\\.edgerc --section default update-property test_property.com.akadns.net targettest --target \"{\\\"datacenterId\\\": 3131,\\\"weight\\\":0,\\\"enabled\\\":true}\" --target \"{\\\"datacenterId\\\": 3134,\\\"weight\\\":0,\\\"enabled\\\":true}\"\n```\n\nNote the dryrun directive in the command line.\n\nTo disable a liveness test in a property:\n\n```\n$ akamai gtm update-property example.akadns.net testproperty --liveness_test test --disable\n```\n\n### Query Status \n\nQuery a datacenter's status:\n\n```\n$ akamai gtm query-status example.akadns.net --datacenter 3132\n```\n\nTo query a property's status:\n\n```\n$ akamai gtm query-status example.akadns.net --property testproperty\n```\n\n## License\n\nThis package is licensed under the Apache 2.0 License. See [LICENSE](LICENSE) for details.\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fakamai%2Fcli-gtm.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fakamai%2Fcli-gtm?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakamai%2Fcli-gtm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakamai%2Fcli-gtm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakamai%2Fcli-gtm/lists"}