Firewall Deploy Configuration Task

Overview

API used to deploy all network security configuration changes to BIG-IP devices.

URI scheme

BasePath : /mgmt/cm/firewall/tasks
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

GET all deployment tasks.

GET /deploy-configuration

Description

Returns the collection of firewall namespace specific deployment tasks.

Responses

HTTP Code Description Schema
200 Collection of deployment tasks for firewall namespace. properties_deploy_collection
400 Error response “Bad Request” error_collection

Used to get a specific deployment configuration task identified by id.

GET /deploy-configuration/{objectId}

Description

Returns the deployment configuration task within the firewall namespace identified by id.

Parameters

Type Name Description Schema Default
Path objectId Policy object id. required string(UUID) None

Responses

HTTP Code Description Schema
200 Requested task object properties_deploy
400 Error response “Bad Request” error_collection

POST deployment task policy for firewall namespace.

POST /deploy-configuration

Description

Creates a new deployment task within the firewall namespace.

Parameters

Type Name Description Schema Default
Body JSON request body Input parameter list in JSON format required post_deploy_body None

Responses

HTTP Code Description Schema
200 The posted deployment task properties_deploy
400 Error response “Bad Request” error_collection

Definitions

error_collection

Name Description Schema
kind Type information for error response. optional, read-only string
message Error message returned from server. optional, read-only string
requestBody The data in the request body. optional, read-only string
requestOperationId Unique id assigned to REST operation. optional, read-only integer(int64)

post_deploy_body

Name Description Schema
name Name to use for deployment task required string

properties_deploy

Name Description Schema
childDeployTasks Child state of deploy task (currentStep, deviceReference, snapshotReference, status.) optional < childDeployTasks > array
childSnapshotReference Shared namespace snapshot that was created during this deploy task. optional childSnapshotReference
currentStep Step of task during deploy process. optional string
deviceDetails Detail of device (deviceReference, difference count, verify error count, verify critical error count, post deploy error count, hostname). optional < deviceDetails > array
differenceReference Reference link to config differences. optional differenceReference
differenceTaskReference Reference link to config differencesr task optional differenceTaskReference
discoveryTaskReferences Reference link to collection of discovery tasks. optional < discoveryTaskReferences > array
distributeTaskReference Deploy needed, reference link to firewall distribute rest configuration. optional distributeTaskReference
distributeTaskReferences Deploy needed, reference link to shared security distribute rest configuration. optional distributeTaskReferences
endDateTime Date and time that the deployment task completed. optional string
generation Monotonically increasing integer identifying generation of this task object. optional, read-only integer(int64)
id Unique id assigned to this deploy task object. optional, read-only string
identityReferences Reference link table to authz users. optional < identityReferences > array
isChildTask Defines if a task is a child object noted by childDeployTasks. (True/False) optional boolean
kind Identification of resource ex. cm:firewall:tasks:deploy-configuration:deployconfigtaskstate optional, read-only string
lastUpdateMicros Time, in microsec, when deploy task was updated. optional, read-only integer(int64)
name Name of deployment task optional string
ownerMachineId A unique id generated by software if identify device object using hardware address. optional string
parentTaskReference Reference link to parent deploy-configuration task. optional parentTaskReference
partition BIG-IP partition, default Common. optional string
selfLink URI link used to identify the deploy task object. optional, read-only string
skipVerifyConfig Skip verification of configuration for deployment. optional boolean
snapshotReference Reference to snapshot for deploy task. optional snapshotReference
snapshotTaskReference Reference link to snapshot-config task. optional snapshotTaskReference
startDateTime Start time, in date format, the deployment task began. optional string
status Status or actual state of task in state machine. optional string
userReference Reference link to authz user. optional userReference
username Username of user. optional string
verifyConfigReference Reference to the verify configuration. optional verifyConfigReference
verifyConfigTaskReference Reference to the verification task. verifyConfigTaskReference

childDeployTasks

Name Description Schema
deviceReference Device reference link for each child task of deploy. optional < deviceReference > array
skipDistribution Skip distribution of configuration during deployment.(True/False) Verfication only prior. optional boolean

deviceReference

Name Description Schema
link Reference link to device object for deploy task. optional string

childSnapshotReference

Name Description Schema
isSubcollection Is subcollection of snapshots created by the deploy task. (True/False) optional boolean
link Reference link to snapshot for deploy task optional. string

deviceDetails

Name Description Schema
deviceReference Reference link to device object for deploy task. optional deviceReference
differenceCount A count of the number of difference during evaluation. optional integer
hostname Hostname of device deploying configuration to. optional string
postDeploymentErrorCount A count of the errors encountered post deploy. optional integer
verificationCriticalErrorCount A count of critical errors encountered during verification. optional integer
verificationErrorCount A count of errors encountered during verification. optional integer

deviceReference

Name Description Schema
link Reference link to device object for deploy task. optional string

differenceReference

Name Description Schema
isSubcollection Is subcollection of differences (True/False) optional boolean
link Reference link to difference array object. optional string

differenceTaskReference

Name Description Schema
link Reference link to differencer task. optional string

differenceTaskReferences

Name Description Schema
isSubcollection Is subcollection of diffencer tasks. optional boolean
link Reference links to differencer tasks. optional string

discoveryTaskReferences

Name Description Schema
isSubcollection Is subcollection of discovery tasks. optional boolean
link Reference links to discovery tasks. optional string

distributeTaskReference

Name Description Schema
link Reference links to distribute task. optional string

distributeTaskReferences

Name Description Schema
isSubcollection Is subcollection of distribute tasks. optional boolean
link Reference links to distribute tasks. optional string

identityReferences

Name Description Schema
isSubcollection Is subcollection of identity reference object. optional boolean
link Reference links to identity reference object. optional string

parentTaskReference

Name Description Schema
link Reference links to deploy-configuration task. optional string

snapshotReference

Name Description Schema
link Reference links to snapshot object. optional string

snapshotTaskReference

Name Description Schema
isSubcollection Is subcollection of snapshot tasks. optional boolean
link Reference links to snapshot task. optional string

userReference

Name Description Schema
link Reference links to user reference object. optional string

verifyConfigReference

Name Description Schema
link Reference links to verification reference object. optional string

verifyConfigTaskReference

Name Description Schema
link Reference links to verification reference task. optional string

properties_deploy_collection

Name Description Schema
generation A unique integer that tracks changes to deploy collection object. optional, read-only integer(int64)
items Collection of deploy tasks-properties. optional < object > array
kind Type information for this deploy collection object. optional, read-only string
lastUpdateMicros Update time (micros) for last change made to an deploy task collection object-time. optional, read-only integer(int64)
selfLink A reference link URI to the deploy task collection object. optional, read-only string