Scan Desired State Settings V1 Config Task
Scans all the components in the desired state against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Request
URLURL
https://{api_host}/api/appliance/vcenter/settings/v1/config?action=scan-desired-state&vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VcenterSettingsV1ConfigScanSpec of mimetype application/json
Required
The Config.ScanSpec structure contains the specification required for compliance check against the vCenter current config state. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
(The request body parameter is missing description)
{
"desired_state": {}
}
desired_state
Required
Defines the desired state. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
string
message
Optional
Message for the scan. This may act as an identification for the scan operation. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. If unset, the message will be empty.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. Result of the scan operation.
Errors
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"desired_state":{"appliance":{"access_settings":{"console_cli":{"enabled":false},"dcui":{"enabled":false},"shell":{"enabled":false,"timeout":0},"ssh":{"enabled":false}},"backup_schedules":[{"backup_password":"string","enable":false,"location":"string","location_password":"string","location_user":"string","parts":["string"],"recurrence_info":{"days":"MONDAY","hour":0,"minute":0},"retention_info":{"max_count":0},"schedule_id":"string"}],"ceip":{"enabled":false},"datetime_config":{"ntp":{"servers":["string"]},"time_sync":{"mode":"DISABLED"},"time_zone":{"name":"string"}},"network":{"dns_server_configuration":{"domains":["string"],"mode":"DHCP","servers":["string"]},"firewall_rule_policies":[{"address":"string","interface_name":"string","policy":"IGNORE","prefix":0}],"interfaces":[{"ipv4":{"address":"string","configurable":false,"default_gateway":"string","mode":"DHCP","prefix":0},"ipv6":{"addresses":[{"address":"string","origin":"DHCP","prefix":0,"status":"TENTATIVE"}],"autoconf":false,"configurable":false,"default_gateway":"string","dhcp":false},"mac":"string","name":"string","status":"DOWN"}],"proxy_configuration":[{"enabled":false,"password":"string","port":0,"protocol":"HTTP","server":"string","username":"string"}]},"smtp":{"mail_server":"string","relay_port":"string"},"software_update_policy":{"auto_stage":false,"check_schedule":[{"day":"MONDAY","hour":"string","minute":"string"}],"default_URL":"string","enable_SSL_cert_validation":false,"password":"string","url":"string","username":"string"},"syslog":[{"hostname":"string","port":0,"protocol":"TLS"}],"user_account_settings":{"local_accounts_policy":{"max_days":0,"min_days":0,"warn_days":0},"root_account_policy":{"email":"string","enabled":false,"fullname":"string","has_password":false,"max_days_between_password_change":0,"min_days_between_password_change":0,"password":"string","roles":["string"],"warn_days_before_password_expiration":0}}},"authmgmt":{"global_permissions":[{"principal":{"group":false,"name":"string"},"propagate":false,"role_names":["string"]}],"lockout_policy":{"failed_login_attempts":0,"failure_interval":0,"unlock_time":0},"password_policy":{"adj_identical_chars":0,"alpha_chars":0,"lowercase_chars":0,"max_length":0,"max_life":0,"min_length":0,"numeric_chars":0,"password_reuse":0,"special_chars":0,"uppercase_chars":0},"privileges":[{"description":"string","group":"string","id":"string","is_on_parent":false}],"roles":[{"description":"string","name":"string","privilege_ids":["string"]}],"token_policy":{"bearer_refresh":0,"clock_tolerance":0,"hok_refresh":0,"token_delegation":0,"token_renewal":0}},"inventory":{"clusters":[{"drs":{"additional_options":{"advanced_options":[{"key":"string","value":"string"}],"scalable_shares":"DISABLED"},"automation":{"automation_level":"MANUAL","migration_threshold":0,"proactive_drs_enabled":false,"virtual_machine_automation":false},"enabled":false,"power_management":{"automation_level":"MANUAL","dpm_enabled":false,"dpm_threshold":{"key":"string","value":"string"}}},"drs_vm_overrides":[{"behavior":"MANUAL","name":"string"}],"groups":{"host_groups":[{"entities":["string"],"name":"string","user_created":false}],"vm_groups":[{"entities":["string"],"name":"string","user_created":false}]},"ha":{"admission_control":{"cluster_resource_percentage":{"cpu":0,"memory":0},"dedicated_failover_hosts":["string"],"host_fail_over_slot_policy":{"cpu":0,"memory":0},"host_failures_cluster_tolerates":0,"performance_degradation_vm_tolerate":0,"policy_type":"string"},"advanced_options":[{"key":"string","value":"string"}],"enabled":false,"failures_and_responses":{"additional_delay":0,"apd_failure_response":"DISABLED","datastore_with_pdl_failure_response":"DISABLED","default_vm_restart_priority":"DISABLED","host_isolation_response":"NONE","host_monitoring":"DISABLED","response_delay":0,"response_recovery":"NONE","restart_priority_condition_timeout":0,"vm_monitoring":"VM_MONITORING_DISABLED","vm_tools_monitoring_settings":{"cluster_settings":false,"enabled":false,"failure_interval":0,"max_failure_window":0,"max_failures":0,"min_up_time":0}},"heartbeat_datastores":{"datastores":["string"],"heartbeat_datastore_policy":"USER_SELECTED_DS"}},"ha_vm_overrides":[{"name":"string","vm_additional_delay":0,"vm_apd_failover_delay":0,"vm_apd_failure_response":"DISABLED","vm_apd_response_recovery":"NONE","vm_datastore_with_pdl_failure_response":"DISABLED","vm_isolation_response":"NONE","vm_monitoring":"VM_MONITORING_DISABLED","vm_restart_priority":"DISABLED","vm_restart_priority_timeout":0}],"hosts":["string"],"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}],"proactive_ha":{"automation_level":"MANUAL","enabled":false,"providers":["string"],"remediation":"QUARANTINE_MODE"},"resource_pools":[{"child_resource_pools":["string"],"config":{"cpu_allocation":{"expandable_reservation":false,"limit":0,"reservation":0,"shares":{"level":"LOW","shares":0}},"memory_allocation":{"expandable_reservation":false,"limit":0,"reservation":0,"shares":{"level":"LOW","shares":0}}},"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}],"vm":["string"]}],"rules":{"dependency_rule":[{"depends_on_vm_group":"string","enabled":false,"in_compliance":false,"mandatory":false,"name":"string","status":"GRAY","user_created":false,"vm_group":"string"}],"vm_affinity_rules":[{"enabled":false,"in_compliance":false,"mandatory":false,"name":"string","status":"GRAY","user_created":false,"vms":["string"]}],"vm_anti_affinity_rules":[{"enabled":false,"in_compliance":false,"mandatory":false,"name":"string","status":"GRAY","user_created":false,"vms":["string"]}],"vm_host_rule":[{"affine_host_group_name":"string","anti_affine_host_group_name":"string","enabled":false,"in_compliance":false,"mandatory":false,"name":"string","status":"GRAY","user_created":false,"vm_group_name":"string"}]}}],"datacenters":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}],"standalone_hosts":["string"]}],"datastores":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}],"summary":{"capacity":0,"maintenance_mode":"NORMAL","multiple_host_access":false,"type":"string"}}],"folders":{"datacenter":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}]}],"datastore":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}]}],"host":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}]}],"network":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}]}],"vm":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}]}]},"hosts":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}]}],"networks":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}]}],"storage_pods":[{"name":"string","parent_path":"string","permissions":[{"group":false,"principal":"string","propagate":false,"role_id":0}],"pod_storage_drs_entry":{"storage_drs_config":{"pod_config":{"enabled":false}}}}]},"invtauthmgmt":{"service_provider_entities":{"entities":["string"],"permissions":[{"entity":"string","principal":{"group":false,"name":"string"},"propagate":false,"role_name":"string"}]},"version":"string"},"managementcluster":{"drs":{"automation_level":"MANUAL","enabled":false,"migration_threshold":0,"virtual_machine_automation":false},"management_resourcepools":[{"config":{"cpu_allocation":{"expandable_reservation":false,"limit":0,"reservation":0,"shares":{"level":"LOW","shares":0}},"memory_allocation":{"expandable_reservation":false,"limit":0,"reservation":0,"shares":{"level":"LOW","shares":0}}},"name":"string","parent_path":"string","vm":[{"name":"string","parent_path":"string","resource_config":{"cpu_allocation":{"expandable_reservation":false,"limit":0,"reservation":0,"shares":{"level":"LOW","shares":0}},"memory_allocation":{"expandable_reservation":false,"limit":0,"reservation":0,"shares":{"level":"LOW","shares":0}}},"vm_type":"VCENTER"}]}],"name":"string","parent_path":"string"},"vsphereuiconfiguration":{"enable_IDP_configuration":false,"enable_ad_iwa_ids":false,"enable_ceip":false,"enable_cloud_admin_role_protection":false,"enable_csp_oidc_federation":false,"enable_deprecated_vc_alert":false,"enable_file_browser_download_upload_from_vc":false,"enable_hybrid_management":false,"enable_intercom_chat":false,"help_url_pointing_to_aws":false}},"message":"string"}' https://{api_host}/api/appliance/vcenter/settings/v1/config?action=scan-desired-state&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: scan_desired_state_task
