nsx_upgrade

NSX upgrade workflow (/api/v1/upgrade/...).

NSX-T’s upgrade surface is two-layered: an upgrade plan drives an ordered set of upgrade unit groups (host, edge, manager), each containing the actual upgrade units (the hosts / edges / managers being upgraded). Bundles supply the bits.

Endpoints used here (all NSX manager HTTP basic auth, via saltext.vcf.utils.nsx):

  • GET    /api/v1/upgrade/status-summary — overall progress + state

  • GET    /api/v1/upgrade/upgrade-unit-groups — list groups

  • GET    /api/v1/upgrade/upgrade-unit-groups/{id}

  • POST   /api/v1/upgrade/upgrade-unit-groups — create custom group

  • PUT    /api/v1/upgrade/upgrade-unit-groups/{id}

  • DELETE /api/v1/upgrade/upgrade-unit-groups/{id}

  • GET    /api/v1/upgrade/upgrade-units — list units across groups

  • GET    /api/v1/upgrade/upgrade-units/{id}

  • POST   /api/v1/upgrade/plan?action={start,pause,resume,reset}

  • GET    /api/v1/upgrade/plan/settings — current plan settings

  • PUT    /api/v1/upgrade/plan/settings — update plan settings

  • GET    /api/v1/upgrade/upgrade-bundles — uploaded bundles

  • GET    /api/v1/upgrade/upgrade-bundles/{id}

  • POST   /api/v1/upgrade/upgrade-bundles?action=upload (multipart) — uploaded out-of-band today

  • GET    /api/v1/upgrade/history — previous runs

The bundle upload itself is multipart and isn’t wrapped here — drop a bundle in via the NSX UI or the standalone curl recipe; this client manages the workflow once a bundle is present.

saltext.vcf.clients.nsx_upgrade.status_summary(opts, profile=None)[source]

Return the overall upgrade status (state, progress %, etc.).

saltext.vcf.clients.nsx_upgrade.history(opts, profile=None)[source]

Return the list of previous upgrade runs.

saltext.vcf.clients.nsx_upgrade.start(opts, profile=None)[source]

Start the upgrade plan.

saltext.vcf.clients.nsx_upgrade.pause(opts, profile=None)[source]

Pause the upgrade plan.

saltext.vcf.clients.nsx_upgrade.resume(opts, profile=None)[source]

Resume a paused plan.

saltext.vcf.clients.nsx_upgrade.reset(opts, profile=None)[source]

Reset the plan back to initial state (discards group ordering).

saltext.vcf.clients.nsx_upgrade.get_plan_settings(opts, profile=None)[source]

Return the plan-level settings (parallelism, pre-checks, etc.).

saltext.vcf.clients.nsx_upgrade.update_plan_settings(opts, settings, profile=None)[source]

Replace the plan-level settings document.

saltext.vcf.clients.nsx_upgrade.create_group(opts, group_spec, profile=None)[source]

Create a custom upgrade unit group.

group_spec keys: display_name, type (HOST/EDGE/MP), upgrade_units (list of unit refs), enabled, parallel, extended_configuration.

saltext.vcf.clients.nsx_upgrade.wait_for_completion(opts, *, timeout=14400, poll_interval=30, profile=None)[source]

Block until status-summary reports a terminal state.

Returns the final status-summary body. Raises TimeoutError if no terminal state in timeout seconds, or RuntimeError on terminal failure / paused-due-to-failure.