Access Deploy Configuration Task

Overview

This document describes the API usage of ‘Access Deploy Configuration’ task. This task is used to deploy Access configuration changes from BIG-IQ to one or more BIG-IP devices.

REST Endpoint: /mgmt/cm/access/tasks/super-deploy

Requests

POST /mgmt/cm/access/tasks/super-deploy

Request Parameters

Name Type Required Description
subDeploy boolean False If this flag is true, any LTM objects referred from Access objects are also deployed.
disableUnusedObjectRemoval boolean False If this flag is set to true, any unused objects on the device are not removed during deployment.
skipVerifyConfig boolean False If this flag is set to true, the configuration verification is skipped during deployment.
skipDistribution boolean False If this flag is set to true, to stop deployment task after verifying the configuration, the Access and LTM deployment task references must be used to retrieve verification warnings and errors. To continue distributing the changes to the BIG-IP system, remove this flag and restart the task.
deviceReferences reference False List of devices references to deploy.
     link string False URI link of the reference.
deviceGroupReference reference False Access Group reference of the devices provided in Device References.
     link string False URI link of the reference.
deployDeviceErrors array_of_objects False List of deployment errors for devices.

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
mainModule object Main Access module for which the deployment task is created.
     module string Main module name.
     status string Main Access module deployment task status.
     errorMsg string Error message if the Access deployment task failed.
     startTime string Start time of the module import for the device.
     endTime string End time of the module import for the device.
     taskReference reference Access deployment task reference.
          link string URI link of the reference.
     snapshotWorkingConfig boolean Take snapshot of the Access Group configuration before importing.
subModule object Sub module (LTM) for which the deployment task is created.
     module string Sub module name.
     status string Sub module (LTM) deployment task status.
     errorMsg string Error message if the LTM deployment task failed.
     startTime string Start time of the module import for the device.
     startTime string End time of the module import for the device.
     taskReference reference LTM deployment task reference.
          link string URI link of the reference.
     snapshotWorkingConfig boolean Take a snapshot of the LTM configuration before importing.
subDeploy boolean If this flag is true, any LTM objects referred from Access objects are also deployed.
disableUnusedObjectRemoval boolean If this flag is set to true, any unused objects on the device are not removed during deployment.
skipVerifyConfig boolean If this flag is set to true, the configuration verification is skipped during deployment.
skipDistribution boolean If this flag is set to true, to stop deployment task after verifying the configuration, the Access and LTM deployment task references must be used to retrieve verification warnings and errors. To continue distributing the changes to the BIG-IP system, remove this flag and restart the task.
deviceReferences reference List of devices references to deploy.
     link string URI link of the reference.
deviceGroupReference reference Access Group reference of the devices provided in Device References.
     link string URI link of the reference.
snapshotReference reference Access Group snapshot reference taken for deployment.
     link string URI link of the reference.
deployTaskReference reference Access deployment task reference..
     link string URI link of the reference.
subDeployTaskReference reference LTM deployment task reference.
     link string URI link of the reference.
subObjectsTaskReference reference Reference to task that determined the list of LTM objects used by Access Objects for LTM deployment. A list of LTM objects used by Access Objects can be retrieved from this task.
     link string URI link of the reference.
deployDeviceErrors array_of_objects List of deployment errors for devices.
     deviceReference reference Device reference on which the error was seen.
          link string URI link of the reference.
     error string Error message describing the deployment failure on the device.
currentStep string Current step indicating the progress of deployment.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to the error during a POST method. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response occurs when access is denied due to invalid credentials or insufficient permissions.

Permissions

Role Allow
Access_Manager Yes
Access_Deploy Yes
Access_View No
Access_Edit No

GET /mgmt/cm/access/tasks/super-deploy/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
mainModule object Main Access module for which the deployment task is created.
     module string Main module name.
     status string Main Access module deployment task status.
     errorMsg string Error message if the Access deployment task failed.
     startTime string Start time of the module import for the device.
     startTime string End time of the module import for the device.
     taskReference reference Access deployment task reference.
          link string URI link of the reference.
     snapshotWorkingConfig boolean Take snapshot of the Access Group configuration before importing.
