Skip to navigation
Air APIAPI ReferenceSimulations

Clone a simulation

View as Markdown

Cloning a simulation will create a new replica of the simulation which is completely independent of the original simulation.

An optional checkpoint value may be specified in the payload in order to copy a checkpoint from the original simulation onto the new simulation. If checkpoint is excluded from the payload, the most recent checkpoint of the simulation will be used; if the null value is provided, no checkpoint will be used and the simulation will perform an initial boot the first time it is started.

If you would like to attempt to start the new sim immediately after cloning, provide true for the attempt_start value in your payload; even if attempt_start is set to true, the sim may not start if Air or your organization does not have sufficient credit/resources. The attempt_start option does not apply for simulations being cloned to a demo.

An optional name value may be provided in the payload to set the name of the new simulation. If omitted, the new simulation will inherit the name of the original simulation.

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

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
simulationstringRequiredformat: "uuid"

A simulation to clone from; must be in the INACTIVE or CLONING state.

checkpointstring or nullOptionalformat: "uuid"

A COMPLETE checkpoint to clone from. If null, Air will not transfer a checkpoint.If not specified, Air will find the most recent COMPLETE if it exists. If no checkpoint exists, no checkpoint will be transferred.

attempt_startbooleanOptionalDefaults to false

If the simulation should request to start immediately after cloning. The request to start will always be honored, but the start request may be rejected depending on Air/organization credits/resources. Attempts to start do not apply for simulations being cloned to a demo.

namestringOptional1-128 characters
An optional name for the new simulation. If omitted, the new simulation will inherit the name of the original simulation.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
namestring<=128 characters
stateenum
  • CLONING - Cloning
  • CREATING - Creating
  • IMPORTING - Importing
  • INVALID - Invalid
  • INACTIVE - Inactive
  • REQUESTING - Requesting
  • PENDING - Pending
  • PROVISIONING - Provisioning
  • PREPARE_BOOT - Prepare to boot
  • BOOTING - Booting
  • ACTIVE - Active
  • PREPARE_SHUTDOWN - Prepare to shutdown
  • SHUTTING_DOWN - Shutting down
  • SAVING - Saving
  • DELETING - Deleting
  • PREPARE_PURGE - Prepare to purge
  • PURGING - Purging
  • DEMO - Demo
  • TRAINING - Training
  • PREPARE_REBUILD - Prepare to rebuild
  • REBUILDING - Rebuilding
  • ADMIN_SUSPENDED - Admin suspended
auto_oob_enabledboolean or nullRead-only
If OOB should be automatically configured.
enable_dhcpboolean or nullRead-only

If DHCP should be enabled on the oob-mgmt-server for simulations with automatic OOB enabled.

creatorstringRead-only
The email of the user who created the simulation
assigned_tostring or nullRead-only
The email of the user who is assigned to the simulation during a Training event.
documentationstring or nullRead-only

The raw markdown documentation associated with the simulation, if any. This is populated for simulations provisioned from a marketplace demo, sharing the same content as the demo. It cannot be edited directly on the simulation — edit the marketplace demo’s documentation instead.

complete_checkpoint_countintegerRead-only

The number of complete checkpoints in the simulation. When a sim has complete checkpoints, nodes/interfaces cannot be modified, created, or deleted.

sleep_atdatetime or nullOptional

When the simulation should be automatically put to sleep. For organizations on a free trial of DSX Air, this defaults to 24 hours after the simulation was started; if the simulation has not yet started this value will default to null and will be updated when the simulation starts. For all other organizations, this defaults to null. NVIDIA users using the internal deployment of DSX Air may set this value to null even when on a free trial. Users on a free trial of the public deployment of DSX Air may not set this value to null and may not set this value to exceed 72 hours in the future.

expires_atdatetime or nullOptional
When the simulation should be automatically deleted.
metadatastring or nullOptional<=1048576 characters
Custom metadata as a JSON string. This field does not affect the runtime of the simulation. It is provided for clients to store metadata about the simulation for their own purposes.
user_notesstringOptional<=4096 characters

Free-text notes about the simulation recorded by the user.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error