PATCH /systemreport/{uuid}

PATCH /systemreport/{uuid}

/systemreport/{uuid}

Request
URI
PATCH
https://{api_host}/api/systemreport/{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

SystemReport object creation

SystemReport of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "archive_ref": "string",
    "controller_patch_image_ref": "string",
    "downloadable": false,
    "events": [
        {
            "duration": 0,
            "end_time": "string",
            "event_name": "string",
            "messages": [
                "string"
            ],
            "start_time": "string",
            "status": "string"
        }
    ],
    "image_ref": "string",
    "name": "string",
    "readiness_reports": [
        {
            "name": "string",
            "node_ref": "string",
            "node_type": "string",
            "obj_cloud_ref": "string",
            "system_readiness": {
                "checks": [
                    {
                        "check_code": "string",
                        "description": "string",
                        "details": [
                            "string"
                        ],
                        "duration": 0,
                        "end_time": "string",
                        "error_details": [
                            "string"
                        ],
                        "start_time": "string",
                        "state": "string"
                    }
                ],
                "checks_completed": 0,
                "duration": 0,
                "end_time": "string",
                "image_ref": "string",
                "patch_image_ref": "string",
                "start_time": "string",
                "state": {
                    "last_changed_time": {
                        "secs": 0,
                        "usecs": 0
                    },
                    "reason": "string",
                    "rebooted": false,
                    "state": "string"
                },
                "total_checks": 0,
                "upgrade_ops": "string"
            }
        }
    ],
    "se_patch_image_ref": "string",
    "state": {
        "last_changed_time": {
            "secs": 0,
            "usecs": 0
        },
        "reason": "string",
        "state": "string"
    },
    "summary": {
        "description": "string",
        "previews": [
            "string"
        ],
        "title": "string"
    },
    "tasks": [
        {
            "name": "string",
            "reason": "string",
            "summary": {
                "description": "string",
                "duration": 0,
                "end_time": "string",
                "error_count": 0,
                "reason": "string",
                "start_time": "string",
                "status": "string",
                "type": "string"
            },
            "task_journal_ref": "string"
        }
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns SystemReport of type(s) application/json 
"SystemReport Object"
string
_last_modified
Optional

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

string
archive_ref
Optional

Relative path to the report archive file on filesystem.The archive includes exported system configuration and current object as json. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
controller_patch_image_ref
Optional

Controller Patch Image associated with the report. It is a reference to an object of type Image. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
downloadable
Optional

Indicates whether this report is downloadable as an archive. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
events
Optional

List of events associated with the report. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
image_ref
Optional

System Image associated with the report. It is a reference to an object of type Image. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
name
Optional

Name of the report derived from operation in a readable format. Ex upgrade_system_1a5c. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
readiness_reports
Optional

Readiness state of the system. Ex Upgrade Pre-check Results. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
se_patch_image_ref
Optional

SE Patch Image associated with the report. It is a reference to an object of type Image. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
state
Optional

state

object
summary
Optional

summary

array of object
tasks
Optional

List of tasks associated with the report. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenant UUID associated with the Object. It is a reference to an object of type Tenant. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID Identifier for the report. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
System Report Operations
GET
GET /systemreport
POST
POST /systemreport
GET
GET /systemreport/{uuid}
PUT
PUT /systemreport/{uuid}
PATCH
PATCH /systemreport/{uuid}
DELETE
DELETE /systemreport/{uuid}