Return the DNS/DHCP server service configuration status of the configuration task that you created using the configureServerService API method.
Returns a JSON string of the overall configuration status and the configuration status of individual services.
The request
section displays a list of the object IDs of the
DNS/DHCP Servers to be configured with services using the
configureServerService API method.
status
section displays the status of the configuration. The
deployment status can be STARTED, FINISHED, or TOKEN_NOT_FOUND.
status
section is returned with the message
TOKEN_NOT_FOUND.The response
section
contains specific information about the services including the object ID of the
DNS/DHCP Server being configured, the status of the overall DNS/DHCP Server service
configuration, the status of the individual service configurations, and the result
of the service configuration.
The error
section lists out
any errors encountered during the configuration. If the services configured
successfully, the section displays an empty list.
The following is an example of a returned string:
{
"request":[1000000, 1000001, 1000002],
"status": "STARTED/FINISHED/TOKEN_NOT_FOUND",
"response":
{
"servers":[
{
"id": 1000000,
"status": "QUEUED/STARTED/FINISHED",
"services": [
{
"interfaces":
{
"status": "SUCCEEDED/FAILED",
"error": ""
},
"ntp":
{
"status": "SUCCEEDED/FAILED",
"error": ""
},
"firewall":
{
"status": "SUCCEEDED/FAILED",
"error": ""
},
"syslog":
{
"status": "SUCCEEDED/FAILED",
"error": ""
},
}
],
"error": ""
},
{
"id": 1000001,
"status": "QUEUED/STARTED/FINISHED",
"services": [
{
"syslog":
{
"status": "SUCCEEDED/FAILED",
"error": ""
}
}
],
"error": ""
},
{
"id": 1000002,
"status": "QUEUED/STARTED/FINISHED",
"services": [
{
"ntp":
{
"status": "SUCCEEDED/FAILED",
"error": ""
},
"firewall":
{
"status": "SUCCEEDED/FAILED",
"error": ""
},
}
],
"error": ""
}
]
}
}
When configuring large amounts of DNS/DHCP Servers, the configureServerServices API method configures 20 DNS/DHCP Servers at a time. Once a DNS/DHCP Server has finished configuring, the next DNS/DHCP Server is added to the end of the list. You can use the getServerServicesConfigurationStatus API method to retrieve the updated list of DNS/DHCP Servers that are currently being configured.