`vcf_nsx_upgrade`¶

Execution module for the NSX upgrade workflow.

saltext.vcf.modules.vcf_nsx_upgrade.status_summary(profile=None)[source]¶

Return overall upgrade status.

CLI Example:

salt '*' vcf_nsx_upgrade.status_summary

saltext.vcf.modules.vcf_nsx_upgrade.history(profile=None)[source]¶: Return previous upgrade runs.

saltext.vcf.modules.vcf_nsx_upgrade.start(profile=None)[source]¶

Start the upgrade plan.

CLI Example:

salt '*' vcf_nsx_upgrade.start

saltext.vcf.modules.vcf_nsx_upgrade.pause(profile=None)[source]¶: Pause the upgrade plan.

saltext.vcf.modules.vcf_nsx_upgrade.resume(profile=None)[source]¶: Resume a paused plan.

saltext.vcf.modules.vcf_nsx_upgrade.reset(profile=None)[source]¶: Reset the plan to initial state.

saltext.vcf.modules.vcf_nsx_upgrade.get_plan_settings(profile=None)[source]¶: Get plan-level settings.

saltext.vcf.modules.vcf_nsx_upgrade.update_plan_settings(settings, profile=None)[source]¶: Replace plan-level settings.

saltext.vcf.modules.vcf_nsx_upgrade.list_groups(profile=None)[source]¶: List upgrade unit groups.

saltext.vcf.modules.vcf_nsx_upgrade.get_group(group_id, profile=None)[source]¶: Get one upgrade unit group.

saltext.vcf.modules.vcf_nsx_upgrade.get_group_or_none(group_id, profile=None)[source]¶: Get one upgrade unit group, or None on 404.

saltext.vcf.modules.vcf_nsx_upgrade.create_group(group_spec, profile=None)[source]¶: Create a custom upgrade unit group.

saltext.vcf.modules.vcf_nsx_upgrade.update_group(group_id, group_spec, profile=None)[source]¶: Update an upgrade unit group.

saltext.vcf.modules.vcf_nsx_upgrade.delete_group(group_id, profile=None)[source]¶: Delete an upgrade unit group.

saltext.vcf.modules.vcf_nsx_upgrade.list_units(group_id=None, profile=None)[source]¶: List upgrade units, optionally filtered by group id.

saltext.vcf.modules.vcf_nsx_upgrade.get_unit(unit_id, profile=None)[source]¶: Get one upgrade unit.

saltext.vcf.modules.vcf_nsx_upgrade.get_unit_or_none(unit_id, profile=None)[source]¶: Get one upgrade unit, or None on 404.

saltext.vcf.modules.vcf_nsx_upgrade.list_bundles(profile=None)[source]¶: List uploaded upgrade bundles.

saltext.vcf.modules.vcf_nsx_upgrade.get_bundle(bundle_id, profile=None)[source]¶: Get one upgrade bundle.

saltext.vcf.modules.vcf_nsx_upgrade.get_bundle_or_none(bundle_id, profile=None)[source]¶: Get one upgrade bundle, or None on 404.

saltext.vcf.modules.vcf_nsx_upgrade.wait_for_completion(timeout=14400, poll_interval=30, profile=None)[source]¶

Block until status-summary reports a terminal state.

CLI Example:

salt '*' vcf_nsx_upgrade.wait_for_completion