REST API - get

appliance vcenter settings v1 config last check result: get

Returns the last check results of the profile. Results will be persisted in cache maximum 5 mins. After that user need to call the check api for the check results. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/appliance/vcenter/settings/v1/config/last-check-result

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "valid"[
        "obj-103",
        "obj-103"
    ],
    "start_time""2015-01-01T22:13:05.651Z",
    "impact"{
        "system_services"[
            "string",
            "string"
        ],
        "vcenter_services"[
            "string",
            "string"
        ],
        "apply_impact""NO_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"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "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"{}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ],
        "notifications"{
            "warnings"[
                {
                    "notification""obj-103",
                    "time""2015-01-01T22:13:05.651Z",
                    "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "resolution"{
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "notification""obj-103",
                    "time""2015-01-01T22:13:05.651Z",
                    "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "resolution"{
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ],
            "errors"[
                {
                    "notification""obj-103",
                    "time""2015-01-01T22:13:05.651Z",
                    "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "resolution"{
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "notification""obj-103",
                    "time""2015-01-01T22:13:05.651Z",
                    "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "resolution"{
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ],
            "info"[
                {
                    "notification""obj-103",
                    "time""2015-01-01T22:13:05.651Z",
                    "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "resolution"{
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "notification""obj-103",
                    "time""2015-01-01T22:13:05.651Z",
                    "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "resolution"{
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        "status""VALID"
    },
    "profile""obj-103",
    "end_time""2015-01-01T22:13:05.651Z",
    "invalid"[
        "obj-103",
        "obj-103"
    ],
    "version""obj-103"
}

Headers:

None

Type:

Name Type Description
bold = required
- check_result Profile check result.
-.impact impact Overall Impact. 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.

-.impact.apply_impact string Impact to the vCenter if the profile is applied. 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.

Contains information about the impact of applying the target state. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
NO_IMPACT: Appliance has no impact. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
REBOOT_REQUIRED: Appliance requires reboot to reach this target state. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
RESTART_SERVICE: To reach the target state appliance requires services to restart. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.impact.vcenter_services string[] List of the vCenter services to be restarted. 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. It is only relevant when apply_impact has value [RESTART_SERVICE]. If unset there no impact on system.

-.impact.system_services string[] List of the System services to be restarted. 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. It is only relevant when apply_impact has value [RESTART_SERVICE]. If unset there no impact on system.

-.impact.message localizable_message[] Description of the impact. 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.

-.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.

-.impact.status string Validation status of the appliance. 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.

Defines possible values of profile status. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
VALID: Profile configuration is valid. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
INVALID: Profile Configuration is invalid. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.impact.notifications notifications Notifications returned by the validation operation. 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.

-.impact.notifications.info notification[] Info notification messages reported. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Optional. Only set if an info was reported by the task.

-.impact.notifications.warnings notification[] Warning notification messages reported. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Optional. Only set if an warning was reported by the task.

-.impact.notifications.errors notification[] Error notification messages reported. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Optional. Only set if an error was reported by the task.

-.start_time date_time Time when the operation started. 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.

-.end_time date_time Time when the operation completed. 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. If unset, the endTime will be empty.

-.profile string Identifier of the profile on which the prechek is run to generate this result. 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.

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

-.version string The version of the profile. 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.

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

-.valid string[] Identifiers of the valid components. 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.

When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component.

-.invalid string[] Identifiers of the Invalid components. 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.

When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component.

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 profile associated with profile in the system or if the validation information is unavailable.
503 service_unavailable If the service is not available.
401 unauthenticated if the caller is not authenticated.