feat: Add Nutanix v4.2 Python SDK documentation (13 packages)#196
Open
seli-equinix wants to merge 2 commits intoandrewyng:mainfrom
Open
feat: Add Nutanix v4.2 Python SDK documentation (13 packages)#196seli-equinix wants to merge 2 commits intoandrewyng:mainfrom
seli-equinix wants to merge 2 commits intoandrewyng:mainfrom
Conversation
Community-contributed documentation for the Nutanix v4.2 Python SDK, covering all 12 namespace-specific packages plus a unified SDK overview. Covers 112 API classes and 644 methods across: - nutanix-sdk (overview + shared patterns) - nutanix-vmm (VM management) - nutanix-clustermgmt (clusters, hosts, storage containers) - nutanix-networking (subnets, VPCs, floating IPs) - nutanix-prism (tasks, categories, batch operations) - nutanix-dataprotection (DR, recovery points, policies) - nutanix-datapolicies (replication, protection rules) - nutanix-monitoring (alerts, audit, health) - nutanix-volumes (volume groups, iSCSI) - nutanix-lifecycle (LCM inventory, updates) - nutanix-licensing (license management) - nutanix-microseg (Flow network security) - nutanix-aiops (capacity planning, scenarios) Each DOC.md includes accurate function signatures, parameter details, usage examples, and common patterns extracted from the official SDK. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds community-sourced documentation for the Nutanix v4.2 Python SDK, following the repo’s content/<vendor>/docs/<package>/python/DOC.md layout, to provide reliable reference material for coding agents and developers.
Changes:
- Added per-namespace Python SDK guides for Nutanix (vmm, prism, networking, clustermgmt, volumes, etc.).
- Added “complete reference” markdowns for selected large APIs (e.g., VMM VmApi, Clustermgmt ClustersApi, Networking API class list).
- Added a unified SDK overview doc describing shared auth/client patterns, task polling, ETag usage, and OData filtering.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| content/nutanix/docs/nutanix-sdk/python/DOC.md | Unified overview + shared patterns (auth, tasks, ETag, OData) and namespace matrix |
| content/nutanix/docs/nutanix-vmm/python/DOC.md | VMM namespace guide with VM lifecycle examples and key patterns |
| content/nutanix/docs/nutanix-vmm/python/references/vm-api-complete.md | Full VmApi method and model reference (AHV config) |
| content/nutanix/docs/nutanix-prism/python/DOC.md | Prism foundation guide (Tasks, Categories, Batches) with examples |
| content/nutanix/docs/nutanix-networking/python/DOC.md | Networking namespace guide (subnets, VPCs, FIPs, etc.) with examples |
| content/nutanix/docs/nutanix-networking/python/references/api-classes.md | Complete API class/method index for networking |
| content/nutanix/docs/nutanix-clustermgmt/python/DOC.md | Clustermgmt namespace guide (clusters/hosts/storage containers) |
| content/nutanix/docs/nutanix-clustermgmt/python/references/clusters-api-complete.md | Full ClustersApi + StorageContainersApi reference with examples |
| content/nutanix/docs/nutanix-volumes/python/DOC.md | Volumes namespace guide (volume groups, disks, attachments, stats) |
| content/nutanix/docs/nutanix-monitoring/python/DOC.md | Monitoring namespace guide (alerts/events/audits/policies/logs/health checks) |
| content/nutanix/docs/nutanix-microseg/python/DOC.md | Microsegmentation (Flow) guide (security policies, address/service groups) |
| content/nutanix/docs/nutanix-lifecycle/python/DOC.md | LCM guide (inventory, recommendations, notifications, upgrades) |
| content/nutanix/docs/nutanix-licensing/python/DOC.md | Licensing namespace guide (EULA, keys, compliance, entitlements) |
| content/nutanix/docs/nutanix-dataprotection/python/DOC.md | Data protection execution guide (recovery points, replication, failover) |
| content/nutanix/docs/nutanix-datapolicies/python/DOC.md | Data policy/planning guide (protection policies, recovery plans, storage policies) |
| content/nutanix/docs/nutanix-aiops/python/DOC.md | AIOps guide (scenarios, simulations, runway, stats) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
All fixes verified against installed Nutanix v4.2 SDK packages: - Fix TaskStatus values: SDK enum uses CANCELED (single L), not CANCELLED. Added CANCELING and SUSPENDED to status documentation. - Fix Configuration attribute: SDK uses backoff_factor, not backoff_multiplier (verified across networking, clustermgmt, vmm). - Fix wait_for_task() calls: replace undefined `factory` parameter with `prism_client` matching the canonical helper signature (23 call sites across 8 namespace docs). - Fix licensing version: 4.2.1 exists on PyPI, not just 4.3.1. - Fix aiops version note: 4.2.1 stable does not exist on PyPI, only 4.2.1b1 beta — added explicit version note. - Fix VmApi import: use already-imported VmApi directly instead of redundant fully-qualified ntnx_vmm_py_client.api.VmApi path. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Community-contributed documentation for the Nutanix v4.2 Python SDK, covering all 12 namespace-specific packages plus a unified SDK overview.
content/<vendor>/docs/<package>/python/DOC.mdstructuresource: communityas per conventionPackages Added
nutanix-sdknutanix-vmmnutanix-clustermgmtnutanix-networkingnutanix-prismnutanix-dataprotectionnutanix-datapoliciesnutanix-monitoringnutanix-volumesnutanix-lifecyclenutanix-licensingnutanix-microsegnutanix-aiopsWhy
Nutanix runs a significant share of enterprise HCI infrastructure, but LLMs consistently hallucinate its SDK signatures — wrong package names, incorrect import patterns, non-existent methods. These docs give coding agents accurate reference material for the v4.2 SDK.
All function signatures and patterns were verified against the real installed SDK packages from PyPI (
pip install ntnx-*-py-client). The Copilot review flagged 7 issues (version inconsistencies, wrong attribute names, undefined parameters) — all were verified against the SDK source and fixed:TaskStatusenum usesCANCELED(single L), notCANCELLED— verified viantnx_prism_py_client.models.prism.v4.config.Task.TaskStatusConfiguration.backoff_factoris the correct attribute —backoff_multiplierdoes not exist on the classntnx-licensing-py-client==4.2.1exists on PyPI (was incorrectly listed as 4.3.1)ntnx-aiops-py-clientonly has4.2.1b1beta — no stable 4.2.1 release (version note added)Testing
npm testpasses (231/231 tests)chub build content/ --validate-onlysucceeds (1566 docs, 0 errors)pip install --no-deps ntnx-*-py-client==4.2.1)Notes
aiopsnamespace only has a beta release (4.2.1b1) on PyPI — a version note is included in the SDK overview docreferences/subdirectories for the three largest namespaces (vmm, clustermgmt, networking) to keep the main DOC.md under 500 lineswait_for_task(prism_client, ...)helper pattern that matches the canonical definition in the SDK overview doc