vcf_vc_patch

Execution module for vCenter’s VAMI appliance-update REST API (VCSA self-patching).

Patches the vCenter Server Appliance itself: configure an update repository, list/resolve pending updates, stage a build, run prechecks, and install. See saltext.vcf.clients.vc_patch for the underlying REST calls, and saltext.vcf.states.vcf_vc_patch for the declarative/idempotent workflow.

Quick reference:

# Repository + pending updates
salt-call vcf_vc_patch.get_update_policy
salt-call vcf_vc_patch.list_pending_updates
salt-call vcf_vc_patch.get_pending_update 9.0.1.0.12345

# Stage without monitoring (useful on flaky links — see monitor_stage below)
salt-call vcf_vc_patch.stage 9.0.1.0.12345 monitor=false
salt-call vcf_vc_patch.get_update_status
salt-call vcf_vc_patch.get_staged_update

# Install (requires the SSO admin password)
salt-call vcf_vc_patch.install 9.0.1.0.12345 'VMware123!VMware123!'
saltext.vcf.modules.vcf_vc_patch.get_update_policy(profile=None)[source]

Get update policy.

CLI Example:

salt '*' vcf_vc_patch.get_update_policy
saltext.vcf.modules.vcf_vc_patch.get_repository_policy(profile=None)[source]

Alias for get_update_policy().

CLI Example:

salt '*' vcf_vc_patch.get_repository_policy
saltext.vcf.modules.vcf_vc_patch.update_repository_policy(repository_url=None, auto_stage=None, certificate_check=None, check_schedule=None, repo_username=None, repo_password=None, profile=None)[source]

Configure the update-repository policy.

CLI Example:

salt '*' vcf_vc_patch.update_repository_policy http://repo.example.com/vcsa/
saltext.vcf.modules.vcf_vc_patch.list_pending_updates(repository_url=None, source_type='LOCAL_AND_ONLINE', profile=None)[source]

List pending updates.

CLI Example:

salt '*' vcf_vc_patch.list_pending_updates
saltext.vcf.modules.vcf_vc_patch.check_updates(repository_url=None, source_type='LOCAL_AND_ONLINE', profile=None)[source]

Alias for list_pending_updates().

CLI Example:

salt '*' vcf_vc_patch.check_updates
saltext.vcf.modules.vcf_vc_patch.get_pending_update(version=None, profile=None)[source]

Get pending update.

CLI Example:

salt '*' vcf_vc_patch.get_pending_update <version>
saltext.vcf.modules.vcf_vc_patch.list_upgradeable_components(version=None, profile=None)[source]

List upgradeable components.

CLI Example:

salt '*' vcf_vc_patch.list_upgradeable_components <version>
saltext.vcf.modules.vcf_vc_patch.get_update_status(profile=None)[source]

Get update status.

CLI Example:

salt '*' vcf_vc_patch.get_update_status
saltext.vcf.modules.vcf_vc_patch.get_staged_update(profile=None)[source]

Get staged update.

CLI Example:

salt '*' vcf_vc_patch.get_staged_update
saltext.vcf.modules.vcf_vc_patch.delete_staged_update(profile=None)[source]

Delete staged update.

CLI Example:

salt '*' vcf_vc_patch.delete_staged_update
saltext.vcf.modules.vcf_vc_patch.get_update_history(profile=None)[source]

Get update history.

CLI Example:

salt '*' vcf_vc_patch.get_update_history
saltext.vcf.modules.vcf_vc_patch.precheck(version=None, component=None, profile=None)[source]

Precheck.

CLI Example:

salt '*' vcf_vc_patch.precheck <version>
saltext.vcf.modules.vcf_vc_patch.stage(version=None, component=None, profile=None)[source]

Stage.

CLI Example:

salt '*' vcf_vc_patch.stage <version>
saltext.vcf.modules.vcf_vc_patch.install(version=None, sso_password=None, component=None, profile=None)[source]

Install.

CLI Example:

salt '*' vcf_vc_patch.install <version> <sso_password>
saltext.vcf.modules.vcf_vc_patch.resolve_update_version(repository_url=None, version=None, profile=None)[source]

Resolve update version.

CLI Example:

salt '*' vcf_vc_patch.resolve_update_version
saltext.vcf.modules.vcf_vc_patch.monitor_stage(poll_interval=50, timeout=3600, max_transient_errors=10, version=None, profile=None)[source]

Monitor stage.

CLI Example:

salt '*' vcf_vc_patch.monitor_stage
saltext.vcf.modules.vcf_vc_patch.monitor_install(poll_interval=120, timeout=7200, max_transient_errors=10, profile=None)[source]

Monitor install.

CLI Example:

salt '*' vcf_vc_patch.monitor_install
saltext.vcf.modules.vcf_vc_patch.wait_for_staged_update(version=None, poll_interval=10, timeout=600, profile=None)[source]

Wait for staged update.

CLI Example:

salt '*' vcf_vc_patch.wait_for_staged_update