SettingsComponentCompliance

The ComponentCompliance structure contains information that describe the compliance of a component with respect to the component present in the target software specification.

Properties

SettingsComponentInfo

current Optional

Current version of the component present on the host. unset if component is not present on the host.

SettingsComponentSource Enum

current_source Optional

The ComponentSource enumerated type contains the component’s source information.
BASE_IMAGE : Base image is the source for this component
ADD_ON : Addon is the source for this component
USER : User is the source for this component
SOLUTION : Solution is the source for this component
HARDWARE_SUPPORT_PACKAGE : Hardware Support Package (HSP) is the source for this component

Possible values are: BASE_IMAGE , ADD_ON , USER , SOLUTION , HARDWARE_SUPPORT_PACKAGE

SettingsNotifications

notifications Required

Notifications describing the compliance result.

SettingsStageStatus Enum

stage_status Optional

The StageStatus enumerated type contains the possible different staged statuses with respect to target version. This is only relevant when the value of ComplianceStatus is NON_COMPLIANT.
STAGED : Required components/payloads are already staged.
NOT_STAGED : Required components/payloads are not staged.

Possible values are: STAGED , NOT_STAGED

SettingsComplianceStatus Enum

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

SettingsComponentInfo

target Optional

Target version of the component present in the software specification. unset if component is not present in the software specification.

SettingsComponentSource Enum

target_source Optional

Possible values are: BASE_IMAGE , ADD_ON , USER , SOLUTION , HARDWARE_SUPPORT_PACKAGE

JSON Example

Show optional properties

{
	"notifications": {},
	"status": "COMPLIANT"
}

{
	"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"
			}
		]
	},
	"stage_status": "STAGED",
	"status": "COMPLIANT",
	"target": {
		"details": {
			"display_name": "string",
			"display_version": "string",
			"vendor": "string"
		},
		"version": "string"
	},
	"target_source": "BASE_IMAGE"
}

SettingsComponentCompliance

Properties

JSON Example

Was this page helpful?