Settings requests

Getting current settings for a specified settings manager

Gets the current settings for the specified settings manager. This request is often used to see the settings of a particular settings manager before updating.

Example: GET https://10.10.10.10/api/v3/settings/automationmanager

Response: A list of SettingApiDTOs representing the settings for the specified settings manager:

[
  {
    "uuid": "startVM",
    "displayName": "Start",
    "value": "RECOMMEND",
    "defaultValue": "RECOMMEND",
    "valueType": "STRING",
    "options": [
      {
        "label": "Disabled",
        "value": "DISABLED"
      },
      {
        "label": "Recommend",
        "value": "RECOMMEND"
      },
      {
        "label": "Manual",
        "value": "MANUAL"
      },
      {
        "label": "Automated",
        "value": "AUTOMATIC"
      }
    ],
    "entityType": "VirtualMachine",
    "sourceGroupName": "Global"
  },
  {
    "uuid": "startPM",
    "displayName": "Start",
    "value": "RECOMMEND",
    "defaultValue": "RECOMMEND",
    "valueType": "STRING",
    "options": [
      {
        "label": "Disabled",
        "value": "DISABLED"
      },
      {
        "label": "Recommend",
        "value": "RECOMMEND"
      },
      {
        "label": "Manual",
        "value": "MANUAL"
      },
      {
        "label": "Automated",
        "value": "AUTOMATIC"
      }
    ],
    "entityType": "PhysicalMachine",
    "sourceGroupName": "Global"
  },
  {
    "uuid": "startDS",
    "displayName": "Start",
    "value": "RECOMMEND",
    "defaultValue": "RECOMMEND",
    "valueType": "STRING",
    "options": [
      {
        "label": "Disabled",
        "value": "DISABLED"
      },
      {
        "label": "Recommend",
        "value": "RECOMMEND"
      },
      {
        "label": "Manual",
        "value": "MANUAL"
      },
      {
        "label": "Automated",
        "value": "AUTOMATIC"
      }
    ],
    "entityType": "Storage",
    "sourceGroupName": "Global"
  },
  ...
]
      

Editing settings

To edit a Setting, pass the new value in the body of this request. This request takes the following parameters:

• settingsManager_uuid

  The UUID of the settingsmanager whose setting will be changed.

• setting_uuid

  The setting whose value will be changed.

Example: PUT https://10.10.10.10/api/v3/settings/automationmanager/moveVM

Example Input: A SettingApiDTO. In this case, the value is being changed from MANUAL to RECOMMEND:

{
  "uuid": "moveVM",
  "displayName": "Move",
  "value": "RECOMMEND",
  "defaultValue": "MANUAL",
  "valueType": "STRING",
  "options": [
    {
      "label": "Disabled",
      "value": "DISABLED"
    },
    {
      "label": "Recommend",
      "value": "RECOMMEND"
    },
    {
      "label": "Manual",
      "value": "MANUAL"
    },
    {
      "label": "Automated",
      "value": "AUTOMATIC"
    }
  ],
  "entityType": "VirtualMachine",
  "sourceGroupName": "Global"
}
      

Response: The SettingApiDTO reflecting your changes:

{
  "uuid": "moveVM",
  "displayName": "Move",
  "value": "RECOMMEND",
  "defaultValue": "MANUAL",
  "valueType": "STRING",
  "options": [
    {
      "label": "Disabled",
      "value": "DISABLED"
    },
    {
      "label": "Recommend",
      "value": "RECOMMEND"
    },
    {
      "label": "Manual",
      "value": "MANUAL"
    },
    {
      "label": "Automated",
      "value": "AUTOMATIC"
    }
  ],
  "entityType": "VirtualMachine",
  "sourceGroupName": "Global"
}