Submit Policy Task

Submit a password policy task

Rejected with 409 if another task on the component group is in progress.

Request

URI

POST

https://{api_host}/suite-api/api/fleet-management/password-policies/component-groups/tasks

COPY

Request Body

Task type and optional policy id / target

BasePasswordPolicyTask of type(s) application/json

Required

Show optional properties

{
    "taskType": "string"
}

"{\n  \"taskType\" : \"POLICY_APPLY\",\n  \"policyId\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n  \"targetComponentGroups\" : {\n    \"componentGroupResourceIds\" : [ \"055b39eb-70cf-4bc2-bfc2-e9779c32d88a\" ],\n    \"componentGroups\" : [ \"INSTANCE\" ]\n  },\n  \"overrideComponentGroups\" : {\n    \"componentGroupResourceIds\" : [ ],\n    \"componentGroups\" : [ \"FLEET\" ]\n  }\n}"

object

overrideComponentGroups

Optional

Target component group for a policy operation (apply, detach, remediate, retry, compliance run). Use JSON componentGroups (plural) as an array of FLEET, MANAGEMENT, INSTANCE. INSTANCE scope must supply componentGroupResourceIds; FQDNs are not accepted on this object. policyId on the enclosing policy task is required for all task types except COMPLIANCE_RUN. For detach, remediate, and retry the server resolves scope from assignment/compliance data together with that policy id.

string As uuid As uuid

policyId

Optional

Password policy ID. Required for POLICY_APPLY, POLICY_DETACH, POLICY_REMEDIATE, and POLICY_RETRY. Ignored for COMPLIANCE_RUN.

object

targetComponentGroups

Optional

string As uuid As uuid

taskId

Optional

Task ID (set when a task is persisted; omitted on request)

string

taskType

Required

Policy operations task type

Enumeration: POLICY_APPLY, POLICY_DETACH, POLICY_RETRY, POLICY_REMEDIATE, COMPLIANCE_RUN, UNKNOWN

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

202

Policy task submitted

Returns PasswordPolicyTask of type(s) application/json

This response body class contains all of the following: PasswordPolicyTaskSummary , InlinePasswordPolicyTask1

"{\n  \"taskId\" : \"077c4afc-81df-5cd3-ccd3-f0880d43999b\",\n  \"taskType\" : \"POLICY_APPLY\",\n  \"policyId\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n  \"targetComponentGroups\" : {\n    \"componentGroupResourceIds\" : [ \"055b39eb-70cf-4bc2-bfc2-e9779c32d88a\" ],\n    \"componentGroups\" : [ \"INSTANCE\" ]\n  },\n  \"taskStatus\" : \"IN_PROGRESS\",\n  \"createdAt\" : 1741630060000,\n  \"updatedAt\" : 1741716460000,\n  \"policyName\" : \"VCF Policy1\",\n  \"targetComponentGroupsState\" : [ {\n    \"componentGroupResourceId\" : \"055b39eb-70cf-4bc2-bfc2-e9779c32d88a\",\n    \"componentGroupResourceFqdn\" : \"sddc-manager.example.com\",\n    \"componentGroupResourceName\" : \"SDDC Manager\",\n    \"componentGroup\" : \"INSTANCE\",\n    \"complianceUpdatedAt\" : 1741716460000,\n    \"componentGroupComplianceStatus\" : \"IN_PROGRESS\",\n    \"policyId\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n    \"policyName\" : \"VCF Policy1\"\n  }, {\n    \"componentGroupResourceId\" : \"066c49fc-81df-4bd2-cdc3-f0880d43990a\",\n    \"componentGroupResourceFqdn\" : \"vcenter.example.com\",\n    \"componentGroupResourceName\" : \"vCenter Server\",\n    \"componentGroup\" : \"INSTANCE\",\n    \"complianceUpdatedAt\" : 1741700000000,\n    \"componentGroupComplianceStatus\" : \"COMPLIANT\",\n    \"policyId\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n    \"policyName\" : \"VCF Policy1\"\n  } ],\n  \"componentGroupsComplianceStatistics\" : [ {\n    \"status\" : \"IN_PROGRESS\",\n    \"count\" : 1\n  }, {\n    \"status\" : \"COMPLIANT\",\n    \"count\" : 1\n  } ]\n}"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"taskType":"string"}' https://{api_host}/suite-api/api/fleet-management/password-policies/component-groups/tasks

On This Page

Description

Request

Request Body

Authentication

Response

202 Response Body

Fleet Password Policy Management Operations

POST

Create Password Policy

PUT

Update Password Policy