SW L3 Json Schema

Type: object

SW L3 Json Schema, Schema Version 22.0

 No Additional Properties

root information
Type: object
No Additional Properties

root information schemaUrl
Type: string

The url for the schema.

root information schemaVersion
Type: string

The version of the schema for this Json file

root information fileVersion
Type: string

The file version of this Json file.

root information release
Type: object

Contains release information needed to support a specific SDK.

 No Additional Properties

root information release productDisplayName
Type: string

The display name on client of this product.

root information release serverType
Type: array of string

The types of the server for login and load data.

 No Additional Items

Each item of this array must be:

root information release serverType serverType items
Type: string

Examples:

[
    "DEVZONE"
]

[
    "PID",
    "DEVZONE"
]

root information release title
Type: string

Title of this release.

root information release releaseRevision
Type: number

The release revision is supported for this SDK.

root information release minSDKMVer
Type: string

The minimum SDK Manager version to support.

root information release maxSDKMVer
Type: string

The maximum SDK Manager version to support.

root information release releaseMessage
Type: string

Release message of this release.

root information release pidGroupId
Type: string

The PID program group id of this release, define if user need to join some program group to gain access to this release.

root information release devzoneProgramId
Type: string

The DevZone program group id of this release, define if user need to join some program group to gain access to this release

root information release upgradeMessageCondition
Type: array of object

Pop up the upgrade message if meets specific condition.

 No Additional Items

Each item of this array must be:

root information release upgradeMessageCondition upgradeMessageCondition items
Type: object
No Additional Properties

root information release upgradeMessageCondition upgradeMessageCondition items buildNumber
Type: string

Build number, accept regular expression.

root information release upgradeMessageCondition upgradeMessageCondition items releaseVersion
Type: string

Release Version, accept regular expression.

root information release hostOperatingSystemsSupportFor
Type: object

The host Operating Systems this release supports.

 No Additional Properties

root information release hostOperatingSystemsSupportFor hostGroups
Type: array of string

The host Operating Systems this release’s host groups supports.

 No Additional Items

Each item of this array must be:

root information release hostOperatingSystemsSupportFor hostGroups hostGroups items
Type: string

root information release hostOperatingSystemsSupportFor targetGroups
Type: array of string

The host Operating Systems this release’s target groups supports.

 No Additional Items

Each item of this array must be:

root information release hostOperatingSystemsSupportFor targetGroups targetGroups items
Type: string

root information release IntHWSupport
Type: boolean

If this release support internal hardwares.

root information release isAdditionalSDK
Type: boolean

If this release is for an additional sdk.

root information release SDKsRelations
Type: array of object

The relation between this additional SDK and base SDK. Only defined if this release is for an additional SDK.

 No Additional Items

Each item of this array must be:

root information release SDKsRelations SDKsRelations items
Type: object
No Additional Properties

root information release SDKsRelations SDKsRelations items default
Type: enum (of string)

The additional SDK should be enabled or not by default.

Must be one of:

  • "on"
  • "off"

root information release SDKsRelations SDKsRelations items parent
Type: object

The parent related Base SDK of the current SDK.

root information release SDKsRelations SDKsRelations items parent title
Type: string

The title of the parent SDK.

root information release SDKsRelations SDKsRelations items parent releaseRevision
Type: number

The release revision of the parent SDK.

root information release SDKsRelations SDKsRelations items parent productCategory
Type: string

The product of the parent SDK belongs to.

root information release SDKsRelations SDKsRelations items parent targetOS
Type: string

The target OS of the parent SDK.

root information release SDKsRelations SDKsRelations items parent releaseVersion
Type: string

The release version of the parent SDK.

root information release SDKsRelations SDKsRelations items parent releaseEdition
Type: string

The release edition of the parent SDK.

root information release SDKsRelations SDKsRelations items depends
Type: array

The related Additional SDK depends on current SDK.

 No Additional Items

Each item of this array must be:

root information release SDKsRelations SDKsRelations items depends relatedSDK
Type: object

The related SDK general information for matching.

root information release SDKsRelations SDKsRelations items depends depends items title
Type: string

