Get Clusters Software Compliance

Returns the compliance state for the cluster if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Request

URL

GET

https://{api_host}/api/esx/settings/clusters/{cluster}/software/compliance

Copy

Path Parameters

string

cluster Required

Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Header Parameters

string

vmware-api-session-id Required

Required session ID, obtained by first calling Create Session API

vmware-api-session-id example

b00db39f948d13ea1e59b4d6fce56389

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

200 OK returns SettingsClusterCompliance of type application/json

Cluster compliance result.

{
	"commit": "string",
	"compliant_hosts": [
		"string"
	],
	"host_info": {
		"key": {
			"name": "string"
		}
	},
	"hosts": {
		"key": {
			"add_on": {
				"current": {
					"details": {
						"display_name": "string",
						"display_version": "string",
						"vendor": "string"
					},
					"name": "string",
					"version": "string"
				},
				"notifications": {
					"errors": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"originator": "string",
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"retriable": false,
							"time": "string",
							"type": "INFO"
						}
					],
					"info": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"originator": "string",
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"retriable": false,
							"time": "string",
							"type": "INFO"
						}
					],
					"warnings": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"originator": "string",
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"retriable": false,
							"time": "string",
							"type": "INFO"
						}
					]
				},
				"status": "COMPLIANT",
				"target": {
					"details": {
						"display_name": "string",
						"display_version": "string",
						"vendor": "string"
					},
					"name": "string",
					"version": "string"
				}
			},
			"base_image": {
				"current": {
					"details": {
						"display_name": "string",
						"display_version": "string",
						"release_date": "string"
					},
					"version": "string"
				},
				"notifications": {
					"errors": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"originator": "string",
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"retriable": false,
							"time": "string",
							"type": "INFO"
						}
					],
					"info": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"originator": "string",
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"retriable": false,
							"time": "string",
							"type": "INFO"
						}
					],
					"warnings": [
						{
							"id": "string",
							"message": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"originator": "string",
							"resolution": {
								"args": [
									"string"
								],
								"default_message": "string",
								"id": "string",
								"localized": "string",
								"params": {
									"key": {
										"d": 0,
										"dt": "string",
										"format": "SHORT_DATE",
										"i": 0,
										"l": {
											"id": "string",
											"params": "StdLocalizationParam Object"
										},
										"precision": 0,
										"s": "string"
									}
								}
							},
							"retriable": false,
							"time": "string",
							"type": "INFO"
						}
					]
				},
				"status": "COMPLIANT",
				"target": {
					"details": {
						"display_name": "string",
						"display_version": "string",
						"release_date": "string"
					},
					"version": "string"
				}
			},
			"commit": "string",
			"components": {
				"key": {
					"current": {
						"details": {
							"display_name": "string",
							"display_version": "string",
							"vendor": "string"
						},
						"version": "string"
					},
					"current_source": "BASE_IMAGE",
					"notifications": {
						"errors": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						],
						"info": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						],
						"warnings": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						]
					},
					"status": "COMPLIANT",
					"target": {
						"details": {
							"display_name": "string",
							"display_version": "string",
							"vendor": "string"
						},
						"version": "string"
					},
					"target_source": "BASE_IMAGE"
				}
			},
			"hardware_support": {
				"key": {
					"current": {
						"pkg": "string",
						"version": "string"
					},
					"hardware_modules": {
						"key": {
							"current": {
								"version": "string"
							},
							"details": {
								"component_class": "SYSTEM_BIOS",
								"description": "string"
							},
							"notifications": {
								"errors": [
									{
										"id": "string",
										"message": {
											"args": [
												"string"
											],
											"default_message": "string",
											"id": "string",
											"localized": "string",
											"params": {
												"key": {
													"d": 0,
													"dt": "string",
													"format": "SHORT_DATE",
													"i": 0,
													"l": {
														"Std_NestedLocalizableMessage": "Too large to render past this point..."
													},
													"precision": 0,
													"s": "string"
												}
											}
										},
										"originator": "string",
										"resolution": {
											"args": [
												"string"
											],
											"default_message": "string",
											"id": "string",
											"localized": "string",
											"params": {
												"key": {
													"d": 0,
													"dt": "string",
													"format": "SHORT_DATE",
													"i": 0,
													"l": {
														"Std_NestedLocalizableMessage": "Too large to render past this point..."
													},
													"precision": 0,
													"s": "string"
												}
											}
										},
										"retriable": false,
										"time": "string",
										"type": "INFO"
									}
								],
								"info": [
									{
										"id": "string",
										"message": {
											"args": [
												"string"
											],
											"default_message": "string",
											"id": "string",
											"localized": "string",
											"params": {
												"key": {
													"d": 0,
													"dt": "string",
													"format": "SHORT_DATE",
													"i": 0,
													"l": {
														"Std_NestedLocalizableMessage": "Too large to render past this point..."
													},
													"precision": 0,
													"s": "string"
												}
											}
										},
										"originator": "string",
										"resolution": {
											"args": [
												"string"
											],
											"default_message": "string",
											"id": "string",
											"localized": "string",
											"params": {
												"key": {
													"d": 0,
													"dt": "string",
													"format": "SHORT_DATE",
													"i": 0,
													"l": {
														"Std_NestedLocalizableMessage": "Too large to render past this point..."
													},
													"precision": 0,
													"s": "string"
												}
											}
										},
										"retriable": false,
										"time": "string",
										"type": "INFO"
									}
								],
								"warnings": [
									{
										"id": "string",
										"message": {
											"args": [
												"string"
											],
											"default_message": "string",
											"id": "string",
											"localized": "string",
											"params": {
												"key": {
													"d": 0,
													"dt": "string",
													"format": "SHORT_DATE",
													"i": 0,
													"l": {
														"Std_NestedLocalizableMessage": "Too large to render past this point..."
													},
													"precision": 0,
													"s": "string"
												}
											}
										},
										"originator": "string",
										"resolution": {
											"args": [
												"string"
											],
											"default_message": "string",
											"id": "string",
											"localized": "string",
											"params": {
												"key": {
													"d": 0,
													"dt": "string",
													"format": "SHORT_DATE",
													"i": 0,
													"l": {
														"Std_NestedLocalizableMessage": "Too large to render past this point..."
													},
													"precision": 0,
													"s": "string"
												}
											}
										},
										"retriable": false,
										"time": "string",
										"type": "INFO"
									}
								]
							},
							"status": "COMPLIANT",
							"target": {
								"version": "string"
							}
						}
					},
					"notifications": {
						"errors": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						],
						"info": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						],
						"warnings": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						]
					},
					"status": "COMPLIANT",
					"target": {
						"pkg": "string",
						"version": "string"
					}
				}
			},
			"impact": "NO_IMPACT",
			"notifications": {
				"errors": [
					{
						"id": "string",
						"message": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"originator": "string",
						"resolution": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"retriable": false,
						"time": "string",
						"type": "INFO"
					}
				],
				"info": [
					{
						"id": "string",
						"message": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"originator": "string",
						"resolution": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"retriable": false,
						"time": "string",
						"type": "INFO"
					}
				],
				"warnings": [
					{
						"id": "string",
						"message": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"originator": "string",
						"resolution": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"retriable": false,
						"time": "string",
						"type": "INFO"
					}
				]
			},
			"scan_time": "string",
			"solutions": {
				"key": {
					"current": {
						"components": [
							{
								"component": "string"
							}
						],
						"details": {
							"components": [
								{
									"component": "string",
									"display_name": "string",
									"display_version": "string",
									"vendor": "string"
								}
							],
							"display_name": "string",
							"display_version": "string"
						},
						"version": "string"
					},
					"notifications": {
						"errors": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						],
						"info": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						],
						"warnings": [
							{
								"id": "string",
								"message": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"originator": "string",
								"resolution": {
									"args": [
										"string"
									],
									"default_message": "string",
									"id": "string",
									"localized": "string",
									"params": {
										"key": {
											"d": 0,
											"dt": "string",
											"format": "SHORT_DATE",
											"i": 0,
											"l": {
												"id": "string",
												"params": "StdLocalizationParam Object"
											},
											"precision": 0,
											"s": "string"
										}
									}
								},
								"retriable": false,
								"time": "string",
								"type": "INFO"
							}
						]
					},
					"status": "COMPLIANT",
					"target": {
						"components": [
							{
								"component": "string"
							}
						],
						"details": {
							"components": [
								{
									"component": "string",
									"display_name": "string",
									"display_version": "string",
									"vendor": "string"
								}
							],
							"display_name": "string",
							"display_version": "string"
						},
						"version": "string"
					}
				}
			},
			"status": "COMPLIANT"
		}
	},
	"impact": "NO_IMPACT",
	"incompatible_hosts": [
		"string"
	],
	"non_compliant_hosts": [
		"string"
	],
	"notifications": {
		"errors": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		],
		"info": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		],
		"warnings": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		]
	},
	"scan_time": "string",
	"status": "COMPLIANT",
	"unavailable_hosts": [
		"string"
	]
}

