vcf_esxi_vlcm

Execution module for vCenter’s ESX Lifecycle Manager (vLCM) REST API.

Patches ESXi hosts in a vSphere cluster: configure/sync depots, define a desired image, set the cluster’s apply policy, then scan/precheck/stage/ remediate against it. See saltext.vcf.clients.esxi_vlcm for the underlying REST calls, and saltext.vcf.states.vcf_esxi_vlcm for the declarative/idempotent workflow.

Quick reference:

# Depots
salt-call vcf_esxi_vlcm.online_depot_list
salt-call vcf_esxi_vlcm.offline_depot_create '{"location": "http://repo/depot.zip"}'
salt-call vcf_esxi_vlcm.depot_sync

# Desired image
salt-call vcf_esxi_vlcm.desired_image_get domain-c9
salt-call vcf_esxi_vlcm.draft_import_software_spec domain-c9 '{"base_image": {"version": "9"}}'
salt-call vcf_esxi_vlcm.draft_commit domain-c9 draft-1

# Lifecycle
salt-call vcf_esxi_vlcm.compliance_scan domain-c9
salt-call vcf_esxi_vlcm.remediate domain-c9
saltext.vcf.modules.vcf_esxi_vlcm.online_depot_list(profile=None)[source]

Online depot list.

CLI Example:

salt '*' vcf_esxi_vlcm.online_depot_list
saltext.vcf.modules.vcf_esxi_vlcm.online_depot_create(body, profile=None)[source]

Online depot create.

CLI Example:

salt '*' vcf_esxi_vlcm.online_depot_create <body>
saltext.vcf.modules.vcf_esxi_vlcm.online_depot_update(depot_id, body, profile=None)[source]

Online depot update.

CLI Example:

salt '*' vcf_esxi_vlcm.online_depot_update <depot_id> <body>
saltext.vcf.modules.vcf_esxi_vlcm.offline_depot_list(profile=None)[source]

Offline depot list.

CLI Example:

salt '*' vcf_esxi_vlcm.offline_depot_list
saltext.vcf.modules.vcf_esxi_vlcm.offline_depot_get(depot_id, profile=None)[source]

Offline depot get.

CLI Example:

salt '*' vcf_esxi_vlcm.offline_depot_get <depot_id>
saltext.vcf.modules.vcf_esxi_vlcm.offline_depot_create(body, profile=None)[source]

Offline depot create (task).

CLI Example:

salt '*' vcf_esxi_vlcm.offline_depot_create <body>
saltext.vcf.modules.vcf_esxi_vlcm.offline_depot_delete(depot_id, profile=None)[source]

Offline depot delete (task).

CLI Example:

salt '*' vcf_esxi_vlcm.offline_depot_delete <depot_id>
saltext.vcf.modules.vcf_esxi_vlcm.depot_sync(profile=None)[source]

Depot sync (task).

CLI Example:

salt '*' vcf_esxi_vlcm.depot_sync
saltext.vcf.modules.vcf_esxi_vlcm.desired_image_get(cluster, profile=None)[source]

Desired image get.

CLI Example:

salt '*' vcf_esxi_vlcm.desired_image_get <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.base_image_get(cluster, profile=None)[source]

Base image get.

CLI Example:

salt '*' vcf_esxi_vlcm.base_image_get <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.drafts_list(cluster, profile=None)[source]

Drafts list.

CLI Example:

salt '*' vcf_esxi_vlcm.drafts_list <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.draft_get(cluster, draft_id, profile=None)[source]

Draft get.

CLI Example:

salt '*' vcf_esxi_vlcm.draft_get <cluster> <draft_id>
saltext.vcf.modules.vcf_esxi_vlcm.draft_delete(cluster, draft_id, profile=None)[source]

Draft delete.

CLI Example:

salt '*' vcf_esxi_vlcm.draft_delete <cluster> <draft_id>
saltext.vcf.modules.vcf_esxi_vlcm.draft_import_software_spec(cluster, image_spec, profile=None)[source]

Draft import software spec (task).

CLI Example:

salt '*' vcf_esxi_vlcm.draft_import_software_spec <cluster> <image_spec>
saltext.vcf.modules.vcf_esxi_vlcm.draft_validate(cluster, draft_id, profile=None)[source]

Draft validate (task).

CLI Example:

salt '*' vcf_esxi_vlcm.draft_validate <cluster> <draft_id>
saltext.vcf.modules.vcf_esxi_vlcm.draft_commit(cluster, draft_id, message=None, profile=None)[source]

Draft commit (task).

CLI Example:

salt '*' vcf_esxi_vlcm.draft_commit <cluster> <draft_id>
saltext.vcf.modules.vcf_esxi_vlcm.apply_policy_get(cluster, profile=None)[source]

Apply policy get.

CLI Example:

salt '*' vcf_esxi_vlcm.apply_policy_get <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.apply_policy_set(cluster, policy_spec, profile=None)[source]

Apply policy set.

CLI Example:

salt '*' vcf_esxi_vlcm.apply_policy_set <cluster> <policy_spec>
saltext.vcf.modules.vcf_esxi_vlcm.compliance_scan(cluster, commit='1', hosts=None, profile=None)[source]

Compliance scan (task).

CLI Example:

salt '*' vcf_esxi_vlcm.compliance_scan <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.precheck(cluster, commit='1', profile=None)[source]

Precheck (task).

CLI Example:

salt '*' vcf_esxi_vlcm.precheck <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.stage(cluster, commit='1', hosts=None, profile=None)[source]

Stage (task).

CLI Example:

salt '*' vcf_esxi_vlcm.stage <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.remediate(cluster, accept_eula=True, profile=None)[source]

Remediate (task).

CLI Example:

salt '*' vcf_esxi_vlcm.remediate <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.last_check_result(cluster, profile=None)[source]

Last check result.

CLI Example:

salt '*' vcf_esxi_vlcm.last_check_result <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.apply_impact_report(cluster, profile=None)[source]

Apply impact report.

CLI Example:

salt '*' vcf_esxi_vlcm.apply_impact_report <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.last_apply_result(cluster, profile=None)[source]

Last apply result.

CLI Example:

salt '*' vcf_esxi_vlcm.last_apply_result <cluster>
saltext.vcf.modules.vcf_esxi_vlcm.wait_for_task(resp, timeout=1800, poll_interval=10, profile=None)[source]

Wait for task.

CLI Example:

salt '*' vcf_esxi_vlcm.wait_for_task <resp>