The title of the parent SDK.

root information release SDKsRelations SDKsRelations items depends depends items releaseRevision
Type: number

The release revision of the parent SDK.

root information release SDKsRelations SDKsRelations items depends depends items productCategory
Type: string

The product of the parent SDK belongs to.

root information release SDKsRelations SDKsRelations items depends depends items targetOS
Type: string

The target OS of the parent SDK.

root information release SDKsRelations SDKsRelations items depends depends items releaseVersion
Type: string

The release version of the parent SDK.

root information release SDKsRelations SDKsRelations items depends depends items releaseEdition
Type: string

The release edition of the parent SDK.

root information release SDKsRelations SDKsRelations items conflicts
Type: array

The related Additional SDK conflicts with current SDK.

 No Additional Items

Each item of this array must be:

root information release SDKsRelations SDKsRelations items conflicts relatedSDK
Type: object

The related SDK general information for matching.

root information release SDKsRelations SDKsRelations items conflicts conflicts items title
Type: string

The title of the parent SDK.

root information release SDKsRelations SDKsRelations items conflicts conflicts items releaseRevision
Type: number

The release revision of the parent SDK.

root information release SDKsRelations SDKsRelations items conflicts conflicts items productCategory
Type: string

The product of the parent SDK belongs to.

root information release SDKsRelations SDKsRelations items conflicts conflicts items targetOS
Type: string

The target OS of the parent SDK.

root information release SDKsRelations SDKsRelations items conflicts conflicts items releaseVersion
Type: string

The release version of the parent SDK.

root information release SDKsRelations SDKsRelations items conflicts conflicts items releaseEdition
Type: string

The release edition of the parent SDK.

root information release globalVariables
Type: array of object

The SDK installation process uses this global envrioment variable to run.

 No Additional Items

Each item of this array must be:

root information release globalVariables globalVariables items
Type: object

root information release globalVariables globalVariables items name
Type: string

Name of the global variable.

root information release globalVariables globalVariables items value
Type: string

Value of the global variable.

root information release supportsWipePersistentPartition
Type: boolean

If True, then user data for DRIVE that is stored on a persistent partition will be deleted. Used in DRIVE SDK only.

root information release releaseNotes
Type: object

Release notes of this release.

 No Additional Properties

root information release releaseNotes releaseNotesTooltip
Type: string

The title of the release note.

root information release releaseNotes releaseNotesURL
Type: string

The url to release note.

root information release releaseNotes releaseNotesDownload
Type: boolean

If release note can be downloaded.

root information release showInMainList
Type: boolean

Should this release been shown in main Releases list

root information release allowRunAsRoot
Type: boolean

Allow to run SDK Manager client as root when installing this SDK.

root information release setupDeviceRecoveryModeOptions
Type: array of string

Options to set the Jetson/IGX/Holoscan device to recovery mode.

 No Additional Items

Each item of this array must be:

root information release setupDeviceRecoveryModeOptions setupDeviceRecoveryModeOptions items
Type: string

Examples:

[
    "manual",
    "automatic"
]

[
    "none"
]

root information release supportsOEMPreConfiguration
Type: boolean

If the release supports OEM Pre Configuration for the flashing BSP.

root information release bootRomPreflashVerification
Type: boolean

If the release supports bootRom Preflash Verification for the flashing BSP.

root information release QNX_Toolchain
Type: string

[Deprecated] Default selection of QNX toolchain name. Only used in the DRIVE SDK.

root information release architectures
Type: array of string

Define what kind of architectures this release supports.

 No Additional Items

Each item of this array must be:

root information release architectures architectures items
Type: string

Examples:

[
    "x86_64"
]

[
    "aarch64",
    "x86_64"
]

root information release locked
Type: boolean

If the SDK is locked.

root information release productCategory
Type: string

The name of the product category for this release.

root information release targetOS
Type: string

Operating system this release supports.
Examples:

"Linux"

"QNX"

root information release releaseVersion
Type: string

The release version supported this SDK release.

root information release releaseEdition
Type: string

The release edition is supported for this SDK release.

