Scenario configuration examples

Basic scenario POSTs and responses

Most scenarios consist of multiple configuration changes. However, the UI provides several starting points for custom configuration based on plan type.

Turbonomic provides the same starting point in the API via the /scenarios endpoint and the following list of POST calls and server responses:

The following examples are simplified in order to accomplish a single goal. There are many other options you might choose in conjunction with those in the following examples.

Add Workload

POST:

{
  "configChanges": {
    "addPolicyList": [],
    "automationSettingList": [],
    "removeConstraintList": [],
    "removePolicyList": [],
    "riSettingList": [],
    "osMigrationSettingList": [],
    "subscription": {}
  },
  "displayName": "Add Workload- Basic",
  "loadChanges": {
    "utilizationList": [],
    "maxUtilizationList": []
  },
  "projectionDays": [
    0
  ],
  "scope": [
    {
      "uuid": "Market",
      "displayName": "Global Environment",
      "className": "Market"
    }
  ],
  "topologyChanges": {
    "addList": [
      {
        "count": 50,
        "projectionDays": [
          0
        ],
        "target": {
          "uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65",
          "displayName": "AJ_Test",
          "className": "VirtualMachine"
        }
      }
    ],
    "migrateList": [],
    "removeList": [],
    "replaceList": [],
    "relievePressureList": []
  },
  "type": "ADD_WORKLOAD"
}
      

Response:

{
  "uuid": "2502057162928",
  "displayName": "Add Workload- Basic",
  "owners": [
    {
      "uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
      "username": "administrator",
      "showSharedUserSC": false
    }
  ],
  "type": "ADD_WORKLOAD",
  "scope": [
    {
      "uuid": "_0x3OYUglEd-gHc4L513yOA",
      "displayName": "Market",
      "className": "Market"
    }
  ],
  "projectionDays": [
    0
  ],
  "topologyChanges": {
    "addList": [
      {
        "projectionDays": [
          0
        ],
        "target": {
          "uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65",
          "displayName": "AJ_Test",
          "className": "VirtualMachine"
        },
        "count": 50
      }
    ]
  },
  "loadChanges": {},
  "configChanges": {},
  "changes": [
    {
      "index": 1,
      "type": "SCOPE",
      "scope": [
        {
          "uuid": "_0x3OYUglEd-gHc4L513yOA",
          "displayName": "Market",
          "className": "Market"
        }
      ]
    },
    {
      "index": 2,
      "type": "PROJECTION_PERIODS",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 3,
      "type": "ADDED",
      "description": "50 AJ_Test",
      "targets": [
        {
          "uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65",
          "displayName": "AJ_Test",
          "className": "VirtualMachine",
          "severity": "Major"
        }
      ],
      "value": "50",
      "projectionDays": [
        0
      ]
    }
  ],
  "timebasedTopologyChanges": {}
}
      

Decommission Hosts

POST:

{
  "configChanges": {
    "addPolicyList": [],
    "automationSettingList": [
      {
        "uuid": "provisionPM",
        "displayName": "PROVISION for PHYSICALMACHINES disabled",
        "value": "false",
        "entityType": "PhysicalMachine"
      }
    ],
    "removeConstraintList": [],
    "removePolicyList": [],
    "riSettingList": [],
    "osMigrationSettingList": [],
    "subscription": {}
  },
  "displayName": "Decommission Hosts- Basic",
  "loadChanges": {
    "utilizationList": [],
    "maxUtilizationList": []
  },
  "projectionDays": [
    0
  ],
  "scope": [
    {
      "uuid": "Market",
      "displayName": "Global Environment",
      "className": "Market"
    }
  ],
  "topologyChanges": {
    "addList": [],
    "migrateList": [],
    "removeList": [
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
          "displayName": "dell-pe1944.corp.vmturbo.com",
          "className": "PhysicalMachine"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
          "displayName": "dell-pe1953.corp.vmturbo.com",
          "className": "PhysicalMachine"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
          "displayName": "dell-pe1954.corp.vmturbo.com",
          "className": "PhysicalMachine"
        }
      }
    ],
    "replaceList": [],
    "relievePressureList": []
  },
  "type": "DECOMMISSION_HOST"
}
      

Response:

