esx settings clusters software recommendations: info

The info structure defines the information about the most recent recommendation generation result.

Representation:

{
    "latest_recommendation"{
        "hardware_support"{
            "packages"{
                "obj-103"{
                    "pkg""obj-103",
                    "version""string"
                }
            }
        },
        "components"{
            "obj-103"{
                "details"{
                    "vendor""string",
                    "display_version""string",
                    "display_name""string"
                },
                "version""string"
            }
        },
        "base_image"{
            "details"{
                "release_date""2015-01-01T22:13:05.651Z",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        },
        "solutions"{
            "obj-103"{
                "components"[
                    {
                        "component""obj-103"
                    },
                    {
                        "component""obj-103"
                    }
                ],
                "details"{
                    "components"[
                        {
                            "component""obj-103",
                            "display_version""string",
                            "vendor""string",
                            "display_name""string"
                        },
                        {
                            "component""obj-103",
                            "display_version""string",
                            "vendor""string",
                            "display_name""string"
                        }
                    ],
                    "display_version""string",
                    "display_name""string"
                },
                "version""string"
            }
        },
        "add_on"{
            "name""string",
            "details"{
                "vendor""string",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        }
    },
    "current_series_recommendation"{
        "hardware_support"{
            "packages"{
                "obj-103"{
                    "pkg""obj-103",
                    "version""string"
                }
            }
        },
        "components"{
            "obj-103"{
                "details"{
                    "vendor""string",
                    "display_version""string",
                    "display_name""string"
                },
                "version""string"
            }
        },
        "base_image"{
            "details"{
                "release_date""2015-01-01T22:13:05.651Z",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        },
        "solutions"{
            "obj-103"{
                "components"[
                    {
                        "component""obj-103"
                    },
                    {
                        "component""obj-103"
                    }
                ],
                "details"{
                    "components"[
                        {
                            "component""obj-103",
                            "display_version""string",
                            "vendor""string",
                            "display_name""string"
                        },
                        {
                            "component""obj-103",
                            "display_version""string",
                            "vendor""string",
                            "display_name""string"
                        }
                    ],
                    "display_version""string",
                    "display_name""string"
                },
                "version""string"
            }
        },
        "add_on"{
            "name""string",
            "details"{
                "vendor""string",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        }
    },
    "base_image_explanation_details"[
        {
            "display_version""string",
            "display_name""string",
            "explanation"[
                {
                    "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"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "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",
            "display_name""string",
            "explanation"[
                {
                    "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"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "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"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        }
    ],
    "specified_base_image_version_recommendation"{
        "hardware_support"{
            "packages"{
                "obj-103"{
                    "pkg""obj-103",
                    "version""string"
                }
            }
        },
        "components"{
            "obj-103"{
                "details"{
                    "vendor""string",
                    "display_version""string",
                    "display_name""string"
                },
                "version""string"
            }
        },
        "base_image"{
            "details"{
                "release_date""2015-01-01T22:13:05.651Z",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        },
        "solutions"{
            "obj-103"{
                "components"[
                    {
                        "component""obj-103"
                    },
                    {
                        "component""obj-103"
                    }
                ],
                "details"{
                    "components"[
                        {
                            "component""obj-103",
                            "display_version""string",
                            "vendor""string",
                            "display_name""string"
                        },
                        {
                            "component""obj-103",
                            "display_version""string",
                            "vendor""string",
                            "display_name""string"
                        }
                    ],
                    "display_version""string",
                    "display_name""string"
                },
                "version""string"
            }
        },
        "add_on"{
            "name""string",
            "details"{
                "vendor""string",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        }
    },
    "check_time""2015-01-01T22:13:05.651Z"
}
{
    "latest_recommendation"{
        "hardware_support"{
            "packages"[
                {
                    "value"{
                        "pkg""obj-103",
                        "version""string"
                    },
                    "key""obj-103"
                }
            ]
        },
        "components"[
            {
                "value"{
                    "details"{
                        "vendor""string",
                        "display_version""string",
                        "display_name""string"
                    },
                    "version""string"
                },
                "key""obj-103"
            }
        ],
        "base_image"{
            "details"{
                "release_date""2015-01-01T22:13:05.651Z",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        },
        "solutions"[
            {
                "value"{
                    "components"[
                        {
                            "component""obj-103"
                        },
                        {
                            "component""obj-103"
                        }
                    ],
                    "details"{
                        "components"[
                            {
                                "component""obj-103",
                                "display_version""string",
                                "vendor""string",
                                "display_name""string"
                            },
                            {
                                "component""obj-103",
                                "display_version""string",
                                "vendor""string",
                                "display_name""string"
                            }
                        ],
                        "display_version""string",
                        "display_name""string"
                    },
                    "version""string"
                },
                "key""obj-103"
            }
        ],
        "add_on"{
            "name""string",
            "details"{
                "vendor""string",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        }
    },
    "current_series_recommendation"{
        "hardware_support"{
            "packages"[
                {
                    "value"{
                        "pkg""obj-103",
                        "version""string"
                    },
                    "key""obj-103"
                }
            ]
        },
        "components"[
            {
                "value"{
                    "details"{
                        "vendor""string",
                        "display_version""string",
                        "display_name""string"
                    },
                    "version""string"
                },
                "key""obj-103"
            }
        ],
        "base_image"{
            "details"{
                "release_date""2015-01-01T22:13:05.651Z",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        },
        "solutions"[
            {
                "value"{
                    "components"[
                        {
                            "component""obj-103"
                        },
                        {
                            "component""obj-103"
                        }
                    ],
                    "details"{
                        "components"[
                            {
                                "component""obj-103",
                                "display_version""string",
                                "vendor""string",
                                "display_name""string"
                            },
                            {
                                "component""obj-103",
                                "display_version""string",
                                "vendor""string",
                                "display_name""string"
                            }
                        ],
                        "display_version""string",
                        "display_name""string"
                    },
                    "version""string"
                },
                "key""obj-103"
            }
        ],
        "add_on"{
            "name""string",
            "details"{
                "vendor""string",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        }
    },
    "base_image_explanation_details"[
        {
            "display_version""string",
            "display_name""string",
            "explanation"[
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                },
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                }
            ]
        },
        {
            "display_version""string",
            "display_name""string",
            "explanation"[
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                },
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                }
            ]
        }
    ],
    "specified_base_image_version_recommendation"{
        "hardware_support"{
            "packages"[
                {
                    "value"{
                        "pkg""obj-103",
                        "version""string"
                    },
                    "key""obj-103"
                }
            ]
        },
        "components"[
            {
                "value"{
                    "details"{
                        "vendor""string",
                        "display_version""string",
                        "display_name""string"
                    },
                    "version""string"
                },
                "key""obj-103"
            }
        ],
        "base_image"{
            "details"{
                "release_date""2015-01-01T22:13:05.651Z",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        },
        "solutions"[
            {
                "value"{
                    "components"[
                        {
                            "component""obj-103"
                        },
                        {
                            "component""obj-103"
                        }
                    ],
                    "details"{
                        "components"[
                            {
                                "component""obj-103",
                                "display_version""string",
                                "vendor""string",
                                "display_name""string"
                            },
                            {
                                "component""obj-103",
                                "display_version""string",
                                "vendor""string",
                                "display_name""string"
                            }
                        ],
                        "display_version""string",
                        "display_name""string"
                    },
                    "version""string"
                },
                "key""obj-103"
            }
        ],
        "add_on"{
            "name""string",
            "details"{
                "vendor""string",
                "display_version""string",
                "display_name""string"
            },
            "version""string"
        }
    },
    "check_time""2015-01-01T22:13:05.651Z"
}

Attributes:

Name Type Description
Required
-.latest_recommendation.base_image base_image_info Base image of the ESX.

-.latest_recommendation.base_image.details.display_name string Display name of the base-image.

-.latest_recommendation.base_image.details.display_version string Human readable version of the base-image.

-.latest_recommendation.base_image.details.release_date date_time Release date of the base-image.

-.latest_recommendation.base_image.version string Version of the base-image

-.latest_recommendation.add_on.details.display_name string Display name of the OEM add-on.

-.latest_recommendation.add_on.details.vendor string Vendor of the OEM add-on.

-.latest_recommendation.add_on.details.display_version string Human readable version of the OEM add-on.

-.latest_recommendation.add_on.name string Name of the add-on

-.latest_recommendation.add_on.version string Version of the add-on

-.latest_recommendation.components object Information about the components in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.component.Object with element values of type component_info.

-.latest_recommendation.components.* component_info
-.latest_recommendation.solutions object Information about the solutions in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.solution.Object with element values of type solution_info.

-.latest_recommendation.hardware_support.packages object Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) identifier and the value is the specification detailing the HSP configured for that HSM.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.Object with element values of type hardware_support_package_info.

-.current_series_recommendation.base_image base_image_info Base image of the ESX.

-.current_series_recommendation.base_image.details.display_name string Display name of the base-image.

-.current_series_recommendation.base_image.details.display_version string Human readable version of the base-image.

-.current_series_recommendation.base_image.details.release_date date_time Release date of the base-image.

-.current_series_recommendation.base_image.version string Version of the base-image

-.current_series_recommendation.add_on.details.display_name string Display name of the OEM add-on.

-.current_series_recommendation.add_on.details.vendor string Vendor of the OEM add-on.

-.current_series_recommendation.add_on.details.display_version string Human readable version of the OEM add-on.

-.current_series_recommendation.add_on.name string Name of the add-on

-.current_series_recommendation.add_on.version string Version of the add-on

-.current_series_recommendation.components object Information about the components in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.component.Object with element values of type component_info.

-.current_series_recommendation.solutions object Information about the solutions in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.solution.Object with element values of type solution_info.

-.current_series_recommendation.hardware_support.packages object Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) identifier and the value is the specification detailing the HSP configured for that HSM.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.Object with element values of type hardware_support_package_info.

-.specified_base_image_version_recommendation.base_image base_image_info Base image of the ESX.

-.specified_base_image_version_recommendation.base_image.details.display_name string Display name of the base-image.

-.specified_base_image_version_recommendation.base_image.details.display_version string Human readable version of the base-image.

-.specified_base_image_version_recommendation.base_image.details.release_date date_time Release date of the base-image.

-.specified_base_image_version_recommendation.base_image.version string Version of the base-image

-.specified_base_image_version_recommendation.add_on.details.display_name string Display name of the OEM add-on.

-.specified_base_image_version_recommendation.add_on.details.vendor string Vendor of the OEM add-on.

-.specified_base_image_version_recommendation.add_on.details.display_version string Human readable version of the OEM add-on.

-.specified_base_image_version_recommendation.add_on.name string Name of the add-on

-.specified_base_image_version_recommendation.add_on.version string Version of the add-on

-.specified_base_image_version_recommendation.components object Information about the components in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.component.Object with element values of type component_info.

-.specified_base_image_version_recommendation.solutions object Information about the solutions in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.solution.Object with element values of type solution_info.

-.specified_base_image_version_recommendation.hardware_support.packages object Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) identifier and the value is the specification detailing the HSP configured for that HSM.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.Object with element values of type hardware_support_package_info.

-.base_image_explanation_details explanation_details[] Details about why some base images are excluded in latest and current series recommendations. This is not applicable for specified base image recommendations.

Optional
-.latest_recommendation software_info Recommended image specification based on latest base image version.

Optional. unset if no recommended image based on latest base image version is available.

-.latest_recommendation.base_image.details base_image_details Details about the base-image.

Optional. unset if base-image is not present in the depot.

-.latest_recommendation.add_on add_on_info OEM customization on top of given base-image. The components in this customization override the components in the base base-image.

Optional. If unset, no OEM customization will be applied.

-.latest_recommendation.add_on.details add_on_details Details about the add-on.

Optional. unset if add-on is not present in the depot.

-.latest_recommendation.components.*.version string Version of the component.

Optional. unset if version is not specified.

-.latest_recommendation.hardware_support hardware_support_info Information about the Hardware Support Packages (HSP) configured.

Optional. If unset, no Hardware Support Package (HSP) is specified for the cluster.

-.current_series_recommendation software_info Recommended image specification based on latest base image patch or update of the current series.

Optional. unset if no recommended image based on latest base image patch or update of the current series is available.

-.current_series_recommendation.base_image.details base_image_details Details about the base-image.

Optional. unset if base-image is not present in the depot.

-.current_series_recommendation.add_on add_on_info OEM customization on top of given base-image. The components in this customization override the components in the base base-image.

Optional. If unset, no OEM customization will be applied.

-.current_series_recommendation.add_on.details add_on_details Details about the add-on.

Optional. unset if add-on is not present in the depot.

-.current_series_recommendation.hardware_support hardware_support_info Information about the Hardware Support Packages (HSP) configured.

Optional. If unset, no Hardware Support Package (HSP) is specified for the cluster.

-.specified_base_image_version_recommendation software_info Recommended image specification based on a specified base image version. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. unset if no recommendation image based on the specified base image version is available.

-.specified_base_image_version_recommendation.base_image.details base_image_details Details about the base-image.

Optional. unset if base-image is not present in the depot.

-.specified_base_image_version_recommendation.add_on add_on_info OEM customization on top of given base-image. The components in this customization override the components in the base base-image.

Optional. If unset, no OEM customization will be applied.

-.specified_base_image_version_recommendation.add_on.details add_on_details Details about the add-on.

Optional. unset if add-on is not present in the depot.

-.specified_base_image_version_recommendation.hardware_support hardware_support_info Information about the Hardware Support Packages (HSP) configured.

Optional. If unset, no Hardware Support Package (HSP) is specified for the cluster.

-.check_time date_time The most recent timestamp when check for recommended image is launched.

Optional. unset if no recommendation check has ever been launched.