Export a simulation to a desired topology format

GET

https://api.dsx-air.nvidia.com/api/v3/simulations/:id/export/

GET

/api/v3/simulations/:id/export/

curl -G https://api.dsx-air.nvidia.com/api/v3/simulations/id/export/ \
     -H "Authorization: Bearer <token>" \
     -d topology_format=JSON

{
  "content": {
    "instructions": [
      {
        "data": {
          "hostname": "string"
        },
        "executor": "init",
        "name": "string",
        "node": "string",
        "reachability_check": {
          "reachability_ip": "string",
          "timeout": 480,
          "vrf": "string"
        },
        "run_again_on_rebuild": false,
        "wait_for_network": true
      }
    ],
    "links": [
      [
        {
          "interface": "interface1",
          "interface_role": "interface_role1",
          "mac": "mac1",
          "network_pci": "network_pci1",
          "node": "node1",
          "scalable_unit": 1,
          "split": "split1"
        },
        {
          "interface": "interface2",
          "interface_role": "interface_role2",
          "mac": "mac2",
          "network_pci": "network_pci2",
          "node": "node2",
          "scalable_unit": 1,
          "split": "split2"
        }
      ],
      [
        {
          "interface": "interface1",
          "interface_role": "interface_role1",
          "mac": "mac1",
          "network_pci": "network_pci1",
          "node": "node1",
          "scalable_unit": 1,
          "split": "split1"
        },
        "outbound"
      ],
      [
        {
          "interface": "interface1",
          "interface_role": "interface_role1",
          "mac": "mac1",
          "network_pci": "network_pci1",
          "node": "node1",
          "scalable_unit": 1,
          "split": "split1"
        },
        {
          "interface": "interface2",
          "interface_role": "interface_role2",
          "mac": "mac2",
          "network_pci": "network_pci2",
          "node": "node2",
          "scalable_unit": 1,
          "split": "split2"
        },
        {
          "cable_length": "cable_length"
        }
      ]
    ],
    "nodes": {},
    "oob": {
      "enable_dhcp": true,
      "nodes": {
        "oob-mgmt-server": {
          "cpu": 1,
          "memory": 1,
          "positioning": {
            "x": 1,
            "y": 1
          },
          "storage": 1
        },
        "oob-mgmt-switch": {
          "cpu": 1,
          "memory": 1,
          "positioning": {
            "x": 1,
            "y": 1
          },
          "storage": 1
        }
      },
      "subnets": {}
    },
    "services": [
      {
        "interface": "string",
        "name": "string",
        "node": "string",
        "node_port": 1,
        "service_type": "SSH"
      }
    ]
  },
  "format": "JSON",
  "name": "string",
  "ztp": "string"
}

Simulations can be exported to supported topology formats via this endpoint. Export behavior can be controlled by providing query parameters.

Required scope: air:simulation_read (roles: air_org_admin, air_user)

Alternative: role air_trainee also grants access.

Simulations can be exported to supported topology formats via this endpoint. Export behavior can be controlled by providing query parameters. **Required scope:** `air:simulation_read` (roles: `air_org_admin`, `air_user`) **Alternative:** role `air_trainee` also grants access.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"

A UUID string identifying this simulation.

Query parameters

image_idsbooleanOptionalDefaults to false

Set this flag in order to return image IDs instead of names.

include_instructionsenumOptionalDefaults to NONE

Which client-created instructions to include. Instructions on child plugin nodes and OOB switches are never included, because you cannot import them.

NONE: Do not include instructions.
REPEATABLE: Include instructions with created_by_client and run_again_on_rebuild set to true.
REPEATABLE_OR_NOT_READY: Include instructions with created_by_client set to true and either run_again_on_rebuild set to true or state set to NOT_READY. This option includes all instructions which would be executed if the simulation was booted without a checkpoint right now.

Which client-created instructions to include. Instructions on child plugin nodes and OOB switches are never included, because you cannot import them. - `NONE`: Do not include instructions. - `REPEATABLE`: Include instructions with `created_by_client` and `run_again_on_rebuild` set to true. - `REPEATABLE_OR_NOT_READY`: Include instructions with `created_by_client` set to true and either `run_again_on_rebuild` set to true or `state` set to `NOT_READY`. This option includes all instructions which would be executed if the simulation was booted without a checkpoint right now.

Allowed values:

include_servicesbooleanOptionalDefaults to false

Include services in the export.

topology_formatenumRequired

Desired output format.

Allowed values:

Response

TopologyFormatFullJSONobject

Representation of a topology in JSON format.

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error