Esx Settings Repository Software get

Esx Settings Repository Software get

Returns the details of a software specification in the repository.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URI
GET
https://{api_host}/api/esx/settings/repository/software/{softwareSpec}
COPY
Path Parameters
string
softwareSpec
Required

The identifier of the software specification in the repository.

The parameter must be an identifier for the resource type: com.vmware.esx.settings.repository.software_spec.


Authentication
This operation uses the following authentication methods.
Responses
200

Information about the software specification.

Returns Esx Settings Repository Software Info of type(s) application/json
{
    "display_name": "string",
    "type": "string",
    "software_info": {
        "base_image": {
            "details": {
                "display_name": "string",
                "display_version": "string",
                "release_date": "string",
                "quick_patch_compatible_versions": {
                    "quick_patch_compatible_versions": "string"
                }
            },
            "version": "string"
        },
        "add_on": {
            "details": {
                "display_name": "string",
                "vendor": "string",
                "display_version": "string"
            },
            "name": "string",
            "version": "string"
        },
        "components": {
            "components": {
                "version": "string",
                "details": {
                    "display_name": "string",
                    "vendor": "string",
                    "display_version": "string"
                }
            }
        },
        "solutions": {
            "solutions": {
                "details": {
                    "display_name": "string",
                    "display_version": "string",
                    "components": [
                        {
                            "component": "string",
                            "display_name": "string",
                            "display_version": "string",
                            "vendor": "string"
                        }
                    ]
                },
                "version": "string",
                "components": [
                    {
                        "component": "string"
                    }
                ]
            }
        },
        "hardware_support": {
            "packages": {
                "packages": {
                    "pkg": "string",
                    "version": "string"
                }
            }
        },
        "removed_components": {
            "removed_components": {
                "version": "string",
                "details": {
                    "display_name": "string",
                    "vendor": "string",
                    "display_version": "string"
                }
            }
        },
        "alternative_images": {
            "alternative_images": {
                "base_image": {
                    "details": {
                        "display_name": "string",
                        "display_version": "string",
                        "release_date": "string",
                        "quick_patch_compatible_versions": {
                            "quick_patch_compatible_versions": "string"
                        }
                    },
                    "version": "string"
                },
                "add_on": {
                    "details": {
                        "display_name": "string",
                        "vendor": "string",
                        "display_version": "string"
                    },
                    "name": "string",
                    "version": "string"
                },
                "components": {
                    "components": {
                        "version": "string",
                        "details": {
                            "display_name": "string",
                            "vendor": "string",
                            "display_version": "string"
                        }
                    }
                },
                "solutions": {
                    "solutions": {
                        "details": {
                            "display_name": "string",
                            "display_version": "string",
                            "components": [
                                {
                                    "component": "string",
                                    "display_name": "string",
                                    "display_version": "string",
                                    "vendor": "string"
                                }
                            ]
                        },
                        "version": "string",
                        "components": [
                            {
                                "component": "string"
                            }
                        ]
                    }
                },
                "hardware_support": {
                    "packages": {
                        "packages": {
                            "pkg": "string",
                            "version": "string"
                        }
                    }
                },
                "removed_components": {
                    "removed_components": {
                        "version": "string",
                        "details": {
                            "display_name": "string",
                            "vendor": "string",
                            "display_version": "string"
                        }
                    }
                },
                "display_name": "string",
                "selection_criteria": {
                    "selection_type": "string",
                    "host_uuids": [
                        "string"
                    ],
                    "host_hardware_spec": {
                        "vendor": "string",
                        "models": [
                            "string"
                        ],
                        "families": [
                            "string"
                        ],
                        "oem_strings": [
                            "string"
                        ]
                    }
                }
            }
        }
    },
    "software_spec": {
        "base_image": {
            "version": "string"
        },
        "add_on": {
            "name": "string",
            "version": "string"
        },
        "components": {
            "components": "string"
        },
        "solutions": {
            "solutions": {
                "version": "string",
                "components": [
                    {
                        "component": "string"
                    }
                ]
            }
        },
        "hardware_support": {
            "packages": {
                "packages": {
                    "pkg": "string",
                    "version": "string"
                }
            }
        },
        "removed_components": [
            "string"
        ],
        "alternative_images": {
            "alternative_images": {
                "base_image": {
                    "version": "string"
                },
                "add_on": {
                    "name": "string",
                    "version": "string"
                },
                "components": {
                    "components": "string"
                },
                "solutions": {
                    "solutions": {
                        "version": "string",
                        "components": [
                            {
                                "component": "string"
                            }
                        ]
                    }
                },
                "hardware_support": {
                    "packages": {
                        "packages": {
                            "pkg": "string",
                            "version": "string"
                        }
                    }
                },
                "removed_components": [
                    "string"
                ],
                "display_name": "string",
                "selection_criteria": {
                    "selection_type": "string",
                    "host_uuids": [
                        "string"
                    ],
                    "host_hardware_spec": {
                        "vendor": "string",
                        "models": [
                            "string"
                        ],
                        "families": [
                            "string"
                        ],
                        "oem_strings": [
                            "string"
                        ]
                    }
                }
            }
        }
    },
    "assigned_entities": {
        "clusters": [
            {
                "id": "string",
                "name": "string"
            }
        ],
        "hosts": [
            {
                "id": "string",
                "name": "string"
            }
        ]
    },
    "editable": false,
    "creation_time": "string",
    "modified_time": "string",
    "orchestrator_info": {
        "owner": "string",
        "owner_data": "string"
    }
}
string
display_name
Required

Display name of the software specification. The returned name is UTF-8 encoded.

This property was added in vSphere API 9.0.0.0.

string
type
Required

The software specification type (Single or Composite).

For more information see: Esx Settings Repository Software SoftwareType.

This property was added in vSphere API 9.0.0.0.

software_info
Required

Software information associated with the software specification.

This property was added in vSphere API 9.0.0.0.

software_spec
Required

Software specification details.

This property was added in vSphere API 9.0.0.0.

assigned_entities
Required

Entities that have this software specification assigned.

This property was added in vSphere API 9.0.0.0.

boolean
editable
Required

If set to true, this software specification can be edited.

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time
creation_time
Required

Timestamp describing when this software specification was created.

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time
modified_time
Required

Timestamp describing when this software specification was last modified. This timestamp is updated when the #update API is called or when a draft of this software specification is committed.

This property was added in vSphere API 9.0.0.0.

orchestrator_info
Optional

Orchestrator information of the software specification in the repository.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.


401

If the caller is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

If the caller does not have the necessary privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0
"Vapi Std Errors Unauthorized Object"

404

If there is no software specification associated with softwareSpec in the repository.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

500

If there is unknown internal error. The accompanying error message will give more details about the failure.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


503

If the service is not available.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/esx/settings/repository/software/{softwareSpec}