subModule object Sub module (LTM) for which the deployment task is created.
     module string Sub module name.
     status string Sub module (LTM) deployment task status.
     errorMsg string Error message if the LTM deployment task failed.
     startTime string Start time of the module import for the device.
     startTime string End time of the module import for the device.
     taskReference reference LTM deployment task reference.
          link string URI link of the reference.
     snapshotWorkingConfig boolean Take a snapshot of the LTM configuration before importing.
subDeploy boolean If this flag is true, any LTM objects referred from Access objects are also deployed.
disableUnusedObjectRemoval boolean If this flag is set to true, any unused objects on the device are not removed during deployment.
skipVerifyConfig boolean If this flag is set to true, the configuration verification is skipped during deployment.
skipDistribution boolean If this flag is set to true, to stop deployment task after verifying the configuration, the Access and LTM deployment task references must be used to retrieve verification warnings and errors. To continue distributing the changes to the BIG-IP system, remove this flag and restart the task.
deviceReferences reference List of devices references to deploy.
     link string URI link of the reference.
deviceGroupReference reference Access Group reference of the devices provided in Device References.
     link string URI link of the reference.
snapshotReference reference Access Group snapshot reference taken for deployment.
     link string URI link of the reference.
deployTaskReference reference Access deployment task reference..
     link string URI link of the reference.
subDeployTaskReference reference LTM deployment task reference.
     link string URI link of the reference.
subObjectsTaskReference reference Reference to task that determined the list of LTM objects used by Access Objects for LTM deployment. A list of LTM objects used by Access Objects can be retrieved from this task.
     link string URI link of the reference.
deployDeviceErrors array_of_objects List of deployment errors for devices.
     deviceReference reference Device reference on which the error was seen.
          link string URI link of the reference.
     error string Error message describing the deployment failure on the device.
currentStep string Current step indicating the progress of deployment.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to error during a GET method. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response occurs when access is denied due to invalid credentials or insufficient permissions.

Permissions

Role Allow
Access_Manager Yes
Access_Deploy Yes
Access_View Yes
Access_Edit Yes

PATCH /mgmt/cm/access/tasks/super-deploy/<id>

Request Parameters

Name Type Required Description
subDeploy boolean False If this flag is true, any LTM objects referred from Access objects are also deployed.
skipDistribution boolean False If this flag is set to true, to stop deployment task after verifying the configuration, the Access and LTM deployment task references must be used to retrieve verification warnings and errors. To continue distributing the changes to the BIG-IP system, remove this flag and restart the task.
deployDeviceErrors array_of_objects False List of deployment errors for devices.

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
mainModule object Main Access module for which the deployment task is created.
     module string Main module name.
     status string Main Access module deployment task status.
     errorMsg string Error message if the Access deployment task failed.
     startTime string Start time of the module import for the device.
     startTime string End time of the module import for the device.
     taskReference reference Access deployment task reference.
          link string URI link of the reference.
     snapshotWorkingConfig boolean Take snapshot of the Access Group configuration before importing.
subModule object Sub module (LTM) for which the deployment task is created.
     module string Sub module name.
     status string Sub module (LTM) deployment task status.
     errorMsg string Error message if the LTM deployment task failed.
     startTime string Start time of the module import for the device.
     startTime string End time of the module import for the device.
     taskReference reference LTM deployment task reference.
          link string URI link of the reference.
     snapshotWorkingConfig boolean Take a snapshot of the LTM configuration before importing.
subDeploy boolean If this flag is true, any LTM objects referred from Access objects are also deployed.
disableUnusedObjectRemoval boolean If this flag is set to true, any unused objects on the device are not removed during deployment.
skipVerifyConfig boolean If this flag is set to true, the configuration verification is skipped during deployment.
skipDistribution boolean If this flag is set to true, to stop deployment task after verifying the configuration, the Access and LTM deployment task references must be used to retrieve verification warnings and errors. To continue distributing the changes to the BIG-IP system, remove this flag and restart the task.
deviceReferences reference List of devices references to deploy.
     link string URI link of the reference.
deviceGroupReference reference Access Group reference of the devices provided in Device References.
     link string URI link of the reference.
snapshotReference reference Access Group snapshot reference taken for deployment.
     link string URI link of the reference.
deployTaskReference reference Access deployment task reference..
     link string URI link of the reference.
subDeployTaskReference reference LTM deployment task reference.
     link string URI link of the reference.
subObjectsTaskReference reference Reference to task that determined the list of LTM objects used by Access Objects for LTM deployment. A list of LTM objects used by Access Objects can be retrieved from this task.
     link string URI link of the reference.