root information release supportedHardware
Type: object

Supported hardware information.

 No Additional Properties

root information release supportedHardware seriesIds
Type: array of string

Series Ids this release support. Available series Ids can be found in ~/.nvsdkm/hwdata/families/<product>/series/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root information release supportedHardware seriesIds seriesIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_TARGETS"
]

root information release supportedHardware deviceIds
Type: array of string

Device Ids this release support. Available device Ids can be found in ~/.nvsdkm/hwdata/families/<product>/devices/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root information release supportedHardware deviceIds deviceIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_64GB"
]

root information release supportedHardware excludedDeviceIds
Type: array of string

Device Ids that should be excluded from the series, it can either have a unique install method, or should not be included in the release. Available device Ids can be found in ~/.nvsdkm/hwdata/families/<product>/devices/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root information release supportedHardware excludedDeviceIds excludedDeviceIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_64GB"
]

root information release id
Type: string

Id of this SDK release

root information release hasTargetComponents
Type: boolean

If this release contains target components.

root information release hardwareConfiguration
Type: array of string

Define what hardware part this SDK release contains.

 No Additional Items

Each item of this array must be:

root information release hardwareConfiguration hardwareConfiguration items
Type: string

Example:

[
    "host",
    "target"
]

root information release releaseBuild
Type: string

The release build is supported for this SDK release.

root information targetAccessInfo
Type: object

The default target device access information for this SDK related targets.

 No Additional Properties

root information targetAccessInfo user
Type: string

Username used on the target device.

root information targetAccessInfo password
Type: string

Password used on the target device.

root information targetAccessInfo host
Type: string

Ip address of the target device.

root information targetAccessInfo port
Type: string

Port number to connect the target device.

root information targetAccessInfo supportsExternalStorage
Type: boolean

If target device support external storage.

root compDirectory
Type: string

The url to where the files can be downloaded from for the SDK components.

root sections
Type: array of object

Contains needed sections’ information for this SDK.

 No Additional Items

Each item of this array must be:

root sections sections items
Type: object
No Additional Properties

root sections sections items name
Type: string

Name of this section.

root sections sections items title
Type: string

Title of this section.

root sections sections items selectable
Type: boolean

If the section is selectable.

root sections sections items selected
Type: boolean

If the section is selected by default.

root sections sections items groups
Type: array of string

The ids of the groups under this section

 No Additional Items

Each item of this array must be:

root sections sections items groups groups items
Type: string

root sections sections items id
Type: string

Id of this section.

root sections sections items displayed
Type: boolean

If this section should be displayed.

root groups
Type: array

Contains needed groups’ information for this SDK.

 No Additional Items

Each item of this array must be:

root groups groups items

root groups groups items oneOf item 0
Type: string

The keys of the groups to match [A-Z0-9_]+.
root groups groups items oneOf item 1
Type: object

Contains detailed groups’ information.

 No Additional Properties

root groups groups items oneOf item 1 name
Type: string

Name of the group.

root groups groups items oneOf item 1 groupType
Type: string

Type of this group.
Examples:

"host"

"target"

"target_image"

root groups groups items oneOf item 1 installedOn
Type: string

The place this group installed on.
Examples:

"host"

"target"

root groups groups items oneOf item 1 description
Type: string

Description of the group.

root groups groups items oneOf item 1 isVirtual
Type: boolean

If the group is a virtual group.

root groups groups items oneOf item 1 selected
Type: boolean

If the group should be selected by default.

root groups groups items oneOf item 1 selectable
Type: boolean

If the group is selectable.

root groups groups items oneOf item 1 displayed
Type: boolean

If this group should be displayed.

root groups groups items oneOf item 1 flashMessage
Type: string

Used to only in flash group, to build the simple unique flash dialog replace the defaule one in the client. Contains flash message. Use this with the flashUserInputs only.

root groups groups items oneOf item 1 flashUserInputs
Type: array of object

Used to only in flash group, to build the simple unique flash dialog replace the defaule one in the client. Contains the user input fields. Use with the flashMessage only.

 No Additional Items

Each item of this array must be:

root groups groups items oneOf item 1 flashUserInputs flashUserInputs items
Type: object

root groups groups items oneOf item 1 flashUserInputs flashUserInputs items displayName
Type: string

Display name of the user input field.

root groups groups items oneOf item 1 flashUserInputs flashUserInputs items readOnly
Type: boolean

Whether you should input in user input field.

root groups groups items oneOf item 1 flashUserInputs flashUserInputs items value
Type: string

Default value of the user input field.

root groups groups items oneOf item 1 flashUserInputs flashUserInputs items id
Type: string

DId of the user input field.

root groups groups items oneOf item 1 id
Type: string

ID, used in the client to identify the group.

root groups groups items oneOf item 1 versions
Type: array of object

Contains the component information for different versions.

 No Additional Items

Each item of this array must be:

root groups groups items oneOf item 1 versions versions items
Type: object
No Additional Properties

root groups groups items oneOf item 1 versions versions items version
Type: string

Version number of this group.

root groups groups items oneOf item 1 versions versions items components
Type: array of object

The components information under this group.

 No Additional Items

Each item of this array must be:

root groups groups items oneOf item 1 versions versions items components components items
Type: object
No Additional Properties

root groups groups items oneOf item 1 versions versions items components components items version
Type: string

Version number of the component.

root components
Type: object

Contains needed components’ information for this SDK.

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: [A-Z0-9_]+
root components [A-Z0-9_]+
Type: object
No Additional Properties

root components [A-Z0-9_]+ name
Type: string

The official name of the component, which will be shown in the SDK Manager GUI.

root components [A-Z0-9_]+ isVisible
Type: boolean

Expose the component in the SDK Manager GUI.

root components [A-Z0-9_]+ estimateInstallDurationSeconds
Type: integer

The estimated install duration in seconds.

root components [A-Z0-9_]+ timeoutSeconds
Type: integer

If a component installation takes a lot longer than expected, a dialog will pop up to notice user. You can specify the exact time in seconds here, otherwise it's' calculated in the client based on package size.

root components [A-Z0-9_]+ platforms
Type: array of object

Components can have different platforms to support different install files per supportedHardware and operatingSystems.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items
Type: object
No Additional Properties

root components [A-Z0-9_]+ platforms platforms items operatingSystems
Type: array of string

The operating systems supported this version.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items operatingSystems operatingSystems items
Type: string

root components [A-Z0-9_]+ platforms platforms items componentInstallParameters
Type: object
No Additional Properties

root components [A-Z0-9_]+ platforms platforms items componentInstallParameters installDir
Type: string

Path where the installation/uninstallation will be executed.

root components [A-Z0-9_]+ platforms platforms items componentInstallParameters installEngineQueue
Type: enum (of string)

Defines how the engine will queue the file in installation/uninstallation order.

Must be one of:

  • "default"
  • "parallel"
  • "sequential"

root components [A-Z0-9_]+ platforms platforms items componentInstallParameters executionCommands
Type: array of object

The commands that need to be executed during the process.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items componentInstallParameters executionCommands executionCommands items
Type: object

root components [A-Z0-9_]+ platforms platforms items componentInstallParameters executionCommands executionCommands items commandSequence
Type: enum (of string)

The sequence stage of when/how the commands should be executed.

Must be one of:

  • "query"
  • "pre_install"
  • "install"
  • "post_install"
  • "pre_uninstall"
  • "uninstall"
  • "post_uninstall"

root components [A-Z0-9_]+ platforms platforms items componentInstallParameters executionCommands executionCommands items executionType
Type: enum (of string)

The type of where the commands should be executed.

Must be one of:

  • "exec_bash"
  • "remote_exec_bash"

root components [A-Z0-9_]+ platforms platforms items componentInstallParameters variables
Type: object

Environment variables during the installation/uninstallation process.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: [a-zA-Z0-9_]+
root components [A-Z0-9_]+ platforms platforms items componentInstallParameters variables [a-zA-Z0-9_]+
Type: string

Key is the environment variable name, and value is the environment variable value.

root components [A-Z0-9_]+ platforms platforms items downloadFiles
Type: array of object

