REST API - get

esx settings clusters software reports apply impact: get

Returns a summary of how hosts within the cluster will be impacted during an apply operation. The impact is generated from the compliance information obtained from get

Request:

HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/reports/apply-impact

?hosts={value-1}
&hosts={value-2}

Path Parameters

Name Type Description
Required
cluster string The cluster identifier.

Query Parameters:

Name Type Description
bold = required
hosts string[] The specific hosts for which an impact is to be generated.

Optional. if unset or empty impact is generated for all hosts within the cluster.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "host_impact"{
        "obj-103"[
            {
                "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"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "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"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ]
    },
    "impact"[
        {
            "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"{}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        {
            "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"{}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    ],
    "commit""obj-103",
    "host_info"{
        "obj-103"{
            "name""string"
        }
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- cluster_impact Summary of how hosts will be impacted during an apply operation.
-.impact impact[] Impact of steps performed during the setup and cleanup phase of the apply operation.

-.impact[].message localizable_message Description of the impact.

-.impact[].message.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.

-.impact[].message.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.

-.impact[].message.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.

-.host_impact object Impact summary for each host within the clsuter.

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: HostSystem. 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: HostSystem.Object with element values of type impact[].

-.commit string Identifier of the commit on which the impact is generated.

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

-.host_info object Information of hosts within the cluster.

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: HostSystem. 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: HostSystem.Object with element values of type host_info.

Errors:

HTTP Status Code Type Description
500 error If there is an 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 in the system.
503 service_unavailable If the service is not available.
401 unauthenticated if the caller is not authenticated.