Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
# Global repository owner and sole maintainer
# Repository is strictly internal/private to F5 Service Provider Sales Americas
# Repository code owners and maintainers
* @grobf5
21 changes: 1 addition & 20 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,33 +64,14 @@ id_ecdsa*
.vscode/
scratch/

# Internal F5 communications & OAS scratch files.
#
# Internal announcements, maintenance notices, programme emails and
# leadership decks are not public and are not needed to build or run the
# binary. Keep them locally if they are useful as working context, but do not
# publish them here — this repository is INTERNAL, not private, and
# unannounced platform migrations, programme names and staff contact details
# should not be redistributed through it.
#
# EVERYTHING under internal_docs/ is ignored, whatever it is called. Put
# internal material there and the question of whether it is safe to commit
# does not arise. The filename patterns below are kept as a backstop for
# material dropped into docs/ by mistake, but they only work if the file
# happens to be named correctly — the directory is the real boundary.
# Local scratch documentation & OpenAPI specifications
internal_docs/
openapi*.json

# Backstop patterns for internal material misfiled into docs/.
docs/*INTERNAL*
docs/*_NOTICES_*.txt
docs/*.eml
docs/*.msg
docs/*.pptx
#
# Public F5 knowledge base articles (docs/K*.txt) are deliberately NOT
# ignored: they are already published, and archiving them makes the
# citations in this repository checkable.

# AI assistant workspaces, handoff context, and tool configuration.
# Never commit AI tooling or generated context to this repository.
Expand Down
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Contributing to `myf5-cli`

> [!IMPORTANT]
> **INTERNAL ENTERPRISE TOOL:** `SalesAmerSP/myf5-cli` is an internal automation tool solely authored and maintained by **Greg Robinson** ([`g.robinson@f5.com`](mailto:g.robinson@f5.com)) for F5 Service Provider Sales Americas. This repository is strictly proprietary and confidential and can **NEVER** be made public. External contributions are not accepted.
Thank you for your interest in contributing to `myf5-cli`! This document outlines development environment setup, coding standards, security requirements, testing procedures, and the pull request workflow.

This document outlines environment setup, coding standards, testing requirements, and pull request procedures for internal F5 contributors.
By submitting a contribution to this repository, you agree that your contribution is licensed under the [Apache License, Version 2.0](LICENSE).

---

Expand Down
16 changes: 4 additions & 12 deletions CONTRIBUTING_AI.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,11 @@ weaken that check to make a command easier to call.
Never print, log or commit a credential value. Every client type redacts via
`String()` / `GoString()` — keep it that way.

## The published API spec is not reliable
## API Endpoint Verification

F5's published OpenAPI document disagrees with the running API in several
places and is updated last in any migration. **Test against the service before
changing code to match a document.** A live response beats a specification.
When modifying or extending API client paths, always verify request routes and response schemas against the live API endpoints (`myf5 doctor`, `myf5 cases list`, `myf5 downloads families`). Note that an empty-bodied HTTP `404` from the API gateway typically indicates an unmatched route path (for example, omitting the leading `/v1` gateway prefix) rather than a service outage.

The inverse also holds: a 404 is not proof that a service is down. An
empty-bodied 404 from the F5 gateway means "no such route", which is
indistinguishable from a dead host. Verify the path first.
## Rate Limiting

## Rate limit

Roughly **10 requests per minute**. Exceeding it returns 429 with a
gateway-shaped `{"errors":[...]}` body, which looks different from the
application's own error envelope. Space out probing.
MyF5 Cloud API endpoints enforce a rate limit of approximately **10 requests per minute**. Exceeding the threshold returns HTTP `429 Too Many Requests`. Space out automated diagnostic queries and rely on the built-in client backoff logic.

225 changes: 190 additions & 35 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,35 +1,190 @@
================================================================================
F5 PROPRIETARY AND CONFIDENTIAL INTERNAL ENTERPRISE SOURCE LICENSE
Copyright (c) 2026 F5, Inc. / Service Provider Sales Americas
Author & Maintainer: Greg Robinson (g.robinson@f5.com)
================================================================================

PERMANENT INTERNAL USE RESTRICTION:
This software, associated source code, design specifications, and related
documentation ("Software") are the exclusive proprietary property of F5, Inc.
and are maintained solely for internal engineering and automation operations
within F5 Service Provider Sales Americas.

THIS REPOSITORY AND ITS DERIVATIVES CAN NEVER BE MADE PUBLIC.

1. RESTRICTIONS ON USE AND REDISTRIBUTION:
- This Software is strictly for authorized internal use by F5 personnel.
- External redistribution, publication, public repository hosting, public
forking, disclosure, or transmission in any form, in whole or in part,
to any external entity or individual outside F5, Inc. is strictly prohibited.
- Reverse engineering, decompilation, or unauthorized export of this Software
outside secure internal F5 network boundaries is strictly prohibited.

2. SOLE AUTHORSHIP & GOVERNANCE:
This repository is solely authored and maintained by Greg Robinson
(g.robinson@f5.com). All code changes, issue triage, and security reviews
require explicit approval from the author.

3. DISCLAIMER OF WARRANTY & LIMITATION OF LIABILITY:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS "AS IS" AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE.
================================================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Copyright 2026 F5, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
A high-performance, memory-safe, zero-dependency Go CLI and client library for **MyF5 Cloud APIs**, **Software Downloads**, **iHealth Diagnostics**, **BIG-IP TMOS Appliances**, and **BIG-IQ Centralized Management**.

> [!IMPORTANT]
> **DISCLAIMER:** This project is **NOT** an officially supported F5 product or service.
> It is an internal automation tool solely authored and maintained by **Greg Robinson** ([`g.robinson@f5.com`](mailto:g.robinson@f5.com)) for F5 Service Provider Sales Americas.
> **PERMANENT CLASSIFICATION:** This repository is strictly proprietary and confidential. It can **NEVER** be made public.
> **DISCLAIMER:** This project is a community-maintained tool authored and maintained by **Greg Robinson** ([`g.robinson@f5.com`](mailto:g.robinson@f5.com)) and is **NOT** covered by an official F5 Technical Support SLA.
>
> **API ENTITLEMENT PREREQUISITE:** While this CLI source code is open source, **the MyF5 API itself is not publicly open**. Using MyF5 Cloud API commands (`downloads`, `cases`) requires F5 to enable API support on your customer account and issue account-specific OAuth2 credentials (`F5_CLIENT_ID` and `F5_CLIENT_SECRET`). Direct appliance commands (`bigip`, `bigiq`, `push`, `pull`, `geoip`) and `ihealth` operate independently with your appliance or iHealth credentials.

---

Expand Down Expand Up @@ -67,7 +67,7 @@ myf5-cli/
├── SECURITY.md # Security & vulnerability reporting policy
├── CONTRIBUTING.md # Developer workflow & coding standards
├── CONTRIBUTING_AI.md # Rules for AI assistants — this tool writes to live F5 Support
├── LICENSE # F5 Proprietary & Confidential Internal License
├── LICENSE # Apache License 2.0
├── go.mod
└── README.md
```
Expand Down Expand Up @@ -230,7 +230,7 @@ Works with local management IPs, lab appliances, or cloud/UDF external access pr
./bin/myf5 bigip ready 10.1.1.4

# Check TMOS readiness (via UDF or Cloud Access Proxy)
./bin/myf5 bigip ready https://aa68f6ba-a751-4740-9382-85f7cd7940f2.access.udf.f5.com/
./bin/myf5 bigip ready https://00000000-0000-0000-0000-000000000000.access.udf.f5.com/

# Inspect appliance version, edition, and build details
./bin/myf5 bigip info 10.1.1.4 --user admin
Expand Down
Loading
Loading