You can specify the deployment profile ID and application properties to begin a deployment process. Provide a deployment ID to view a list of the available properties that you can configure for a deployment.

Retrieves the scheduled deployment task.

All of the vCloud Application Director predefined user accounts and associated roles can access this API.

GET

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment-task/DeploymentID

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment-task/10
{
  "errors": false,
  "messageList": [],
  "result": {
    "id": "10",
    "lockVersion": 63,
    "name": null,
    "description": null,
    "lastUpdated": 1378856459660,
    "lastUpdateUser": "SYSTEM",
    "created": 1378856410491,
    "createUser": "admin",
    "scheduled": 1378856408373,
    "startTime": 1378856417820,
    "endTime": 1378856459660,
    "runId": "6",
    "updateType": null,
    "stateType": "TASK_SUCCESS",
    "taskType": "PROVISIONING_TASK",
    "messages": [
      "Deployment completed successfully."
    ],
    "runStateType": "COMPLETED",
    "deploymentRef": {
      "uri": "/darwin/api/2.0/deployment/6",
      "id": "6",
      "name": "appd-Clustered Dukes Bank App-2.1.0-admin-6-b452d90c-b72e-4737-8f45-3c7540cf932c"
    },
    "deploymentNodes": [
      {
        "id": "16",
        "lockVersion": 0,
        "deploymentNodeInstances": [
          {
            "id": "16",
            "lockVersion": 0,
            "name": "load_balancer",
            "description": null,
            "lastUpdated": null,
            "lastUpdateUser": null,
            "created": null,
            "createUser": null,
            "runStateType": "VMSTARTED",
            "instanceIndex": -1,
            "hostname": "load-b-NINZZ3FG",
            "nodeInstanceUri": " https://192.0.2.255/api/vApp/vm-8da6b54e-db75-484b-ae61-aa0cc7b4b735",
            "queueName": "appd-agent-0289911e-f67b-4ab8-9e53-f02095ff48d3",
            "deprovisioned": false,
            "deploymentNodeTasks": [
              {
                "id": "82",
                "lockVersion": 10,
                "name": "agent_bootstrap",
                "description": null,
                "lastUpdated": 1378856440642,
                "lastUpdateUser": "SYSTEM",
                "created": 1378856418500,
                "createUser": "SYSTEM",
                "componentIdentifier": "agent_bootstrap",
                "nodeIdentifier": "load_balancer",
                "runStateType": "COMPLETED",
                "runPhaseType": "BOOTSTRAP",
                "startTime": 1378856433235,
                "endTime": 1378856440642,
                "elapsedTime": 7407,
                "inputProperties": [],
                "outputProperties": [],
                "logMessage": "processing input properties\nexecuting the script: […]\n",
                "logDescription": "stdout and stderr log available on VM at […]"
              },
[…]
            ],
            "networkConnections": [
              {
                "id": "18",
                "lockVersion": 0,
                "nicName": "NIC0",
                "networkName": "ServiceNetwork",
                "ipAddress": "127.0.0.1",
                "ipAddressType": "ASSIGNED",
                "cloudNetworkName": "NetworkRight",
                "cloudNetworkUri": " https://192.0.2.255/api/network/94978447-182e-4153-893f-9005cdc133c5 ",
                "macAddress": ""
              },
[…]
            ],
            "disks": []
          }
        ]
      },
[…]
    ]
  }
}

Retrieves a deployment task that you can specify for a deployment when a deployment profile ID is provided.

All of the vCloud Application Director predefined user accounts and associated roles can access this API.

