NSX Advanced Load Balancer 22.1.6 supports System Reports for every upgrade operation with the summary of the operation performed and pre-check results from the operation.
A system report is generated for every upgrade operation, the report contains summary of the operation performed and precheck results from the operation. Unlike the pre-checks tied to upgradestatusinfo, system report object is retained over multiple iterations.
A system report is generated for every upgrade operation, the report contains summary of the operation performed and precheck results from the operation. Unlike the pre-checks tied to upgradestatusinfo, system report object is retained over multiple iterations.
System Report can be viewed and downloaded from NSX Advanced Load Balancer CLI. Login to NSX Advanced Load Balancer controller and use the show systemreport # Prints Summary command.
Command: show systemreport [<report-name> [export]]
Options:
Default - List all available report.
Example: show systemreport
name:
Show details of specified report.
Ex: show systemreport upgrade_system_20231108-142156
export
Export the report to specified path. [Downloads the full report]
Ex: show systemreport upgrade_system_20231108-142156 export
Below is a sample output for generating a system report for NSX Advanced Load Balancer Controller.
[admin:100-65-10-137]: > upgrade controller image_ref 30.2.1-8143-20240115.080016 prechecks_only Previewing upgrade +-------------+-----------------------------------------------------------------------------------------+ | Field | Value | +-------------+-----------------------------------------------------------------------------------------+ | status_code | SYSERR_UPGRADE_OPS_PREVIEW_RESPONSE | | status | Checks preview for upgrade operations. | | checks | | | | 'Checking Controller Cluster readiness for upgrade operations.' | | | 'Check if upgrade operation is already in progress.' | | | 'Checking active versions compatibility for upgrade operations.' | | | 'Checking if system in Avi-ESSENTIALS/BASIC mode and allows only permitted operations.' | | | 'Checking if the cloud api versions are compatible after upgrade.' | | | 'Checking ServiceEngineGroup has an ongoing upgrade operation.' | | | 'Checking Controller Cluster disk space for upgrade operations.' | | | 'Checking image version compatibility for upgrade operations.' | | | 'Checking idempotent operations for upgrade operations.' | | | 'Checking Image state across Cluster members for upgrade operations.' | | | 'Checking the system configuration.' | | | 'Checking config migration.' | | | 'Checking if Gslb Maintenance Mode is enabled prior to upgrade.' | | | 'Checking if Gslb Feature is enabled and provides feature specific messages.' | | | 'Checking and inform user to take a backup prior to upgrade operations.' | | | 'Checking if Docker version is compatible.' | | | 'Checking for the mandatory patch in image bundle.' | | | 'Checking if configured IP type is DHCP or STATIC.' | | | 'Checking if se linux is enabled on controller nodes.' | | | 'Checking total number of alerts for upgrade operations.' | +-------------+-----------------------------------------------------------------------------------------+ Starting upgrade +--------------------+------------------------------------------------------------------------------------------------+ | Field | Value | +--------------------+------------------------------------------------------------------------------------------------+ | status_code | SYSERR_EVAL_UPGRADE_CONTROLLER_STARTED | | status | 'Pre-checks for Upgrade of Controller started. Use 'show upgrade status' to check the status.' | | system_report_uuid | systemreport-6f499bff-fcbd-4fca-a43a-483d1764eed5 | +--------------------+------------------------------------------------------------------------------------------------+ [admin:100-65-10-137]: > show systemreport +--------------------------------+---------------------------------------------------+---------------------------+-----------------------------+ | Name | UUID | State | Image | +--------------------------------+---------------------------------------------------+---------------------------+-----------------------------+ | upgrade_controller_checks_f345 | systemreport-6f499bff-fcbd-4fca-a43a-483d1764eed5 | UPGRADE_PRE_CHECK_WARNING | 30.2.1-8143-20240115.080016 | +--------------------------------+---------------------------------------------------+---------------------------+-----------------------------+ [admin:100-65-10-137]: > show systemreport upgrade_controller_checks_f345 +-------------------------+----------------------------------------------------------------------------------+ | Field | Value | +-------------------------+----------------------------------------------------------------------------------+ | uuid | systemreport-6f499bff-fcbd-4fca-a43a-483d1764eed5 | | name | upgrade_controller_checks_f345 | | tenant_ref | admin | | image_ref | 30.2.1-8143-20240115.080016 | | archive_ref | report://upgrade_controller_checks_f345.tar.gz | | state | | | state | UPGRADE_PRE_CHECK_WARNING | | last_changed_time | Tue Jan 16 09:02:02 2024 ms(167792166) UTC | | summary | | | name | Prechecks for Controller Upgrade | | description | System evaluation report to perform Controller Upgrade from 22.1.6 to 30.2.1 | | previews[1] | 'Checking Controller Cluster readiness for upgrade operations.' | | previews[2] | 'Check if upgrade operation is already in progress.' | | previews[3] | 'Checking ServiceEngineGroup error recovery options prior to upgrade operations. | | | ' | | previews[4] | 'Checking active versions compatibility for upgrade operations.' | | previews[5] | 'Checking if system in Avi-ESSENTIALS/BASIC mode and allows only permitted opera | | | tions.' | | previews[6] | 'Checking if the cloud api versions are compatible after upgrade.' | | previews[7] | 'Checking ServiceEngineGroup has an ongoing upgrade operation.' | | previews[8] | 'Checking Controller Cluster disk space for upgrade operations.' | | previews[9] | 'Checking image version compatibility for upgrade operations.' | | previews[10] | 'Checking idempotent operations for upgrade operations.' | | previews[11] | 'Checking Image state across Cluster members for upgrade operations.' | | previews[12] | 'Checking the system configuration.' | | previews[13] | 'Checking Patch compatibility for Controller patch operations.' | | previews[14] | 'Checking config migration.' | | previews[15] | 'Checking and inform user to take a backup prior to upgrade operations.' | | previews[16] | 'Checking if Docker version is compatible.' | | previews[17] | 'Checking for the patch in image bundle.' | | previews[18] | 'Checking if configured IP type is DHCP or STATIC.' | | previews[19] | 'Checking if Gslb Feature is enabled and provides feature specific messages.' | | previews[20] | 'Checking if se linux is enabled on controller nodes.' | | previews[21] | 'Checking total number of alerts for upgrade operations.' | | readiness_reports[1] | | | node_ref | cluster-0-1 | | name | cluster-0-1 | | node_type | NODE_CONTROLLER_CLUSTER | | system_readiness | | | state | | | state | UPGRADE_PRE_CHECK_WARNING | | last_changed_time | Tue Jan 16 09:02:02 2024 ms(165028028) UTC | | checks[1] | | | check_code | SYSERR_CHECK_CLUSTER_STATE | | description | 'Checking Controller Cluster readiness for upgrade operations.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[2] | | | check_code | SYSERR_CHECK_ACTIVE_VERSIONS | | description | 'Checking active versions compatibility for upgrade operations.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[3] | | | check_code | SYSERR_CHECK_SE_GROUP_ERROR_RECOVERY | | description | 'Checking ServiceEngineGroup error recovery options prior to upgrade operations. | | | ' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[4] | | | check_code | SYSERR_AVI_ESSENTIALS_CHECK | | description | 'Checking if system in Avi-ESSENTIALS/BASIC mode and allows only permitted opera | | | tions.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[5] | | | check_code | SYSERR_CHECK_CLOUD_COMPATIBILITY | | description | 'Checking if the cloud api versions are compatible after upgrade.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[6] | | | check_code | SYSERR_CHECK_SE_GROUP_UPGRADE_OPS_INPROGRESS | | description | 'Checking ServiceEngineGroup has an ongoing upgrade operation.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[7] | | | check_code | SYSERR_CHECK_VERSION_COMPATIBILITY | | description | 'Checking image version compatibility for upgrade operations.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[8] | | | check_code | SYSERR_CHECK_IMAGE_VERSION | | description | 'Checking idempotent operations for upgrade operations.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[9] | | | check_code | SYSERR_CHECK_IMAGE_COMPATIBILITY | | description | 'Checking Image state across Cluster members for upgrade operations.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[10] | | | check_code | SYSERR_CHECK_CONTROLLER_PATCH_COMPATIBILITY | | description | 'Checking Patch compatibility for Controller patch operations.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[11] | | | check_code | SYSERR_CONFIGURATION_CHECK | | description | 'Checking the system configuration.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[12] | | | check_code | SYSERR_MC_BACKUP_ERR | | description | Inform User to take configuration backup prior to upgrade operations. | | details[1] | Please take the backup before starting the upgrade operations. | | state | UPGRADE_PRE_CHECK_WARNING | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:58 | | duration | 0 sec | | checks[13] | | | check_code | SYSERR_DOCKER_VERSION_CHECK | | description | 'Checking if Docker version is compatible.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:59 | | duration | 0 sec | | checks[14] | | | check_code | SYSERR_CHECK_PATCH_IMAGE | | description | 'Checking for the patch in image bundle.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:59 | | end_time | 2024-01-16 09:01:59 | | duration | 0 sec | | checks[15] | | | check_code | SYSERR_IP_TYPE_CHECK | | description | 'Checking if configured IP type is DHCP or STATIC.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:59 | | end_time | 2024-01-16 09:01:59 | | duration | 0 sec | | checks[16] | | | check_code | SYSERR_GSLB_FEATURE_CHECK | | description | 'Checking if Gslb Feature is enabled and provides feature specific messages.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:59 | | end_time | 2024-01-16 09:01:59 | | duration | 0 sec | | checks[17] | | | check_code | SYSERR_CHECK_SE_LINUX_ENABLED | | description | 'Checking if se linux is enabled on controller nodes.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:59 | | end_time | 2024-01-16 09:01:59 | | duration | 0 sec | | checks[18] | | | check_code | SYSERR_CHECK_ALERTS | | description | 'Checking total number of alerts for upgrade operations.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:59 | | end_time | 2024-01-16 09:01:59 | | duration | 0 sec | | checks[19] | | | check_code | SYSERR_CHECK_CLUSTER_DISK_SPACE | | description | 'Checking Controller Cluster disk space for upgrade operations.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:01:59 | | duration | 0 sec | | checks[20] | | | check_code | SYSERR_UPGRADE_OPS_IN_PROGRESS | | description | 'Check if upgrade operation is already in progress.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:02:01 | | duration | 2 sec | | checks[21] | | | check_code | SYSERR_CONFIG_CHECK | | description | 'Checking config migration.' | | state | UPGRADE_PRE_CHECK_SUCCESS | | start_time | 2024-01-16 09:01:58 | | end_time | 2024-01-16 09:02:02 | | duration | 3 sec | | start_time | 2024-01-16 09:01:48 | | end_time | 2024-01-16 09:02:02 | | duration | 13 sec | | upgrade_ops | EVAL_UPGRADE | | image_ref | 30.2.1-8143-20240115.080016 | | total_checks | 21 | | checks_completed | 21 | +-------------------------+----------------------------------------------------------------------------------+ [admin:100-65-10-137]: > show systemreport upgrade_controller_checks_f345 <CR> show the object export download report [admin:100-65-10-137]: > show systemreport upgrade_controller_checks_f345 export Downloaded the attachment to /tmp/upgrade_controller_checks_f345.tar.gz [admin:100-65-10-137]: > [admin:100-65-8-89]: > show systemreport +--------------------------------+---------------------+--------------------------+ | Name | State | Timestamp | +--------------------------------+---------------------+--------------------------+ | upgrade_controller_checks_8ec5 | SYSTEM_REPORT_ERROR | Wed Feb 21 2024 12:49:08 | | upgrade_controller_checks_67a0 | SYSTEM_REPORT_ERROR | Tue Feb 27 2024 04:59:28 | | upgrade_controller_checks_d3f0 | SYSTEM_REPORT_ERROR | Tue Feb 27 2024 05:05:47 | | upgrade_controller_checks_169b | SYSTEM_REPORT_ERROR | Tue Feb 27 2024 05:08:10 | | upgrade_controller_checks_601c | SYSTEM_REPORT_ERROR | Wed Feb 28 2024 08:46:55 | +--------------------------------+---------------------+--------------------------+ [admin:100-65-8-89]: > delete systemreport upgrade_controller_checks_8ec5 Successfully deleted upgrade_controller_checks_8ec5. [admin:100-65-8-89]: > show systemreport +--------------------------------+---------------------+--------------------------+ | Name | State | Timestamp | +--------------------------------+---------------------+--------------------------+ | upgrade_controller_checks_67a0 | SYSTEM_REPORT_ERROR | Tue Feb 27 2024 04:59:28 | | upgrade_controller_checks_d3f0 | SYSTEM_REPORT_ERROR | Tue Feb 27 2024 05:05:47 | | upgrade_controller_checks_169b | SYSTEM_REPORT_ERROR | Tue Feb 27 2024 05:08:10 | | upgrade_controller_checks_601c | SYSTEM_REPORT_ERROR | Wed Feb 28 2024 08:46:55 | +--------------------------------+---------------------+--------------------------+ [admin:100-65-8-89]: >
Note:
A periodic cleanup is performed to keep the count within the threshold every hour by default. The interval is configurable via system_report_cleanup_interval in Controller properties.
