PUT /albservicesjob/{uuid}

• Albservices Job

/albservicesjob/{uuid}

Request

URI

PUT

https://api_host/api/albservicesjob/{uuid}

COPY

Path Parameters

string

uuid

Required

UUID of the object to fetch

Query Parameters

string

name

Optional

object name

Header Parameters

string

X-Avi-Tenant

Optional

Avi Tenant Header

string

X-Avi-Tenant-UUID

Optional

Avi Tenant Header UUID

string

X-Avi-Version

Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string

X-CSRFToken

Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

---

Request Body

ALBServicesJob of type(s) application/json

Optional

{
    "_last_modified": "string",
    "command": "string",
    "configpb_attributes": {
        "version": 0
    },
    "end_time": {
        "secs": 0,
        "usecs": 0
    },
    "name": "string",
    "params": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "pulse_job_id": "string",
    "pulse_sync_status": false,
    "result": "string",
    "start_time": {
        "secs": 0,
        "usecs": 0
    },
    "status": "string",
    "status_update_time": {
        "secs": 0,
        "usecs": 0
    },
    "tenant_ref": "string",
    "token": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string

command

Required

The command to be triggered by the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

TimeStamp

end_time

Optional

end_time

string

name

Required

The name of the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of ALBServicesJobParam

params

Optional

Job params. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

pulse_job_id

Optional

A unique identifier for this job entry on the Pulse Cloud Services. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean

pulse_sync_status

Optional

Status of sync to Pulse Cloud Services(result uploads/state updates). Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

result

Optional

Job result. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

TimeStamp

start_time

Optional

start_time

string

status

Optional

The status of the albservicesjob. Enum options - UNDETERMINED, PENDING, IN_PROGRESS, COMPLETED, FAILED, NOT_ENABLED. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

TimeStamp

status_update_time

Optional

status_update_time

string

tenant_ref

Optional

The unique identifier of the tenant to which this albservicesjob belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

token

Optional

Job token. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

url

Optional

url

string

uuid

Optional

A unique identifier for this albservicesjob entry. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Responses

200

Hide Details

OK

Returns ALBServicesJob of type(s) application/json

{
    "_last_modified": "string",
    "command": "string",
    "configpb_attributes": {
        "version": 0
    },
    "end_time": {
        "secs": 0,
        "usecs": 0
    },
    "name": "string",
    "params": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "pulse_job_id": "string",
    "pulse_sync_status": false,
    "result": "string",
    "start_time": {
        "secs": 0,
        "usecs": 0
    },
    "status": "string",
    "status_update_time": {
        "secs": 0,
        "usecs": 0
    },
    "tenant_ref": "string",
    "token": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string

command

Required

The command to be triggered by the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

TimeStamp

end_time

Optional

end_time

string

name

Required

The name of the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of ALBServicesJobParam

params

Optional

Job params. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

pulse_job_id

Optional

A unique identifier for this job entry on the Pulse Cloud Services. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean

pulse_sync_status

Optional

Status of sync to Pulse Cloud Services(result uploads/state updates). Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

result

Optional

Job result. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

TimeStamp

start_time

Optional

start_time

string

status

Optional

The status of the albservicesjob. Enum options - UNDETERMINED, PENDING, IN_PROGRESS, COMPLETED, FAILED, NOT_ENABLED. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

TimeStamp

status_update_time

Optional

status_update_time

string

tenant_ref

Optional

The unique identifier of the tenant to which this albservicesjob belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

token

Optional

Job token. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

url

Optional

url

string

uuid

Optional

A unique identifier for this albservicesjob entry. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

401

Hide Details

log in failed

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Query Parameters

Header Parameters

Request Body

Response

200 Response Body

Errors

Albservices Job Operations

DELETE

DELETE /albservicesjob/{uuid}

GET

GET /albservicesjob

GET

GET /albservicesjob/{uuid}

PATCH

PATCH /albservicesjob/{uuid}

POST

POST /albservicesjob

PUT

PUT /albservicesjob/{uuid}