Equinix Fabric API v4 | Equinix Product Documentation

Create Command

Request

This API provides capability to initiate Command

Security

BearerAuth

Path

routerIdstring, (uuid)required

Router UUID

Example:557400f8-d360-11e9-bb65-2a2ae2dbcce4

Bodyapplication/jsonrequired

typestring(CloudRouterCommandType)required

Fabric Cloud Router Command Type

Enum:"PING_COMMAND""TRACEROUTE_COMMAND"

Example:"PING_COMMAND"

namestring

Customer-provided Cloud Router Command name

descriptionstring

Customer-provided Cloud Router Command description

projectobject(Project)required

requestobject(CloudRouterCommandRequestPayload)required

Fabric Cloud Router Command Request

Payload

{
  "type": "PING_COMMAND",
  "name": "ping-test-1",
  "description": "Testing FCR-SV-1",
  "project": {
    "projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
  },
  "request": {
    "destination": "8.8.8.8",
    "sourceConnection": { … },
    "timeout": 2,
    "dataBytes": 100
  }
}

Responses

Successful operation

Bodyapplication/json

hrefstring

Example:"https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/commands/1e9414f1-763e-4c0a-86c6-0bc8336048d9"

typestring(CloudRouterCommandType)

Fabric Cloud Router Command Type

Enum:"PING_COMMAND""TRACEROUTE_COMMAND"

Example:"PING_COMMAND"

uuidstring, (uuid)

Example:"557400f8-d360-11e9-bb65-2a2ae2dbcce4"

namestring, (string)

Customer-provided Cloud Router name

Example:"test-fg-1"

descriptionstring

Example:"description"

statestring(CloudRouterCommandState)

Fabric Cloud Router Command State

Enum:"PENDING""SUCCEEDED""FAILED""DELETED"

Example:"SUCCEEDED"

projectobject(Project)

requestobject(CloudRouterCommandRequestResponse)

Fabric Cloud Router Command Request

responseCloudRouterCommandPingResponse (object) or CloudRouterCommandTracerouteResponse (object)(CloudRouterCommandResponse)

One of:

changeLogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00",
  "type": "PING_COMMAND",
  "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
  "name": "ping-test-1",
  "description": "Testing FCR-SV-1",
  "state": "PENDING",
  "project": {
    "projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
  },
  "request": {
    "destination": "8.8.8.8",
    "sourceConnection": { … },
    "timeout": 2,
    "dataBytes": 100,
    "count": 5,
    "interval": 1000
  },
  "changeLog": {
    "createdBy": "testuser",
    "createdDateTime": "2020-05-21T10:30:00Z"
  }
}