This element contains information of the download files and installation methods.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items
Type: object
No Additional Properties

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items url
Type: string

The URL of the download file.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items fileName
Type: string

The file name of the download file.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items size
Type: number

Size of the download file in bytes.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items checksum
Type: string

Checksum of the download file.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items checksumType
Type: string

The download file checksum type, Set to md5.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items verifyChecksum
Type: string

The yes / no to identify whether SDK Manager should verify the checksum.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters
Type: object

The install parameters for the download file.

 No Additional Properties

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters additionalParameters
Type: object

Additional parameters for the download file.

 No Additional Properties

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters additionalParameters repoPackageInfo
Type: object

Repo package info. This is only used when there is a specific key file need to be added for the repo but is not a *.pub in the repo.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters additionalParameters repoPackageInfo keyFile
Type: string

Public key file name within this repo file. The key file is then added with 'sudo apt-key add <keyFile>' command. Example: GPGKEY. If not provided, it searches *.pub in the repo and use this file.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters additionalParameters installCommandArguments
Type: string

It is used to pass additional parameters to .run file. Example: '--nox11 --noprogress -- -noprompt'. It is not used for other file type at the moment.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters executionCommands
Type: array of object

The commands that need to be executed during the process.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters executionCommands executionCommands items
Type: object

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters executionCommands executionCommands items commandSequence
Type: enum (of string)

The sequence stage of when/how the commands should be executed.

Must be one of:

  • "query"
  • "pre_install"
  • "install"
  • "post_install"
  • "pre_uninstall"
  • "uninstall"
  • "post_uninstall"

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters executionCommands executionCommands items executionType
Type: enum (of string)

The type of where the commands should be executed.

Must be one of:

  • "exec_bash"
  • "remote_exec_bash"

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters variables
Type: object

Environment variables during the installation/uninstallation process.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: [a-zA-Z0-9_]+
root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters variables [a-zA-Z0-9_]+
Type: string

Key is the environment variable name, and value is the environment variable value.

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters installEngineQueue
Type: enum (of string)

Defines how the engine will queue the file in installation order.

Must be one of:

  • "default"
  • "parallel"
  • "sequential"

root components [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters installType
Type: string

Installation type of the download file.
Examples:

"skip"

"archive"

"zip"

"tgz"

"deb"

"deb_repo"

"run"

"run_root"

"cmd"

"target_deb_repo"

"target_deb"

"rpm"

root components [A-Z0-9_]+ platforms platforms items dependencies
Type: array of object

The components or groups this component should be dependent on for the installation queue.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items dependencies dependencies items
Type: object
No Additional Properties

root components [A-Z0-9_]+ platforms platforms items dependencies dependencies items type
Type: string

Type of the dependency.
Examples:

"optional"

"required"

root components [A-Z0-9_]+ platforms platforms items dependencies dependencies items id
Type: string

ID of the dependency component or group.

root components [A-Z0-9_]+ platforms platforms items architectures
Type: array of string

Define what kind of architectures this component supports.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items architectures architectures items
Type: string

Examples:

[
    "x86_64"
]

[
    "aarch64",
    "x86_64"
]

root components [A-Z0-9_]+ platforms platforms items supportedHardware
Type: object

Supported hardware information.

 No Additional Properties

root components [A-Z0-9_]+ platforms platforms items supportedHardware seriesIds
Type: array of string

Series Ids this release support. Available series Ids can be found in ~/.nvsdkm/hwdata/families/<product>/series/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items supportedHardware seriesIds seriesIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_TARGETS"
]

root components [A-Z0-9_]+ platforms platforms items supportedHardware deviceIds
Type: array of string

Device Ids this release support. Available device Ids can be found in ~/.nvsdkm/hwdata/families/<product>/devices/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items supportedHardware deviceIds deviceIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_64GB"
]

root components [A-Z0-9_]+ platforms platforms items supportedHardware excludedDeviceIds
Type: array of string

