REST API - list

esx settings clusters software drafts software effective components: list

Returns the components that comprise the desired software state of the cluster.

Request:

HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/effective-components

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.
draft string Identifier of the working copy document.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "obj-103"{
        "details"{
            "note"{
                "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"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "overridden_components"[
                {
                    "note"{
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "display_version""string",
                    "source""BASE_IMAGE",
                    "version""string"
                },
                {
                    "note"{
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "display_version""string",
                    "source""BASE_IMAGE",
                    "version""string"
                }
            ],
            "display_version""string",
            "vendor""string",
            "source""BASE_IMAGE",
            "display_name""string"
        },
        "version""string"
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- object Map of effective components keyed by their identifier.Object with element values of type effective_component_info.
-.* effective_component_info
-.*.version string Version of the component.

-.*.details effective_component_details Details about the effective component.

Optional. unset if component is not present in the depot.

-.*.details.display_name string Display name of the component.

-.*.details.display_version string Human readable version of the component.

-.*.details.vendor string Vendor of the component.

-.*.details.source string Final effective source of the component.

Contains the component's source information. Value is one of:
BASE_IMAGE: Base image is the source for this component
ADD_ON: Addon is the source for this component
USER: User is the source for this component
SOLUTION: Solution is the source for this component
HARDWARE_SUPPORT_PACKAGE: Hardware Support Package (HSP) is the source for this component

-.*.details.note localizable_message Note assosicated with this component.

Optional. If unset, note is present for this component.

-.*.details.note.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

-.*.details.note.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

-.*.details.note.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

Errors:

HTTP Status Code Type Description
500 error If there is unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster or no draft associated with draft in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.