REST API - list

vcenter lcm update pending: list

Lists all available minor and major updates.

Request:

HTTP request

GET https://{server}/api/vcenter/lcm/update/pending

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "last_check_time""2015-01-01T22:13:05.651Z",
    "upgrade_count"1,
    "update_count"1,
    "updates"[
        {
            "severity""CRITICAL",
            "update_type""PATCH",
            "pending_update""obj-103",
            "release_notes"[
                "http://myurl.com",
                "http://myurl.com"
            ],
            "release_date""2015-01-01T22:13:05.651Z",
            "build""string",
            "reboot_required"true,
            "execute_URL""http://myurl.com",
            "category""SECURITY",
            "version""string"
        },
        {
            "severity""CRITICAL",
            "update_type""PATCH",
            "pending_update""obj-103",
            "release_notes"[
                "http://myurl.com",
                "http://myurl.com"
            ],
            "release_date""2015-01-01T22:13:05.651Z",
            "build""string",
            "reboot_required"true,
            "execute_URL""http://myurl.com",
            "category""SECURITY",
            "version""string"
        }
    ],
    "issues"{
        "warnings"[
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ],
        "errors"[
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ],
        "info"[
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ]
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- list_result Information about the pending patch/updates for the given vCenter server.
-.last_check_time date_time Time when the software depo was last checked.

-.update_count long Number of pending updates

Optional. Only set if there are available updates.

-.upgrade_count long Number of pending upgrades

Optional. Only set if there are available upgrades.

-.updates summary[] List of pending update details

-.updates[].pending_update string Identifier of the given vSphere update

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.lcm.update.pending. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.lcm.update.pending.

-.updates[].version string Version of the vSphere update or patch

-.updates[].release_date date_time Release date of the vSphere update or patch

-.updates[].severity string Severity of the issues fixed in the vSphere update or patch

Level of severity for applying a given patch or update. Value is one of:
CRITICAL: Vulnerabilities that can be exploited by an unauthenticated attacker from the Internet or those that break the guest/host Operating System isolation.
IMPORTANT: Vulnerabilities that are not rated critical but whose exploitation results in the complete compromise of confidentiality and/or integrity of user data and/or processing resources through user assistance or by authenticated attackers.
MODERATE: Vulnerabilities where the ability to exploit is mitigated to a significant degree by configuration or difficulty of exploitation, but in certain deployment scenarios could still lead to the compromise of confidentiality, integrity, or availability of user data and/or processing resources.
LOW: All other issues that may or maynot have a security impact. Vulnerabilities where exploitation is believed to be extremely difficult, or where successful exploitation would have minimal impact.

-.updates[].build string Build number of the vCenter Release

-.updates[].update_type string Type of the Release based on the current vCenter version

Defines update type Value is one of:
PATCH: Fixes bugs/vulnerabilities, doesn't change functionality
UPDATE: Changes product functionality
UPGRADE: Introduces new features, significantly changes product functionality

-.updates[].category string Category of the release based on features bundled on top of previous release

Defines the type of payload this release has on top of previous release Value is one of:
SECURITY: Fixes vulnerabilities, doesn't change functionality
FIX: Fixes bugs/vulnerabilities, doesn't change functionality
UPDATE: Changes product functionality
UPGRADE: Introduces new features, significantly changes product functionality

-.updates[].reboot_required boolean Flag to suggest a reboot after the release is applied

-.updates[].execute_URL URI VAMI or ISO URL for update or upgrade execute phase redirection

-.updates[].release_notes URI[] List of URI pointing to patch or update release notes

-.issues notifications Lists of issues encountered during pending updates retrieval.

Optional. set if any issues encountered.

-.issues.info notification[] Info notification messages reported.

Optional. Only set if an info was reported by the appliance task.

-.issues.warnings notification[] Warning notification messages reported.

Optional. Only set if an warning was reported by the appliance task.

-.issues.errors notification[] Error notification messages reported.

Optional. Only set if an error was reported by the appliance task.

Errors:

HTTP Status Code Type Description
401 unauthenticated if the user can not be authenticated.
500 error if there is some unknown internal error. The accompanying error message will give more details about the error.