This endpoint expects an object.
docker_run_parametersobjectRequired
Docker run parameters for the simulator container.
emulation_typestringRequired1-255 characters
The type of simulation engine to which the plugin manifest applies.
platform_informationmap from strings to objectsRequired
Configuration for specific hardware models emulated by this plugin manifest.
simulator_imagestringRequiredformat: "uuid"
Simulator image associated with this plugin manifest.
simulator_resourcesobjectRequired
Resource overhead for simulator processes.
artifacts_directorystringOptional>=1 characterDefaults to /artifacts
Absolute POSIX path inside the simulator container to mount the artifacts disk to.
artifacts_directory_max_size_gbintegerOptional>=1Defaults to 10
Artifacts disk size, in GB.
boot_groupintegerOptional1-100Defaults to 50
Boot group of nodes emulated by this plugin manifest.
configure_node_propertiesmap from strings to anyOptional
Desired fields (and defaults) for node configuration API call.
configure_simulatormap from strings to anyOptional
Desired fields (and defaults) for simulator configuration API call.
hardware_emulationbooleanOptionalDefaults to true
Whether this manifest emulates a real hardware model. Set to True for manifests that emulate a specific hardware platform, and False for manifests that do not (they run a plain VM without modeling specific hardware).
simulation_engine_versionslist of stringsOptional
Additional simulator image versions this plugin manifest can be used with.
seccomp_policy_versionstring or nullOptional1-64 characters
Version of the seccomp security policy to apply to nodes using this manifest.
apparmor_policy_versionstring or nullOptional1-64 characters
Version of the AppArmor security policy to apply to nodes using this manifest.
emulation_paramsobjectOptional
Emulation parameters for the plugin manifest.
port_mapping_requiredbooleanOptional
Whether a matching port mapping per platform is required to be present for this plugin manifest to be used.
platform_information_versionstringOptional<=64 characters
Version of the platform information to resolve for this engine when port_mapping_required is set. Resolved together with this manifest emulation_type and the node’s model.
hypervisor_apienum or any or nullOptional
The API of the hypervisor to use for this plugin manifest.
node_featuresobjectOptional
Per-manifest opt-in catalogue of node features. Presence of a key enables the feature; the value carries any feature-specific configuration. Updates replace the dict in full.
Response
idstringRead-onlyformat: "uuid"
modifieddatetimeRead-only
org_namestring or nullRead-only
Organization this plugin manifest belongs to. Set to None for plugin manifests of published simulator images originating from current organization.
docker_run_parametersobject
Docker run parameters for the simulator container.
emulation_typestring<=255 characters
The type of simulation engine to which the plugin manifest applies.
platform_informationmap from strings to objects
Configuration for specific hardware models emulated by this plugin manifest.
simulator_imagestringformat: "uuid"
Simulator image associated with this plugin manifest.
simulator_resourcesobject
Resource overhead for simulator processes.
artifacts_directorystringOptionalDefaults to /artifacts
Absolute POSIX path inside the simulator container to mount the artifacts disk to.
artifacts_directory_max_size_gbintegerOptional>=1Defaults to 10
Artifacts disk size, in GB.
boot_groupintegerOptional1-100Defaults to 50
Boot group of nodes emulated by this plugin manifest.
configure_node_propertiesmap from strings to anyOptional
Desired fields (and defaults) for node configuration API call.
configure_simulatormap from strings to anyOptional
Desired fields (and defaults) for simulator configuration API call.
hardware_emulationbooleanOptionalDefaults to true
Whether this manifest emulates a real hardware model. Set to True for manifests that emulate a specific hardware platform, and False for manifests that do not (they run a plain VM without modeling specific hardware).
simulation_engine_versionslist of stringsOptional
Additional simulator image versions this plugin manifest can be used with.
seccomp_policy_versionstring or nullOptional<=64 characters
Version of the seccomp security policy to apply to nodes using this manifest.
apparmor_policy_versionstring or nullOptional<=64 characters
Version of the AppArmor security policy to apply to nodes using this manifest.
emulation_paramsobjectOptional
Emulation parameters for the plugin manifest.
port_mapping_requiredbooleanOptional
Whether a matching port mapping per platform is required to be present for this plugin manifest to be used.
platform_information_versionstringOptional<=64 characters
Version of the platform information to resolve for this engine when port_mapping_required is set. Resolved together with this manifest emulation_type and the node’s model.
hypervisor_apienum or any or nullOptional
The API of the hypervisor to use for this plugin manifest.
node_featuresobjectOptional
Per-manifest opt-in catalogue of node features. Presence of a key enables the feature; the value carries any feature-specific configuration. Updates replace the dict in full.