deployDeviceErrors array_of_objects List of deployment errors for devices.
     deviceReference reference Device reference on which the error was seen.
          link string URI link of the reference.
     error string Error message describing the deployment failure on the device.
currentStep string Current step indicating the progress of deployment.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to error during a PATCH method. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response occurs when access is denied due to invalid credentials or insufficient permissions.

Permissions

Role Allow
Access_Manager Yes
Access_Deploy Yes
Access_View No
Access_Edit No

DELETE /mgmt/cm/access/tasks/super-deploy/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
mainModule object Main Access module for which the deployment task is created.
     module string Main module name.
     status string Main Access module deployment task status.
     errorMsg string Error message if the Access deployment task failed.
     startTime string Start time of the module import for the device.
     startTime string End time of the module import for the device.
     taskReference reference Access deployment task reference.
          link string URI link of the reference.
     snapshotWorkingConfig boolean Take snapshot of the Access Group configuration before importing.
subModule object Sub module (LTM) for which the deployment task is created.
     module string Sub module name.
     status string Sub module (LTM) deployment task status.
     errorMsg string Error message if the LTM deployment task failed.
     startTime string Start time of the module import for the device.
     startTime string End time of the module import for the device.
     taskReference reference LTM deployment task reference.
          link string URI link of the reference.
     snapshotWorkingConfig boolean Take a snapshot of the LTM configuration before importing.
subDeploy boolean If this flag is true, any LTM objects referred from Access objects are also deployed.
disableUnusedObjectRemoval boolean If this flag is set to true, any unused objects on the device are not removed during deployment.
skipVerifyConfig boolean If this flag is set to true, the configuration verification is skipped during deployment.
skipDistribution boolean If this flag is set to true, to stop deployment task after verifying the configuration, the Access and LTM deployment task references must be used to retrieve verification warnings and errors. To continue distributing the changes to the BIG-IP system, remove this flag and restart the task.
deviceReferences reference List of devices references to deploy.
     link string URI link of the reference.
deviceGroupReference reference Access Group reference of the devices provided in Device References.
     link string URI link of the reference.
snapshotReference reference Access Group snapshot reference taken for deployment.
     link string URI link of the reference.
deployTaskReference reference Access deployment task reference..
     link string URI link of the reference.
subDeployTaskReference reference LTM deployment task reference.
     link string URI link of the reference.
subObjectsTaskReference reference Reference to task that determined the list of LTM objects used by Access Objects for LTM deployment. A list of LTM objects used by Access Objects can be retrieved from this task.
     link string URI link of the reference.
deployDeviceErrors array_of_objects List of deployment errors for devices.
     deviceReference reference Device reference on which the error was seen.
          link string URI link of the reference.
     error string Error message describing the deployment failure on the device.
currentStep string Current step indicating the progress of deployment.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to error during a DELETE method. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response occurs when access is denied due to invalid credentials or insufficient permissions.

Permissions

Role Allow
Access_Manager Yes
Access_Deploy Yes
Access_View No
Access_Edit No

Examples

Create Access Deploy Configuration Task

POST /mgmt/cm/access/tasks/super-deploy
{
    "subDeploy": true,
    "disableUnusedObjectRemoval": true,
    "skipVerifyConfig": false,
    "skipDistribution": false,
    "deviceReferences": [{
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    }],
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployDeviceErrors": [{
    }],
}

Response

HTTP/1.1 200 OK
{
    "mainModule": {
        "module": "access",
        "status": "STARTED",
        "errorMsg": "Access deployment failed. Something bad happened.",
        "startTime": "2018-01-30T21:37:10.104-0800",
        "endTime": "2018-01-30T21:38:07.104-0800",
        "taskReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "snapshotWorkingConfig": true
    },
    "subModule": {
        "module": "adc_core",
        "status": "STARTED",
        "errorMsg": "LTM deployment failed. Something bad happened.",
        "startTime": "2018-01-30T21:37:10.104-0800",
        "endTime": "2018-01-30T21:38:07.104-0800",
        "taskReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "snapshotWorkingConfig": true
    },
    "subDeploy": true,
    "disableUnusedObjectRemoval": true,
    "skipVerifyConfig": false,
    "skipDistribution": false,
    "deviceReferences": [{
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    }],
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "snapshotReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "subDeployTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "subObjectsTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployDeviceErrors": [{
        "deviceReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "error": "Deployment of 11.111.111.111 failed. Something bad happened."
    }],
    "currentStep": "DISTRIBUTE_CONFIG"
}

