Avi UpgradeStatusSummary Object API

CLI ``` - show upgrade status ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /upgradestatusinfo
post /upgradestatusinfo
delete /upgradestatusinfo/{uuid}
get /upgradestatusinfo/{uuid}
patch /upgradestatusinfo/{uuid}
put /upgradestatusinfo/{uuid}

get /upgradestatusinfo

(upgradestatusinfoGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

UpgradeStatusSummaryApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "image_ref" : "aeiou",
    "enable_rollback" : true,
    "obj_cloud_ref" : "aeiou",
    "end_time" : "aeiou",
    "patch_image_ref" : "aeiou",
    "total_tasks" : 123,
    "uuid" : "aeiou",
    "version" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "start_time" : "aeiou",
    "node_type" : "aeiou",
    "tasks_completed" : 123,
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "state" : {
      "reason" : "aeiou",
      "rebooted" : true,
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou"
    },
    "enable_patch_rollback" : true,
    "upgrade_ops" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK UpgradeStatusSummaryApiResponse

401

post /upgradestatusinfo

(upgradestatusinfoPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — UpgradeStatusSummary object creation

Return type

UpgradeStatusSummary

Example data

Content-Type: application/json

{
  "image_ref" : "aeiou",
  "enable_rollback" : true,
  "obj_cloud_ref" : "aeiou",
  "end_time" : "aeiou",
  "patch_image_ref" : "aeiou",
  "total_tasks" : 123,
  "uuid" : "aeiou",
  "version" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "start_time" : "aeiou",
  "node_type" : "aeiou",
  "tasks_completed" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "state" : {
    "reason" : "aeiou",
    "rebooted" : true,
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou"
  },
  "enable_patch_rollback" : true,
  "upgrade_ops" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK UpgradeStatusSummary

401

delete /upgradestatusinfo/{uuid}

(upgradestatusinfoUuidDelete)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /upgradestatusinfo/{uuid}

(upgradestatusinfoUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

UpgradeStatusSummary

Example data

Content-Type: application/json

{
  "image_ref" : "aeiou",
  "enable_rollback" : true,
  "obj_cloud_ref" : "aeiou",
  "end_time" : "aeiou",
  "patch_image_ref" : "aeiou",
  "total_tasks" : 123,
  "uuid" : "aeiou",
  "version" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "start_time" : "aeiou",
  "node_type" : "aeiou",
  "tasks_completed" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "state" : {
    "reason" : "aeiou",
    "rebooted" : true,
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou"
  },
  "enable_patch_rollback" : true,
  "upgrade_ops" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK UpgradeStatusSummary

401

patch /upgradestatusinfo/{uuid}

(upgradestatusinfoUuidPatch)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — UpgradeStatusSummary object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

UpgradeStatusSummary

Example data

Content-Type: application/json

{
  "image_ref" : "aeiou",
  "enable_rollback" : true,
  "obj_cloud_ref" : "aeiou",
  "end_time" : "aeiou",
  "patch_image_ref" : "aeiou",
  "total_tasks" : 123,
  "uuid" : "aeiou",
  "version" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "start_time" : "aeiou",
  "node_type" : "aeiou",
  "tasks_completed" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "state" : {
    "reason" : "aeiou",
    "rebooted" : true,
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou"
  },
  "enable_patch_rollback" : true,
  "upgrade_ops" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK UpgradeStatusSummary

401

put /upgradestatusinfo/{uuid}

(upgradestatusinfoUuidPut)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — UpgradeStatusSummary object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

UpgradeStatusSummary

Example data

Content-Type: application/json

{
  "image_ref" : "aeiou",
  "enable_rollback" : true,
  "obj_cloud_ref" : "aeiou",
  "end_time" : "aeiou",
  "patch_image_ref" : "aeiou",
  "total_tasks" : 123,
  "uuid" : "aeiou",
  "version" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "start_time" : "aeiou",
  "node_type" : "aeiou",
  "tasks_completed" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "state" : {
    "reason" : "aeiou",
    "rebooted" : true,
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou"
  },
  "enable_patch_rollback" : true,
  "upgrade_ops" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK UpgradeStatusSummary

401

Models

[ Jump to Methods ]

TimeStamp
UpgradeOpsState
UpgradeStatusSummary
UpgradeStatusSummaryApiResponse

TimeStamp Up

secs

Long Number of secs. format: int64

usecs

Long Number of usecs. format: int64

UpgradeOpsState Up

last_changed_time (optional)

TimeStamp The last time the state changed. Field introduced in 18.2.6.

reason (optional)

String Descriptive reason for the state-change. Field introduced in 18.2.6.

rebooted (optional)

Boolean State for keeping track of reboot status during upgrade operation. Field introduced in 20.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition.

state (optional)

String The upgrade operations current fsm-state. Enum options - UPGRADE_FSM_INIT, UPGRADE_FSM_STARTED, UPGRADE_FSM_WAITING, UPGRADE_FSM_IN_PROGRESS, UPGRADE_FSM_ENQUEUED, UPGRADE_FSM_ERROR, UPGRADE_FSM_SUSPENDED, UPGRADE_FSM_ENQUEUE_FAILED, UPGRADE_FSM_PAUSED, UPGRADE_FSM_COMPLETED, UPGRADE_FSM_ABORT_IN_PROGRESS, UPGRADE_FSM_ABORTED, UPGRADE_FSM_SE_UPGRADE_IN_PROGRESS, UPGRADE_FSM_CONTROLLER_COMPLETED, UPGRADE_FSM_DUMMY_3, UPGRADE_FSM_DUMMY_4, UPGRADE_FSM_DUMMY_5. Field introduced in 18.2.6.

UpgradeStatusSummary Up

_last_modified (optional)

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

enable_patch_rollback (optional)

Boolean Check if the patch rollback is possible on this node. Field introduced in 18.2.6.

enable_rollback (optional)

Boolean Check if the rollback is possible on this node. Field introduced in 18.2.6.

end_time (optional)

String End time of upgrade operations. Field introduced in 18.2.6.

image_ref (optional)

String Image uuid for identifying the current base image. It is a reference to an object of type Image. Field introduced in 18.2.6.

name (optional)

String Name of the system such as cluster name, se group name and se name. Field introduced in 18.2.6.

node_type (optional)

String Type of the system such as controller_cluster, se_group or se. Enum options - NODE_CONTROLLER_CLUSTER, NODE_SE_GROUP, NODE_SE_TYPE. Field introduced in 18.2.6.

obj_cloud_ref (optional)

String Cloud that this object belongs to. It is a reference to an object of type Cloud. Field introduced in 18.2.6.

patch_image_ref (optional)

String Image uuid for identifying the current patch. It is a reference to an object of type Image. Field introduced in 18.2.6.

start_time (optional)

String Start time of upgrade operations. Field introduced in 18.2.6.

state (optional)

UpgradeOpsState Current status of the upgrade operations. Field introduced in 18.2.6.

tasks_completed (optional)

Integer Upgrade tasks completed. Field introduced in 18.2.6. format: int32

tenant_ref (optional)

String Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.6.

total_tasks (optional)

Integer Total upgrade tasks. Field introduced in 18.2.6. format: int32

upgrade_ops (optional)

String Upgrade operations requested. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME. Field introduced in 18.2.6.

url (optional)

String url

uuid (optional)

String UUID Identifier for the system such as cluster, se group and se. Field introduced in 18.2.6.

version (optional)

String Current base image applied to this node. Field introduced in 18.2.6.

UpgradeStatusSummaryApiResponse Up

count

Integer format: int32

results

array[UpgradeStatusSummary]

next (optional)

String

Avi UpgradeStatusSummary Object API

Access

Methods

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Models

Table of Contents

TimeStamp Up

UpgradeOpsState Up

UpgradeStatusSummary Up

UpgradeStatusSummaryApiResponse Up