Selective Deployment Task Status - BlueCat Address Manager - 8.3.2

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
8.3.2

Returns the deployment status of the deployment task that was created using the selectiveDeploy( ) API method.

API call:

String getDeploymentTaskStatus ( String deploymentTaskToken )
Parameter Description
deploymentTaskToken The string token value that is returned from the selectiveDeploy( ) API method.
Output/Response:

Returns a string value of the overall deployment status and the deployment status of individual entities.

The request section displays a list of the entity IDs that were defined in the creation of the deployment task using the selectiveDeploy( ) API method. The status section displays the status of the deployment. The deployment status can be QUEUED, STARTED, FINISHED, or TASK_NOT_FOUND. The responses section contains specific information about the entities including the ID of the entity, the fully qualified domain name (FQDN), record type, TTL value, record data, the operation performed on the resource record, and the result of the deployment. The errors section lists out any errors encountered during the deployment. If all entities deployed successfully, the section displays an empty list.

The following lists an example of the returned string:

{
    "request":[1000000, 1000001, 1000002, 1000003],
    "status": "FINISHED",
    "response":
            {
                "views": [
                    {
                        "id": 100,
                        "name": "default",
                        "zones": [
                            {
                                "id": 1000,
                                "name": "example.com",
                                "ttl": 0,
                                "records":
                                    [
                                        {
                                          "id": 1000000,
                                          "name": "h1",
                                          "type": "A",
                                          "ttl": 3600,
                                          "rdata": "10.0.0.1",
                                          "op": "add",
                                          "result": "SUCCEEDED"
                                        },
                                        {
                                          "id": 1000002,
                                          "name": "c10",
                                          "type": "CNAME",
                                          "ttl": 3600,
                                          "rdata": "h1.example.com.",
                                          "op": "add",
                                          "result": "FAILED"
                                        },
                                        {
                                          "id": 1000003,
                                          "name": "h20",
                                          "type": "A",
                                          "ttl": 3600,
                                          "rdata": "10.0.0.20",
                                          "op": "del",
                                          "result": "SKIPPED"
                                        }
                                    ]
                            }
                        ]
                    },
                    {
                      "id": 200,
                      "name": "example1",
                      "zones": [
                        {
                          "id": 2001,
                          "name": "example1.com",
                          "ttl": "3600",
                          "records": [
                            {
                              "id": 1000001,
                              "name": "h1",
                              "type": "A",
                              "ttl": 3600,
                              "rdata": "10.0.0.1",
                              "op": "add",
                              "result": "SUCCEEDED"
                            }
                          ]
                        }
                      ]
                    }
                ]
                "errors": ["Error message 1","Error message 2; or empty if succeeded"]
            }
}

Note:
  • If the deployment task token passed is invalid or does not exist, only the status section is returned with the message TASK_NOT_FOUND.
  • If Address Manager determines that there have been no changes, the response and errors sections display empty lists. The following example displays this behaviour:
    {
        "request":[1000000, 1000001, 1000002, 1000003],
        "status": "FINISHED",
        "response":
                {
                    "views": []
                    "errors": []
                }
    }