vSmart Policy
API calls for configuring vSmart controller policies:
Activate vSmart Policy
Activate a vSmart controller policy by policy ID.
URL: https://vmanage-ip-address/dataservice/template/policy/vsmart/activate/policyId
Method: POST
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceTemplateJSON | Yes | Parameters for policy activation action | Body | String |
| policyId | Yes | Policy identifier | Path | String |
Request Content Type: application/json
Request Body Schema
| Value | Description |
|---|---|
| isEdited | The value true indicates that the policy has been edited. The value false indicates that the policy has not been edited. |
Example Request and Response
Activating a vSmart controller policy is a two-step process:
- Issue the POST call to activate the vSmart policy:
{
"isEdited":false
} The response contains the process ID for the policy:
"{"id":"vsmart_policy_config-01242017T020647984"}" - Issue a monitor device action status call with the process ID to display the status of policy activation:
https://vmanage-ip-address/dataservice/device/action/status/vsmart_policy_config-01242017T020647984
The second response object retrieves the detailed action status.
Deactivate vSmart Policy
Deactivate a vSmart controller policy by policy ID.
URL: https://vmanage-ip-address/dataservice/template/policy/vsmart/activate/policyId
Method: POST
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| policyId | Yes | Policy identifier | Path | String |
Request Content Type: application/json
Request Body Schema: The body for this POST request is empty.
Example Request and Response
Deactivating a vSmart controller policy is a two-step process:
- Issue the POST call with an empty body to deactivate the vSmart policy:
{
} The response contains the process ID for the policy:
{"id":"vsmart_policy_config-01242017T020647984"} - Issue a monitor device action status call with the process ID to display the status of policy deactivation:
https://vmanage-ip-address/dataservice/device/action/status/vsmart_policy_config-01242017T020647984
The second response object retrieves the detailed action status.