GET

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment/DeploymentID/deployment-task

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment/6/deployment-task
{
  "errors": false,
  "messageList": [],
  "result": {
    "id": "10",
    "lockVersion": 63,
    "name": null,
    "description": null,
    "lastUpdated": 1378856459660,
    "lastUpdateUser": "SYSTEM",
    "created": 1378856410491,
    "createUser": "admin",
    "scheduled": 1378856408373,
    "startTime": 1378856417820,
    "endTime": 1378856459660,
    "runId": "6",
    "updateType": null,
    "stateType": "TASK_SUCCESS",
    "taskType": "PROVISIONING_TASK",
    "messages": [
      "Deployment completed successfully."
    ],
    "runStateType": "COMPLETED",
    "deploymentRef": {
      "uri": "/darwin/api/2.0/deployment/6",
      "id": "6",
      "name": "appd-Clustered Dukes Bank App-2.1.0-admin-6-b452d90c-b72e-4737-8f45-3c7540cf932c"
    },
    "deploymentNodes": [
      {
        "id": "16",
        "lockVersion": 0,
        "deploymentNodeInstances": [
          {
            "id": "16",
            "lockVersion": 0,
            "name": "load_balancer",
            "description": null,
            "lastUpdated": null,
            "lastUpdateUser": null,
            "created": null,
            "createUser": null,
            "runStateType": "VMSTARTED",
            "instanceIndex": -1,
            "hostname": "load-b-NINZZ3FG",
            "nodeInstanceUri": " https://192.0.2.255/api/vApp/vm-8da6b54e-db75-484b-ae61-aa0cc7b4b735",
            "queueName": "appd-agent-0289911e-f67b-4ab8-9e53-f02095ff48d3",
            "deprovisioned": false,
            "deploymentNodeTasks": [
              {
                "id": "82",
                "lockVersion": 10,
                "name": "agent_bootstrap",
                "description": null,
                "lastUpdated": 1378856440642,
                "lastUpdateUser": "SYSTEM",
                "created": 1378856418500,
                "createUser": "SYSTEM",
                "componentIdentifier": "agent_bootstrap",
                "nodeIdentifier": "load_balancer",
                "runStateType": "COMPLETED",
                "runPhaseType": "BOOTSTRAP",
                "startTime": 1378856433235,
                "endTime": 1378856440642,
                "elapsedTime": 7407,
                "inputProperties": [],
                "outputProperties": [],
                "logMessage": "processing input properties\nexecuting the script: […]\n",
                "logDescription": "stdout and stderr log available on VM at […]"
              },
[…]
            ],
            "networkConnections": [
              {
                "id": "18",
                "lockVersion": 0,
                "nicName": "NIC0",
                "networkName": "ServiceNetwork",
                "ipAddress": "127.0.0.1",
                "ipAddressType": "ASSIGNED",
                "cloudNetworkName": "NetworkRight",
                "cloudNetworkUri": " https://192.0.2.255/api/network/94978447-182e-4153-893f-9005cdc133c5 ",
                "macAddress": ""
              },
[…]
            ],
            "disks": []
          }
        ]
      },
[…]
    ]
  }
}

Retrieves the last failed deployment tasks for a deployment when a deployment task ID is provided.

All of the vCloud Application Director predefined user accounts and associated roles can access this API.

GET

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment/DeploymentID/failed-deployment-task

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment/5/failed-deployment-task
{
  "errors": false,
  "messageList": [],
  "result": {
    "id": "9",
    "lockVersion": 43,
    "name": null,
    "description": null,
    "lastUpdated": 1378856464867,
    "lastUpdateUser": "SYSTEM",
    "created": 1378855370104,
    "createUser": "admin",
    "scheduled": 1378855369244,
    "startTime": 1378855376879,
    "endTime": 1378856464867,
    "runId": "5",
    "updateType": null,
    "stateType": "TASK_FAILED",
    "taskType": "PROVISIONING_TASK",
    "messages": [
      "Run failed due to failure of task (load_balancer, agent_bootstrap). Agent logs are on the node load_balancer in logs directory under /opt/vmware-appdirector/agent."
    ],
    "runStateType": "FAILED",
    "deploymentRef": {
      "uri": "/darwin/api/2.0/deployment/5",
      "id": "5",
      "name": "appd-Clustered Dukes Bank App-2.1.0-admin-5-bc7d2134-813d-491d-908b-3ab97aa9ab39"
    },
[…]

Starts a deployment when a deployment profile ID and required application properties are provided. Returns the deployment task ID.

The user account with the ROLE_DEPLOYER deployer role can access this API.

POST

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment-profile/DeploymentProfileID/action/deploy

You must type the URI syntax because the copy and paste operation removes formatting from the text.

Example URI syntax:

https://ApplicationDirectorServerIP:8443/darwin/api/2.0/deployment-profile/2/action/deploy
{
  "node": [
    {
      "name": "Database",
      "nodeComponent": [
        {
          "name": "SQL_Server_2008",
          "property": [
            {
              "key": "INSTANCENAME",
              "value": "db100"
            }
          ]
        }
      ]
    }
  ]
}
{
  "errors": false,
  "messageList": [
    {
      "messageType": "INFO",
      "message": "Deployment scheduled successfully.",
      "messageKey": "deployment.scheduled.msg",
      "property": null
    }
  ],
  "result": {
    "id": "16",
    "lockVersion": 1,
    "name": null,
    "description": null,
    "lastUpdated": 1379024432475,
    "lastUpdateUser": "admin",
    "created": 1379024432472,
    "createUser": "admin",
    "scheduled": 1379024432336,
    "startTime": null,
    "endTime": null,
    "runId": null,
    "updateType": null,
    "stateType": "TASK_SCHEDULED",
    "taskType": "PROVISIONING_TASK",
    "messages": [],
    "runStateType": "NOT_STARTED",
    "deploymentRef": {
      "uri": "/darwin/api/2.0/deployment/10",
      "id": "10",
      "name": "appd-Clustered DotShoppingCart-1.0.0-admin-10-8f551d93-1cb1-4b47-854a-f65595177f41"
    },
    "deploymentNodes": []
  }
}