Get Access Deploy Configuration Task

GET /mgmt/cm/access/tasks/super-deploy/<id>

Response

HTTP/1.1 200 OK
{
    "mainModule": {
        "module": "access",
        "status": "STARTED",
        "errorMsg": "Access deployment failed. Something bad happened.",
        "startTime": "2018-01-30T21:37:10.104-0800",
        "endTime": "2018-01-30T21:38:07.104-0800",
        "taskReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "snapshotWorkingConfig": true
    },
    "subModule": {
        "module": "adc_core",
        "status": "STARTED",
        "errorMsg": "LTM deployment failed. Something bad happened.",
        "startTime": "2018-01-30T21:37:10.104-0800",
        "endTime": "2018-01-30T21:38:07.104-0800",
        "taskReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "snapshotWorkingConfig": true
    },
    "subDeploy": true,
    "disableUnusedObjectRemoval": true,
    "skipVerifyConfig": false,
    "skipDistribution": false,
    "deviceReferences": [{
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    }],
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "snapshotReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "subDeployTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "subObjectsTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployDeviceErrors": [{
        "deviceReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "error": "Deployment of 11.111.111.111 failed. Something bad happened."
    }],
    "currentStep": "DISTRIBUTE_CONFIG"
}

PATCH Access Deploy Configuration Task

PATCH /mgmt/cm/access/tasks/super-deploy/<id>
{
    "subDeploy": true,
    "skipDistribution": false,
    "deployDeviceErrors": [{
    }],
}

Response

HTTP/1.1 200 OK
{
    "mainModule": {
        "module": "access",
        "status": "STARTED",
        "errorMsg": "Access deployment failed. Something bad happened.",
        "startTime": "2018-01-30T21:37:10.104-0800",
        "endTime": "2018-01-30T21:38:07.104-0800",
        "taskReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "snapshotWorkingConfig": true
    },
    "subModule": {
        "module": "adc_core",
        "status": "STARTED",
        "errorMsg": "LTM deployment failed. Something bad happened.",
        "startTime": "2018-01-30T21:37:10.104-0800",
        "endTime": "2018-01-30T21:38:07.104-0800",
        "taskReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "snapshotWorkingConfig": true
    },
    "subDeploy": true,
    "disableUnusedObjectRemoval": true,
    "skipVerifyConfig": false,
    "skipDistribution": false,
    "deviceReferences": [{
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    }],
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "snapshotReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "subDeployTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "subObjectsTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployDeviceErrors": [{
        "deviceReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "error": "Deployment of 11.111.111.111 failed. Something bad happened."
    }],
    "currentStep": "DISTRIBUTE_CONFIG"
}

Delete Access Deploy Configuration Task

DELETE /mgmt/cm/access/tasks/super-deploy/<id>

Response

HTTP/1.1 200 OK
{
    "mainModule": {
        "module": "access",
        "status": "STARTED",
        "errorMsg": "Access deployment failed. Something bad happened.",
        "startTime": "2018-01-30T21:37:10.104-0800",
        "endTime": "2018-01-30T21:38:07.104-0800",
        "taskReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "snapshotWorkingConfig": true
    },
    "subModule": {
        "module": "adc_core",
        "status": "STARTED",
        "errorMsg": "LTM deployment failed. Something bad happened.",
        "startTime": "2018-01-30T21:37:10.104-0800",
        "endTime": "2018-01-30T21:38:07.104-0800",
        "taskReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "snapshotWorkingConfig": true
    },
    "subDeploy": true,
    "disableUnusedObjectRemoval": true,
    "skipVerifyConfig": false,
    "skipDistribution": false,
    "deviceReferences": [{
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    }],
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "snapshotReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "subDeployTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "subObjectsTaskReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
    },
    "deployDeviceErrors": [{
        "deviceReference": {
            "link": "https://localhost/mgmt/shared/foo/bar/844cfd8a-4e03-48e9-ba94-bb21a4cb4634"
        },
        "error": "Deployment of 11.111.111.111 failed. Something bad happened."
    }],
    "currentStep": "DISTRIBUTE_CONFIG"
}