Settings_Clusters_Configuration_ApplyResult

Settings_Clusters_Configuration_ApplyResult
Settings_Clusters_Configuration_ApplyResult

The Configuration.ApplyResult structure contains fields that describe the result of an Configuration.apply operation.

JSON Example
{
    "status": {
        "status": "string",
        "attempts": 0,
        "remaining_retries": 0,
        "start_time": "string",
        "end_time": "string",
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "commit": "string",
    "software_commit": "string",
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "host_status": {
        "host_status": {
            "status": "string",
            "attempts": 0,
            "remaining_retries": 0,
            "start_time": "string",
            "end_time": "string",
            "notifications": {
                "info": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ],
                "warnings": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ],
                "errors": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ]
            }
        }
    },
    "successful_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ]
}
status
Optional

The HostStatus structure contains fields that describe the status of an operation.

string
commit
Required

The identifier of the commit used to fetch the desired configuration document to be applied to all hosts within the cluster. 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.

string
software_commit
Required

The current commit ID for the software associated with the cluster. 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.

object
host_info
Required

Information of the hosts in this cluster to which the desired configuration document specified by the Configuration.ApplyResult.commit should be applied to. When clients pass a value of this structure as a parameter, the key in the field map 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 map will be an identifier for the resource type: HostSystem.

object
host_status
Required

Status of the hosts in this cluster to which the desired configuration specified by the Configuration.ApplyResult.commit was applied to. Hosts on which the Configuration.apply operation was successful are specified by Configuration.ApplyResult.successful-hosts. Hosts on which the apply operation failed are specified by Configuration.ApplyResult.failed-hosts. Hosts which were skipped by the Configuration.apply operation are specified by Configuration.ApplyResult.skipped-hosts. When clients pass a value of this structure as a parameter, the key in the field map 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 map will be an identifier for the resource type: HostSystem.

array of string
successful_hosts
Required

Hosts in this cluster to which the desired configuration specified by the Configuration.ApplyResult.commit has been successfully applied to. 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.

array of string
failed_hosts
Required

Hosts in this cluster to which the desired configuration specified by the Configuration.ApplyResult.commit failed to be applied. 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.

array of string
skipped_hosts
Required

Hosts in this cluster that were skipped by the Configuration.apply operation. 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.