Settings Clusters Enablement Configuration Transition APIs
The Transition service provides operations to manage transition of an existing cluster to a desired configuration managed cluster.
Operations
get
Get Clusters Enablement Configuration Transition
This API returns the current transition state of the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.
This API returns the current transition state of the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.
post
Cancel Clusters Enablement Configuration Transition
This API cancels the workflow to transition the cluster to desired configuration platform. If the status of transition is STARTED, the associated state information will be deleted. Otherwise, cancel will not be allowed and the API will throw an error. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
This API cancels the workflow to transition the cluster to desired configuration platform. If the status of transition is STARTED, the associated state information will be deleted. Otherwise, cancel will not be allowed and the API will throw an error. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
post
Check Eligibility Clusters Enablement Configuration Transition Task
The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform.
The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform.
post
Enable Clusters Enablement Configuration Transition Task
The API enables ConfigManager on the cluster. Before setting the desired configuration state, the API verifies the eligibility of the cluster to transition to desired configuration platform. The API then validates and sets the configuration draft as the desired configuration of the cluster, thus enabling ConfigManager. The API finally initiates remediation by invoking Apply. Apply is not invoked if the cluster is empty. The API does not wait for remediation to complete before returning. If any of the above step fails, the API will fail and result will contain descriptive error messages.
The API enables ConfigManager on the cluster. Before setting the desired configuration state, the API verifies the eligibility of the cluster to transition to desired configuration platform. The API then validates and sets the configuration draft as the desired configuration of the cluster, thus enabling ConfigManager. The API finally initiates remediation by invoking Apply. Apply is not invoked if the cluster is empty. The API does not wait for remediation to complete before returning. If any of the above step fails, the API will fail and result will contain descriptive error messages.
post
Export Config Clusters Enablement Configuration Transition
This API will export configuration associated with the cluster generated as part of the transition workflow. The API will throw an error if the transition state is not STARTED. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
This API will export configuration associated with the cluster generated as part of the transition workflow. The API will throw an error if the transition state is not STARTED. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
post
Export Schema Clusters Enablement Configuration Transition
This API will export schema associated with the cluster. The API will throw an error if the transition state is not STARTED. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
This API will export schema associated with the cluster. The API will throw an error if the transition state is not STARTED. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
post
Import From File Clusters Enablement Configuration Transition
The API imports the desired configuration from a file. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
The API imports the desired configuration from a file. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
post
Import From Host Clusters Enablement Configuration Transition Task
The API imports the desired configuration from a reference host in the cluster. The API also adds host-specific and host-overrides from the other hosts in the cluster. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed.
The API imports the desired configuration from a reference host in the cluster. The API also adds host-specific and host-overrides from the other hosts in the cluster. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed.
post
Precheck Clusters Enablement Configuration Transition Task
The API computes impact of transitioning the cluster to be managed by desired configuration platform. It also runs health checks to verify the cluster's health before transitioning. The API returns the impact on the hosts in the cluster and the result of health checks from the cluster and hosts. Health checks are run only if the host needs be rebooted or put in maintenanceMode.
The API computes impact of transitioning the cluster to be managed by desired configuration platform. It also runs health checks to verify the cluster's health before transitioning. The API returns the impact on the hosts in the cluster and the result of health checks from the cluster and hosts. Health checks are run only if the host needs be rebooted or put in maintenanceMode.
post
Validate Config Clusters Enablement Configuration Transition Task
The API validates the imported desired configuration against the schema and on the hosts with validation plugins. If the document is valid, the API will check all the hosts for compliance with the desired configuration. The API returns validation errors if the configuration is not valid on any of the host. If the configuration is valid, the API returns compliance information.
The API validates the imported desired configuration against the schema and on the hosts with validation plugins. If the document is valid, the API will check all the hosts for compliance with the desired configuration. The API returns validation errors if the configuration is not valid on any of the host. If the configuration is valid, the API returns compliance information.