Device Ids that should be excluded from the series, it can either have a unique install method, or should not be included in the release. Available device Ids can be found in ~/.nvsdkm/hwdata/families/<product>/devices/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items supportedHardware excludedDeviceIds excludedDeviceIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_64GB"
]

root components [A-Z0-9_]+ platforms platforms items installSizeMB
Type: number

The size in MB of the component after installed.

root components [A-Z0-9_]+ platforms platforms items prerequisites
Type: array of object

The prerequisites string checks for the components, if needed. Available prerequisites in SDK Manager include.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items
Type: object
No Additional Properties

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items prerequisiteID
Type: enum (of string)

The IDs of the prerequisite.

Must be one of:

  • "PREREQUISITE_APT_HOST"
  • "PREREQUISITE_APT_TARGET"
  • "PREREQUISITE_DISK_SPACE_TARGET"
  • "PREREQUISITE_NETWORK_TARGET"
  • "PREREQUISITE_RHEL_REPO_CODEREADY_HOST"
  • "PREREQUISITE_LINUX_KERNEL"
  • "PREREQUISITE_LINUX_KERNEL_TARGET"
  • "PREREQUISITE_DEVICE_IMAGE_VERSION_TARGET"

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters
Type: array of object

Parameters of the prerequisite

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items
Type: object

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items architectures
Type: array of string

Define what kind of architectures need to use this prerequisite.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items architectures architectures items
Type: string

Examples:

[
    "x86_64"
]

[
    "aarch64",
    "x86_64"
]

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items kernelVersion
Type: string

What kernel version need to use. Only if prerequisite is related to a kernel(id includes KERNEL).

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items informationUri
Type: string

Information uri of this prerequisite related topic.

