Skip to content
Omniglass Omniglass Omniglass

Fire an operation at a simulated component

POST
/components/{name}/simulation:fire
 
curl --request POST \
  --url https://example.com/api/v1/components/example/simulation:fire \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "command": "example", "method": "example", "oid": "example", "path": "example", "surface": "example" }'

Asks the simulator beside the component’s node to run one operation against the simulated component, on one of its protocol surfaces: an HTTP call, a command line (SSH, Telnet, TCP) or an SNMP get, and returns its answer. The simulator answers from the component’s live state in process, as its listeners would, so a command’s change sticks and the collector sees it; an impairment does not stop it. Audited. Gated by simulation:update, resolved on the component tier. A component that is not simulated is a 409, a surface it does not serve a 422, and no simulator answering a 503.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required

The simulated component’s name, or a dotted address

string

The simulated component’s name, or a dotted address

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
body

HTTP: the request body

string
command

SSH, Telnet or TCP: the command line

string
method

HTTP: the method; GET when empty

string
/^[A-Za-z]*$/
oid

SNMP: the OID to get

string
path

HTTP: the request path

string
surface
required

The surface to fire on, by its name in the component’s surface list

string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
body
required
string
error
string
status
integer format: int64
took_ms
required
integer format: int64
truncated
boolean
Example 
{
  "$schema": "/api/v1/schemas/SimOperationResult.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}