{
  "uuid": "2502061312640",
  "displayName": "Decommission Hosts- Basic",
  "owners": [
    {
      "uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
      "username": "administrator",
      "showSharedUserSC": false
    }
  ],
  "type": "DECOMMISSION_HOST",
  "scope": [
    {
      "uuid": "_0x3OYUglEd-gHc4L513yOA",
      "displayName": "Market",
      "className": "Market"
    }
  ],
  "projectionDays": [
    0
  ],
  "topologyChanges": {
    "removeList": [
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
          "displayName": "dell-pe1944.corp.vmturbo.com",
          "className": "PhysicalMachine"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
          "displayName": "dell-pe1953.corp.vmturbo.com",
          "className": "PhysicalMachine"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
          "displayName": "dell-pe1954.corp.vmturbo.com",
          "className": "PhysicalMachine"
        }
      }
    ]
  },
  "loadChanges": {},
  "configChanges": {
    "automationSettingList": [
      {
        "uuid": "provisionPM",
        "displayName": "Provision",
        "value": "false",
        "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"
      }
    ]
  },
  "changes": [
    {
      "index": 1,
      "type": "SCOPE",
      "scope": [
        {
          "uuid": "_0x3OYUglEd-gHc4L513yOA",
          "displayName": "Market",
          "className": "Market"
        }
      ]
    },
    {
      "index": 2,
      "type": "PROJECTION_PERIODS",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 3,
      "type": "REMOVED",
      "description": "dell-pe1944.corp.vmturbo.com",
      "targets": [
        {
          "uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
          "displayName": "dell-pe1944.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        }
      ],
      "value": "1",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 4,
      "type": "REMOVED",
      "description": "dell-pe1953.corp.vmturbo.com",
      "targets": [
        {
          "uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
          "displayName": "dell-pe1953.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        }
      ],
      "value": "1",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 5,
      "type": "REMOVED",
      "description": "dell-pe1954.corp.vmturbo.com",
      "targets": [
        {
          "uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
          "displayName": "dell-pe1954.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        }
      ],
      "value": "1",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 6,
      "type": "SET_ACTION_SETTING",
      "description": "Provision for PhysicalMachine disabled",
      "targets": [
        {
          "uuid": "PhysicalMachine"
        }
      ],
      "value": "PhysicalMachine",
      "enable": false,
      "name": "provision",
      "projectionDays": [
        0
      ]
    }
  ],
  "timebasedTopologyChanges": {}
}
      

Migrate to Cloud

POST:

{
  "configChanges": {
    "addPolicyList": [],
    "automationSettingList": [],
    "removeConstraintList": [],
    "removePolicyList": [],
    "riSettingList": [],
    "osMigrationSettingList": [],
    "subscription": {}
  },
  "displayName": "Migrate to Public Cloud- Basic",
  "loadChanges": {
    "utilizationList": [],
    "maxUtilizationList": []
  },
  "projectionDays": [
    0
  ],
  "scope": [
    {
      "uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926",
      "displayName": "ACM_vm",
      "groupType": "VirtualMachine",
      "className": "Group"
    },
    {
      "uuid": "_lRrTYB--EeewItqBJctLGw",
      "displayName": "All Cloud Zones",
      "groupType": "PhysicalMachine",
      "className": "Group"
    }
  ],
  "topologyChanges": {
    "addList": [],
    "migrateList": [
      {
        "projectionDay": 0,
        "source": {
          "uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926",
          "displayName": "ACM_vm",
          "className": "VirtualMachine"
        },
        "destination": {
          "uuid": "_lRrTYB--EeewItqBJctLGw",
          "displayName": "All Cloud Zones",
          "className": "PhysicalMachine"
        }
      }
    ],
    "removeList": [
      {
        "projectionDay": 0,
        "target": {
          "uuid": "_nuoxwETSEemi-4wSMHOOWA",
          "displayName": "All VMs In All Cloud Zones",
          "className": "VirtualMachine"
        }
      }
    ],
    "replaceList": [],
    "relievePressureList": []
  },
  "type": "CLOUD_MIGRATION"
}
      

Response:

{
  "uuid": "2502081867536",
  "displayName": "Migrate to Public Cloud- Basic",
  "owners": [
    {
      "uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
      "username": "administrator",
      "showSharedUserSC": false
    }
  ],
  "type": "CLOUD_MIGRATION",
  "scope": [
    {
      "uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926",
      "displayName": "ACM_vm",
      "className": "Group",
      "groupType": "VirtualMachine",
      "isStatic": true,
      "logicalOperator": "AND"
    },
    {
      "uuid": "_lRrTYB--EeewItqBJctLGw",
      "displayName": "All Cloud Zones",
      "className": "Group",
      "groupType": "PhysicalMachine",
      "isStatic": true,
      "logicalOperator": "AND"
    }
  ],
  "projectionDays": [
    0
  ],
  "topologyChanges": {
    "removeList": [
      {
        "projectionDay": 0,
        "target": {
          "uuid": "_nuoxwETSEemi-4wSMHOOWA",
          "displayName": "All VMs In All Cloud Zones",
          "className": "Group"
        }
      }
    ],
    "migrateList": [
      {
        "projectionDay": 0,
        "source": {
          "uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926",
          "displayName": "ACM_vm",
          "className": "Group"
        },
        "destination": {
          "uuid": "_lRrTYB--EeewItqBJctLGw",
          "displayName": "All Cloud Zones",
          "className": "Group"
        }
      }
    ]
  },
  "loadChanges": {},
  "configChanges": {
    "osMigrationSettingList": [
      {
        "uuid": "matchToSource",
        "value": "true"
      }
    ]
  },
  "changes": [
    {
      "index": 1,
      "type": "SCOPE",
      "scope": [
        {
          "uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926",
          "displayName": "ACM_vm",
          "className": "Group",
          "entitiesCount": 83,
          "groupType": "VirtualMachine",
          "severity": "Major",
          "logicalOperator": "AND"
        },
        {
          "uuid": "_lRrTYB--EeewItqBJctLGw",
          "displayName": "All Cloud Zones",
          "className": "Group",
          "entitiesCount": 78,
          "groupType": "PhysicalMachine",
          "severity": "Normal",
          "logicalOperator": "AND"
        }
      ]
    },
    {
      "index": 2,
      "type": "PROJECTION_PERIODS",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 3,
      "type": "REMOVED",
      "description": "All VMs In All Cloud Zones",
      "targets": [
        {
          "uuid": "_nuoxwETSEemi-4wSMHOOWA",
          "displayName": "All VMs In All Cloud Zones",
          "className": "Group",
          "entitiesCount": 154,
          "groupType": "VirtualMachine",
          "severity": "Major",
          "logicalOperator": "AND"
        }
      ],
      "value": "1",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 4,
      "type": "MIGRATION",
      "description": "Migrate [ACM_vm] to All Cloud Zones",
      "targets": [
        {
          "uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926",
          "displayName": "ACM_vm",
          "className": "Group",
          "entitiesCount": 83,
          "groupType": "VirtualMachine",
          "severity": "Major",
          "logicalOperator": "AND"
        },
        {
          "uuid": "_lRrTYB--EeewItqBJctLGw",
          "displayName": "All Cloud Zones",
          "className": "Group",
          "entitiesCount": 78,
          "groupType": "PhysicalMachine",
          "severity": "Normal",
          "logicalOperator": "AND"
        }
      ],
      "projectionDays": [
        0
      ]
    },
    {
      "index": 5,
      "type": "SET_TARGET_OS",
      "targets": [
        {
          "uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926",
          "displayName": "ACM_vm",
          "className": "Group",
          "entitiesCount": 83,
          "groupType": "VirtualMachine",
          "severity": "Major",
          "logicalOperator": "AND"
        }
      ],
      "projectionDays": [
        0
      ]
    }
  ],
  "timebasedTopologyChanges": {}
}
      

Optimize Cloud

POST:

{
  "configChanges": {
    "addPolicyList": [],
    "automationSettingList": [
      {
        "uuid": "resize",
        "displayName": "resize for VMS enabled",
        "value": "true",
        "entityType": "VirtualMachine"
      }
    ],
    "removeConstraintList": [],
    "removePolicyList": [],
    "riSettingList": [
      {
        "uuid": "preferredOfferingClass",
        "displayName": "Type",
        "value": "STANDARD",
        "entityType": "STANDARD"
      },
      {
        "uuid": "preferredTerm",
        "displayName": "Term",
        "value": "YEARS_3",
        "entityType": "YEARS_3"
      },
      {
        "uuid": "preferredPaymentOption",
        "displayName": "Payment",
        "value": "ALL_UPFRONT",
        "entityType": "ALL_UPFRONT"
      },
      {
        "uuid": "preferredCoverage",
        "displayName": "Coverage",
        "value": "80",
        "entityType": "80"
      },
      {
        "uuid": "riCoverageOverride",
        "displayName": "RI Coverage Override",
        "value": "false",
        "entityType": "false"
      }
    ],
    "osMigrationSettingList": [],
    "subscription": {}
  },
  "displayName": "Optimize Cloud- Basic",
  "loadChanges": {
    "utilizationList": [],
    "maxUtilizationList": []
  },
  "projectionDays": [
    0
  ],
  "scope": [
    {
      "uuid": "GROUP-PMsByTargetType_AWS",
      "displayName": "PMs_AWS",
      "groupType": "PhysicalMachine",
      "className": "Group"
    }
  ],
  "topologyChanges": {
    "addList": [],
    "migrateList": [],
    "removeList": [],
    "replaceList": [],
    "relievePressureList": []
  },
  "type": "OPTIMIZE_CLOUD"
}
      

Response:

{
  "uuid": "2502117573632",
  "displayName": "Optimize Cloud- Basic",
  "owners": [
    {
      "uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
      "username": "administrator",
      "showSharedUserSC": false
    }
  ],
  "type": "OPTIMIZE_CLOUD",
  "scope": [
    {
      "uuid": "be95c99fc2a2195ac896204766a52d0e141818a6",
      "displayName": "PMs_AWS",
      "className": "Group",
      "groupType": "PhysicalMachine",
      "isStatic": true,
      "logicalOperator": "AND"
    }
  ],
  "projectionDays": [
    0
  ],
  "topologyChanges": {},
  "loadChanges": {},
  "configChanges": {
    "automationSettingList": [
      {
        "uuid": "resize",
        "displayName": "resize",
        "value": "true"
      }
    ],
    "riSettingList": [
      {
        "uuid": "preferredPaymentOption",
        "displayName": "Payment",
        "value": "ALL_UPFRONT",
        "defaultValue": "ALL_UPFRONT",
        "valueType": "STRING",
        "options": [
          {
            "label": "ALL_UPFRONT",
            "value": "ALL_UPFRONT"
          },
          {
            "label": "PARTIAL_UPFRONT",
            "value": "PARTIAL_UPFRONT"
          },
          {
            "label": "NO_UPFRONT",
            "value": "NO_UPFRONT"
          }
        ],
        "sourceGroupName": "Global"
      },
      {
        "uuid": "preferredTerm",
        "displayName": "Term",
        "value": "YEARS_3",
        "defaultValue": "YEARS_1",
        "valueType": "STRING",
        "options": [
          {
            "label": "YEARS_1",
            "value": "YEARS_1"
          },
          {
            "label": "YEARS_3",
            "value": "YEARS_3"
          }
        ],
        "sourceGroupName": "Global"
      },
      {
        "uuid": "preferredCoverage",
        "displayName": "Coverage",
        "value": "80",
        "defaultValue": "80",
        "valueType": "NUMERIC",
        "min": 0,
        "max": 100,
        "sourceGroupName": "Global"
      },
      {
        "uuid": "riCoverageOverride",
        "displayName": "RI Coverage Override",
        "value": "false",
        "defaultValue": "false",
        "valueType": "BOOLEAN",
        "sourceGroupName": "Global"
      },
      {
        "uuid": "preferredOfferingClass",
        "displayName": "Type",
        "value": "STANDARD",
        "defaultValue": "STANDARD",
        "valueType": "STRING",
        "options": [
          {
            "label": "STANDARD",
            "value": "STANDARD"
          },
          {
            "label": "CONVERTIBLE",
            "value": "CONVERTIBLE"
          }
        ],
        "sourceGroupName": "Global"
      }
    ]
  },
  "changes": [
    {
      "index": 1,
      "type": "SCOPE",
      "scope": [
        {
          "uuid": "be95c99fc2a2195ac896204766a52d0e141818a6",
          "displayName": "PMs_AWS",
          "className": "Group",
          "entitiesCount": 50,
          "groupType": "PhysicalMachine",
          "severity": "Normal",
          "logicalOperator": "AND"
        }
      ]
    },
    {
      "index": 2,
      "type": "PROJECTION_PERIODS",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 3,
      "type": "ENABLED",
      "description": "Resize enabled",
      "targets": [],
      "enable": true,
      "projectionDays": [
        0
      ]
    },
    {
      "index": 4,
      "type": "RI_SETTINGS",
      "targets": [
        {
          "uuid": "preferredPaymentOption|ALL_UPFRONT"
        },
        {
          "uuid": "preferredTerm|YEARS_3"
        },
        {
          "uuid": "preferredCoverage|80"
        },
        {
          "uuid": "riCoverageOverride|false"
        },
        {
          "uuid": "preferredOfferingClass|STANDARD"
        }
      ],
      "projectionDays": [
        0
      ]
    }
  ],
  "timebasedTopologyChanges": {}
}
      

On-Prem Workload Migration (Cluster to Cluster)

POST:

{
  "configChanges": {
    "addPolicyList": [],
    "automationSettingList": [],
    "removeConstraintList": [],
    "removePolicyList": [],
    "riSettingList": [],
    "osMigrationSettingList": [],
    "subscription": {}
  },
  "displayName": "On-Prem Workload Migration 1",
  "loadChanges": {
    "utilizationList": [],
    "maxUtilizationList": []
  },
  "projectionDays": [
    0
  ],
  "scope": [
    {
      "uuid": "3e47ff3351f3247367c00c08fdc5bb974695c443",
      "displayName": "DC23-Datacenter\\DC23-cluster1",
      "groupType": "PhysicalMachine",
      "className": "Cluster"
    }
  ],
  "topologyChanges": {
    "addList": [
      {
        "count": 1,
        "projectionDays": [
          0
        ],
        "target": {
          "uuid": "67d24a6f265151876e87f39475fb4ee4b4170098",
          "displayName": "AvailabilitySet::ARSEN-AVS-NCUS",
          "className": "VirtualMachine"
        }
      }
    ],
    "migrateList": [],
    "removeList": [],
    "replaceList": [],
    "relievePressureList": []
  },
  "type": "WORKLOAD_MIGRATION"
}
      

Response:

{
  "uuid": "2502063893936",
  "displayName": "On-Prem Workload Migration- Basic",
  "owners": [
    {
      "uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
      "username": "administrator",
      "showSharedUserSC": false
    }
  ],
  "type": "WORKLOAD_MIGRATION",
  "scope": [
    {
      "uuid": "_0x3OYUglEd-gHc4L513yOA",
      "displayName": "Market",
      "className": "Market"
    }
  ],
  "projectionDays": [
    0
  ],
  "topologyChanges": {
    "addList": [
      {
        "projectionDays": [
          0
        ],
        "target": {
          "uuid": "a6d365f4fbf03fb9a2e8cdb29e38045e31cee41b",
          "displayName": "Beta DC6_vm",
          "className": "Group"
        },
        "count": 1
      }
    ]
  },
  "loadChanges": {},
  "configChanges": {},
  "changes": [
    {
      "index": 1,
      "type": "SCOPE",
      "scope": [
        {
          "uuid": "_0x3OYUglEd-gHc4L513yOA",
          "displayName": "Market",
          "className": "Market"
        }
      ]
    },
    {
      "index": 2,
      "type": "PROJECTION_PERIODS",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 3,
      "type": "ADDED",
      "description": "1 Beta DC6_vm",
      "targets": [
        {
          "uuid": "a6d365f4fbf03fb9a2e8cdb29e38045e31cee41b",
          "displayName": "Beta DC6_vm",
          "className": "Group",
          "entitiesCount": 56,
          "groupType": "VirtualMachine",
          "severity": "Major",
          "logicalOperator": "AND"
        }
      ],
      "value": "1",
      "projectionDays": [
        0
      ]
    }
  ],
  "timebasedTopologyChanges": {}
}
      

Hardware Refresh

POST:

{
  "configChanges": {
    "addPolicyList": [],
    "automationSettingList": [],
    "removeConstraintList": [],
    "removePolicyList": [],
    "riSettingList": [],
    "osMigrationSettingList": [],
    "subscription": {}
  },
  "displayName": "Hardware Refresh- Basic",
  "loadChanges": {
    "utilizationList": [],
    "maxUtilizationList": []
  },
  "projectionDays": [
    0
  ],
  "scope": [
    {
      "uuid": "Market",
      "displayName": "Global Environment",
      "className": "Market"
    }
  ],
  "topologyChanges": {
    "addList": [],
    "migrateList": [],
    "removeList": [],
    "replaceList": [
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
          "displayName": "dell-pe1944.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        },
        "template": {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
          "displayName": "dell-pe1953.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        },
        "template": {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
          "displayName": "dell-pe1954.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        },
        "template": {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "Virtual_ESX_4238e933-3923-8334-37fe-3aec8fbd046f",
          "displayName": "hp-esx22.dev.mycorp.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        },
        "template": {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      }
    ],
    "relievePressureList": []
  },
  "type": "RECONFIGURE_HARDWARE"
}
      

Response:

{
  "uuid": "2502070918448",
  "displayName": "Hardware Refresh- Basic",
  "owners": [
    {
      "uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
      "username": "administrator",
      "showSharedUserSC": false
    }
  ],
  "type": "RECONFIGURE_HARDWARE",
  "scope": [
    {
      "uuid": "_0x3OYUglEd-gHc4L513yOA",
      "displayName": "Market",
      "className": "Market"
    }
  ],
  "projectionDays": [
    0
  ],
  "topologyChanges": {
    "replaceList": [
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
          "displayName": "dell-pe1944.corp.vmturbo.com",
          "className": "PhysicalMachine"
        },
        "template": {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
          "displayName": "dell-pe1953.corp.vmturbo.com",
          "className": "PhysicalMachine"
        },
        "template": {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
          "displayName": "dell-pe1954.corp.vmturbo.com",
          "className": "PhysicalMachine"
        },
        "template": {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      },
      {
        "projectionDay": 0,
        "target": {
          "uuid": "Virtual_ESX_4238e933-3923-8334-37fe-3aec8fbd046f",
          "displayName": "hp-esx22.dev.mycorp.com",
          "className": "PhysicalMachine"
        },
        "template": {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      }
    ]
  },
  "loadChanges": {},
  "configChanges": {},
  "changes": [
    {
      "index": 1,
      "type": "SCOPE",
      "scope": [
        {
          "uuid": "_0x3OYUglEd-gHc4L513yOA",
          "displayName": "Market",
          "className": "Market"
        }
      ]
    },
    {
      "index": 2,
      "type": "PROJECTION_PERIODS",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 3,
      "type": "REPLACED",
      "description": "Replace [dell-pe1944.corp.vmturbo.com, dell-pe1953.corp.vmturbo.com, dell-pe1954.corp.vmturbo.com, hp-esx... with HP_DL580 G7",
      "targets": [
        {
          "uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
          "displayName": "dell-pe1944.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        },
        {
          "uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
          "displayName": "dell-pe1953.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        },
        {
          "uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
          "displayName": "dell-pe1954.corp.vmturbo.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        },
        {
          "uuid": "Virtual_ESX_4238e933-3923-8334-37fe-3aec8fbd046f",
          "displayName": "hp-esx22.dev.mycorp.com",
          "className": "PhysicalMachine",
          "severity": "Critical"
        },
        {
          "uuid": "_juCtwJkfEeCX4rLBy_KD2g",
          "displayName": "HP_DL580 G7",
          "className": "PhysicalMachineProfile"
        }
      ],
      "value": "0",
      "projectionDays": [
        0
      ]
    }
  ],
  "timebasedTopologyChanges": {}
}
      

Alleviate Pressure

POST:

{
  "configChanges": {
    "addPolicyList": [],
    "automationSettingList": [],
    "removeConstraintList": [],
    "removePolicyList": [],
    "riSettingList": [],
    "osMigrationSettingList": [],
    "subscription": {}
  },
  "displayName": "Alleviate Pressure- Basic",
  "loadChanges": {
    "utilizationList": [],
    "maxUtilizationList": []
  },
  "projectionDays": [
    0
  ],
  "scope": [
    {
      "uuid": "11c63ebd77647e7b9c9fb85dd2d4c77464cbeac2",
      "displayName": "DC13\\DC13-Cluster",
      "className": "Cluster"
    },
    {
      "uuid": "57a4026a69ba4b46ebc430cb62d5c55eeea00695",
      "displayName": "DC13\\Physical Hosts_Cluster2 - Intel",
      "className": "Cluster"
    }
  ],
  "topologyChanges": {
    "addList": [],
    "migrateList": [],
    "removeList": [],
    "replaceList": [],
    "relievePressureList": [
      {
        "projectionDay": 0,
        "sources": [
          {
            "uuid": "11c63ebd77647e7b9c9fb85dd2d4c77464cbeac2",
            "displayName": "DC13\\DC13-Cluster",
            "className": "Cluster"
          }
        ],
        "destinations": [
          {
            "uuid": "57a4026a69ba4b46ebc430cb62d5c55eeea00695",
            "displayName": "DC13\\Physical Hosts_Cluster2 - Intel",
            "className": "Cluster"
          }
        ]
      }
    ]
  },
  "type": "ALLEVIATE_PRESSURE"
}
      

Response:

{
  "uuid": "2531404249984",
  "displayName": "On-Prem Workload Migration 1",
  "owners": [
    {
      "uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
      "username": "administrator",
      "showSharedUserSC": false
    }
  ],
  "type": "WORKLOAD_MIGRATION",
  "scope": [
    {
      "uuid": "3e47ff3351f3247367c00c08fdc5bb974695c443",
      "displayName": "DC23-Datacenter\\DC23-cluster1",
      "className": "Cluster",
      "groupType": "PhysicalMachine",
      "isStatic": true,
      "logicalOperator": "AND"
    }
  ],
  "projectionDays": [
    0
  ],
  "topologyChanges": {
    "addList": [
      {
        "projectionDays": [
          0
        ],
        "target": {
          "uuid": "67d24a6f265151876e87f39475fb4ee4b4170098",
          "displayName": "AvailabilitySet::ARSEN-AVS-NCUS",
          "className": "DiscoveredGroup"
        },
        "count": 1
      }
    ]
  },
  "loadChanges": {},
  "configChanges": {},
  "changes": [
    {
      "index": 1,
      "type": "SCOPE",
      "scope": [
        {
          "uuid": "3e47ff3351f3247367c00c08fdc5bb974695c443",
          "displayName": "DC23-Datacenter\\DC23-cluster1",
          "className": "Cluster",
          "entitiesCount": 3,
          "groupType": "PhysicalMachine",
          "severity": "Critical",
          "logicalOperator": "AND"
        }
      ]
    },
    {
      "index": 2,
      "type": "PROJECTION_PERIODS",
      "projectionDays": [
        0
      ]
    },
    {
      "index": 3,
      "type": "ADDED",
      "description": "1 AvailabilitySet::ARSEN-AVS-NCUS",
      "targets": [
        {
          "uuid": "67d24a6f265151876e87f39475fb4ee4b4170098",
          "displayName": "AvailabilitySet::ARSEN-AVS-NCUS",
          "className": "DiscoveredGroup",
          "entitiesCount": 3,
          "groupType": "VirtualMachine",
          "severity": "Critical",
          "logicalOperator": "AND"
        }
      ],
      "value": "1",
      "projectionDays": [
        0
      ]
    }
  ],
  "timebasedTopologyChanges": {}
}
      

Optimize Current Environment

The result of a plan run with no custom configuration is an optimization of your current environment, respecting all current policies and constraints.

POST:

{
  "configChanges": {
    "addPolicyList": [],
    "automationSettingList": [],
    "removeConstraintList": [],
    "removePolicyList": [],
    "riSettingList": [],
    "osMigrationSettingList": [],
    "subscription": {}
  },
  "displayName": "Custom- No Config",
  "loadChanges": {
    "utilizationList": [],
    "maxUtilizationList": []
  },
  "projectionDays": [],
  "scope": [
    {
      "uuid": "Market",
      "displayName": "Global Environment",
      "className": "Market"
    }
  ],
  "topologyChanges": {
    "addList": [],
    "migrateList": [],
    "removeList": [],
    "replaceList": [],
    "relievePressureList": []
  },
  "type": "CUSTOM"
}
      

Response:

{
  "uuid": "2502119526800",
  "displayName": "Custom- No Config",
  "owners": [
    {
      "uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
      "username": "administrator",
      "showSharedUserSC": false
    }
  ],
  "type": "CUSTOM",
  "scope": [
    {
      "uuid": "_0x3OYUglEd-gHc4L513yOA",
      "displayName": "Market",
      "className": "Market"
    }
  ],
  "changes": [
    {
      "index": 1,
      "type": "SCOPE",
      "scope": [
        {
          "uuid": "_0x3OYUglEd-gHc4L513yOA",
          "displayName": "Market",
          "className": "Market"
        }
      ]
    }
  ]
}