root components [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items deviceImageVersion
Type: string

What device image version need to use. Only if prerequisite is related to device image version(id includes DEVICEIMAGEVERSION).

root components [A-Z0-9_]+ platforms platforms items modals
Type: array of string

Contains the modalIDs defined in this L3 Json need to be used in this platform.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ platforms platforms items modals modals items
Type: string

root components [A-Z0-9_]+ version
Type: string

The component exact version.

root components [A-Z0-9_]+ licenseIds
Type: array of string

The IDs of the licenses for this component are used in SDK Manager.

 No Additional Items

Each item of this array must be:

root components [A-Z0-9_]+ licenseIds licenseIds items
Type: string

root components [A-Z0-9_]+ id
Type: string

ID, Used in the client to identify the component.

root components [A-Z0-9_]+ isDetectableInstall
Type: boolean

Set whether the component installation status is detectable or not. Typically, the installation type with deb, debrepo, targetdebrepo, targetdeb, and rpm should be set to true. Others should be set to false.

root components [A-Z0-9_]+ isPartiallyDetectableInstall
Type: boolean

Set whether the component installation status is detectable. Should be set to true when a component has both detectable methods and undetectable methods in it.

root licenses
Type: object

Licenses used for this SDK.

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: [A-Z0-9_]+
root licenses [A-Z0-9_]+
Type: object
No Additional Properties

root licenses [A-Z0-9_]+ name
Type: string

Name of the license.

root licenses [A-Z0-9_]+ url
Type: string

Url of the license.

root licenses [A-Z0-9_]+ locked
Type: boolean

If the license is locked.

root licenses [A-Z0-9_]+ id
Type: string

ID of the license.

root modals
Type: array of object

Dynamic modals used in this SDK. This usually contains fields like warnings, instructions, errors.

 No Additional Items

Each item of this array must be:

root modals modals items
Type: object
No Additional Properties

root modals modals items name
Type: string

Name of the dynamic modal.

root modals modals items displayCondition
Type: object

Display Condition of the dynamic modal.

 No Additional Properties

root modals modals items displayCondition stages
Type: array of enum (of string)

Stages Condition of the dynamic modal.

 No Additional Items

Each item of this array must be:

root modals modals items displayCondition stages stages items
Type: enum (of string)

Must be one of:

  • "PRE_INSTALL"
  • "INSTALL_SUCCESS"
  • "INSTALL_FAILURE"
  • "PRE_UNINSTALL"
  • "UNINSTALL_SUCCESS"
  • "UNINSTALL_FAILURE"

root modals modals items displayCondition conditions
Type: array of object

Conditions of the dynamic modal.

 No Additional Items

Each item of this array must be:

root modals modals items displayCondition conditions conditions items
Type: object

root modals modals items displayCondition conditions conditions items execBash
Type: array of string

A list of commands to be saved in a temp bash file and to be run on host.

 No Additional Items

Each item of this array must be:

root modals modals items displayCondition conditions conditions items execBash execBash items
Type: string

root modals modals items displayCondition conditions conditions items remoteExecBash
Type: array of string

A list of commands to be saved in a temp bash file, copied to target, then to be run on target.

 No Additional Items

Each item of this array must be:

root modals modals items displayCondition conditions conditions items remoteExecBash remoteExecBash items
Type: string

root modals modals items content
Type: object

Content of the dynamic modal.

 No Additional Properties

root modals modals items content modalTitle
Type: string

Title of the dynamic modal.

root modals modals items content iconType
Type: enum (of string)

Icon type of the dynamic modal.

Must be one of:

  • "INFO"
  • "ERROR"
  • "WARNING"

root modals modals items content layout
Type: array of object

Layout type of the dynamic modal.

 No Additional Items

Each item of this array must be:

root modals modals items content layout layout items
Type: object
No Additional Properties

root modals modals items content layout layout items tag
Type: enum (of string)

Tag type of the dynamic modal.

Must be one of:

  • "TEXT"
  • "TEXT_BULLETS"
  • "INPUT_TEXT"
  • "INPUT_PASSWORD"
  • "RADIO"

root modals modals items content layout layout items attributes

root modals modals items content layout layout items attributes anyOf item 0
Type: object

Text attributes type of the dynamic modal.

 No Additional Properties

root modals modals items content layout layout items attributes anyOf item 0 text
Type: string

Text type of the dynamic modal.
root modals modals items content layout layout items attributes anyOf item 1
Type: object

Bullets attributes type of the dynamic modal.

 No Additional Properties

root modals modals items content layout layout items attributes anyOf item 1 bullets
Type: array of string

Bullets type of the dynamic modal.

 No Additional Items

Each item of this array must be:

root modals modals items content layout layout items attributes anyOf item 1 bullets bullets items
Type: string
root modals modals items content layout layout items attributes anyOf item 2
Type: object

Radio attributes type of the dynamic modal.

 No Additional Properties

root modals modals items content layout layout items attributes anyOf item 2 default
Type: string

The default value of this radio item.

root modals modals items content layout layout items attributes anyOf item 2 options
Type: array of string

The options of this radio item.

 No Additional Items

Each item of this array must be:

root modals modals items content layout layout items attributes anyOf item 2 options options items
Type: string

root modals modals items content layout layout items attributes anyOf item 2 variableName
Type: string

Variable Name of this radio item.

root modals modals items content layout layout items attributes anyOf item 2 label
Type: string

Label Name of this radio item.
root modals modals items content layout layout items attributes anyOf item 3
Type: object

Input text or input password attributes type of the dynamic modal.

 No Additional Properties

root modals modals items content layout layout items attributes anyOf item 3 default
Type: string

The default value of this input item.

root modals modals items content layout layout items attributes anyOf item 3 variableName
Type: string

Variable Name of this input item.

root modals modals items content layout layout items attributes anyOf item 3 label
Type: string

Label Name of this input item.

root modals modals items buttons
Type: array of object

Buttons stage of the dynamic modal.

 No Additional Items

Each item of this array must be:

root modals modals items buttons buttons items
Type: object
No Additional Properties

root modals modals items buttons buttons items buttonType
Type: enum (of string)

Type of the button.

Must be one of:

  • "SKIP"
  • "OK"
  • "CANCEL"

root modals modals items buttons buttons items buttonTitle
Type: string

Title of the button.

root modals modals items buttons buttons items default
Type: boolean

If this button is the default selection.

root modals modals items modalID
Type: string

ID of the dynamic modal.

Must match regular expression: ^[A-Z0-9_]+$