{"id":20329754,"url":"https://github.com/f5devcentral/f5-bigip-rest-go","last_synced_at":"2025-07-24T18:12:56.324Z","repository":{"id":153086654,"uuid":"627855075","full_name":"f5devcentral/f5-bigip-rest-go","owner":"f5devcentral","description":"a golang library for deploying BIG-IP resources via iControl rest.","archived":false,"fork":false,"pushed_at":"2024-03-26T05:49:52.000Z","size":154,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-11T20:53:01.172Z","etag":null,"topics":[],"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/f5devcentral.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2023-04-14T10:53:53.000Z","updated_at":"2025-02-14T08:07:46.000Z","dependencies_parsed_at":"2024-03-26T06:47:15.772Z","dependency_job_id":null,"html_url":"https://github.com/f5devcentral/f5-bigip-rest-go","commit_stats":null,"previous_names":["f5devcentral/f5-bigip-rest"],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/f5devcentral/f5-bigip-rest-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f5devcentral%2Ff5-bigip-rest-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f5devcentral%2Ff5-bigip-rest-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f5devcentral%2Ff5-bigip-rest-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f5devcentral%2Ff5-bigip-rest-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/f5devcentral","download_url":"https://codeload.github.com/f5devcentral/f5-bigip-rest-go/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f5devcentral%2Ff5-bigip-rest-go/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266885940,"owners_count":24001013,"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-24T02:00:09.469Z","response_time":99,"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":[],"created_at":"2024-11-14T20:13:21.554Z","updated_at":"2025-07-24T18:12:56.277Z","avatar_url":"https://github.com/f5devcentral.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# f5-bigip-rest-go\n\nF5 BIG-IP provides multiple kinds of configuration utilities, including xui, tmsh and iControl Rest.\n\nThis repository provides a golang library for deploying BIG-IP resources via iControl rest. \n\nThere are 3 modules in the library.\n\n* `bigip`\n\n  Used to convert and execute resource requests in the transaction way. \n  \n  Refer to the [example](./examples/bigip/bigip_deploy.go) for its usage. In the example, explainations are given as comments in detail.\n\n  In the example, the resources are gathered within a JSON-format body, the body schema is:\n\n  ```json\n  {\n\t\t\"\u003cfolder name\u003e\": {\n\t\t\t\"\u003cresource type\u003e/\u003cresource name\u003e\": {\n\t\t\t\t\"\u003cresource property name\u003e\": \"\u003cresource property value\u003e\",\n\t\t\t\t\"...\": \"...\"\n\t\t\t},\n\t\t\t\"...\": {\n\t\t\t\t\"...\": \"...\"\n\t\t\t}\n\t\t}\n  }\n  ```\n\n  Supported resource types can be found [here](#supported-resources).\n\n  **The caller should be clear about the very resource's properties it manipulates.** This is important to understand/use this module. \n\n* `utils`\n\n  Provides necessary functions, like, *data manipulating*, *logging*, *Prometheus integrating*, and *http requesting*.\n\n  Refer to the [example](./examples/utils/utils_sample.go) for usage. The module is widely used in `bigip` and `deployer` modules.\n\n* `deployer`\n\n  `deployer` is an encapsulation of `bigip`. It starts a co-routine worker waiting at a golang `chan` for executing deployment requests.\n  \n  The caller assembles and posts the [`DeployRequest`](./deployer/types.go) variable, and the `deployer` organizes and executes the requests.\n\n  Refer to the [example](./examples/deployer/deployer.go) for usage.\n\n## Differences between [scottdware/go-bigip](https://github.com/scottdware/go-bigip) and [f5-bigip-rest-go](https://github.com/f5devcentral/f5-bigip-rest-go)\n\n\n|scottdware/go-bigip|f5devcentral/f5-bigip-rest-go|\n|--|--|\n|Objectifies BIG-IP resources and their CRUD functions|Does no objectifications, only generalized APIs that can be applied to all resources.|\n|It's strongly typed encapsulation.|It's a weakly typed encapsulation with orchestration ability. |\n|Callers are responsible for instantizing resources can call APIs in sequence.|With the provided JSON-format input schema, callers can settle the JSON inputs of multiple resources with type, name, and body |\n|No transaction support.|Regulates, organizes and applies them to BIG-IP in a transaction way.|\n|It's a imperative way to setup ADC abilities on BIG-IP. |The inputting schema is like iControl Rest calls in POSTMAN, while, the deploying process is a declarative mode, like AS3.|\n\n## Supported Resources:\n\n```shell\n\t`sys/folder`,\n\t`shared/file-transfer/uploads`,\n\t`sys/file/ssl-(cert|key)`,\n\t`ltm/monitor/\\w+`,\n\t`ltm/node`,\n\t`ltm/pool`,\n\t`ltm/snat-translation`,\n\t`ltm/snatpool`,\n\t`ltm/profile/\\w+`,\n\t`ltm/persistence/\\w+`,\n\t`ltm/snat$`,\n\t`ltm/rule$`,\n\t`ltm/virtual-address`,\n\t`ltm/virtual$`,\n\t`net/arp$`,\n\t`net/tunnels/vxlan$`,\n\t`net/tunnels/tunnel$`,\n\t`net/fdb/tunnel$`,\n\t`net/ndp$`,\n\t`net/routing/bgp$`,\n\t`net/self$`,\n\t`gtm/datacenter`,\n\t`gtm/server`,\n\t`gtm/monitor/\\w+`,\n\t`gtm/pool/\\w+`,\n\t`gtm/wideip`,\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5devcentral%2Ff5-bigip-rest-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ff5devcentral%2Ff5-bigip-rest-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5devcentral%2Ff5-bigip-rest-go/lists"}