Get details of a specific plugin manifest

GET

https://api.dsx-air.nvidia.com/api/v3/manifests/plugin-images/:id/

GET

/api/v3/manifests/plugin-images/:id/

curl https://api.dsx-air.nvidia.com/api/v3/manifests/plugin-images/id/ \
     -H "Authorization: Bearer <token>"

{
  "id": "string",
  "created": "2024-01-15T09:30:00Z",
  "modified": "2024-01-15T09:30:00Z",
  "org_name": "string",
  "docker_run_parameters": {
    "tmpfs": [
      {
        "path": "string",
        "size_gb": 1
      }
    ],
    "cap_add": [
      "NET_ADMIN"
    ],
    "devices": [
      "/dev/kvm"
    ],
    "volumes": [
      "/sys/fs/cgroup:/sys/fs/cgroup:rw"
    ],
    "environment": {},
    "shm_size_mib": 64,
    "ulimits": {
      "msgqueue": {
        "soft": 819200,
        "hard": 819200
      }
    }
  },
  "emulation_type": "string",
  "platform_information": {},
  "simulator_image": "string",
  "simulator_resources": {
    "cpu": 1.1,
    "memory": 1
  },
  "artifacts_directory": "/artifacts",
  "artifacts_directory_max_size_gb": 10,
  "boot_group": 50,
  "configure_node_properties": {},
  "configure_simulator": {},
  "hardware_emulation": true,
  "simulation_engine_versions": [
    "string"
  ],
  "seccomp_policy_version": "string",
  "apparmor_policy_version": "string",
  "emulation_params": {
    "direct_link_emulation": true,
    "max_network_pci": -1
  },
  "port_mapping_required": true,
  "platform_information_version": "string",
  "hypervisor_api": "libvirt",
  "node_features": {
    "agent_injection": {},
    "cdrom": {},
    "cloud_init": {},
    "bios": {},
    "boot_order": {},
    "nvme": {},
    "cpu_options": {
      "supported": [
        "string"
      ]
    },
    "cpu_mode": {
      "supported": [
        "string"
      ]
    }
  }
}

Admin clients may view all plugin manifests; all other simulator engine developers can view and edit plugin manifests in an organization they are a member of.

Required scope: air:manifest_read (roles: air_simengine_debugger, air_simengine_developer)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"

A UUID string identifying this plugin manifest.

Response

idstringRead-onlyformat: "uuid"

createddatetimeRead-only

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.

libvirt - Libvirt API

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.

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error