array of string

non_compliant_hosts Required

Identifiers of non-compliant hosts. 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

compliant_hosts Required

Identifiers of compliant hosts. 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.

map of SettingsHostInfo

host_info Required

Auxillary information about the hosts. This gives some additional information about the hosts referenced in this result. 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.

map of SettingsHostCompliance

hosts Required

Mapping from host identifier to the compliance information for the host. 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.

SettingsComplianceImpact

impact Required

The ComplianceImpact enumerated type contains information about the impact of applying the target state in case of non compliance.
NO_IMPACT : Host has no impact.
MAINTENANCE_MODE_REQUIRED : Host requires maintenance mode to reach this target state.
REBOOT_REQUIRED : Host requires reboot to reach this target state.
UNKNOWN : Impact is unknown.

Possible values are: NO_IMPACT , MAINTENANCE_MODE_REQUIRED , REBOOT_REQUIRED , UNKNOWN

array of string

incompatible_hosts Required

Identifiers of incompatible hosts. 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.

SettingsNotifications

notifications Required

Notifications returned by the scan operation.

string

scan_time Required

Scan completion time.

SettingsComplianceStatus

status Required

The ComplianceStatus enumerated type contains the possible different status of compliance with respect to target version.
COMPLIANT : Target version is same as current version.
NON_COMPLIANT : Target version is greater than current version.
INCOMPATIBLE : Target state cannot be applied due to conflict or missing dependencies or the target state is lesser than the current version.
UNAVAILABLE : Drift check failed due to unknown error or check hasn’t happened yet and results are not available.

Possible values are: COMPLIANT , NON_COMPLIANT , INCOMPATIBLE , UNAVAILABLE

array of string

unavailable_hosts Required

Identifiers of unavailable hosts. There will not be compliance details for these hosts in ClusterCompliance.hosts. 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.

string

commit Optional

Identifier of the commit on which the scan is run to generate this result. unset if operation is performed on a draft. 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.

PowerCLI Client SDK Example

Invoke-GetClusterSoftwareCompliance -Cluster "MyCluster"

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/compliance

Errors

Error

401

com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated.

Error

404

com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if the compliance information is unavailable.

Error

500

com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.

Error

503

com.vmware.vapi.std.errors.service_unavailable : If the service is not available.

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-operation: get

Availability

Added in 7.0.0

Get Clusters Software Compliance

On This Page

Request

URL

Path Parameters

Header Parameters

vmware-api-session-id example

Authentication

api_key

Response

Response Body

PowerCLI Client SDK Example

cURL Command

Errors

Vendor Extensions

Availability

On This Page

Was this page helpful?