fugue2 status

Usage

fugue2 status [ALIAS or FID] [flags]

Arguments

[ALIAS or FID]
Optional FID or alias of the process whose status is being checked

Options

Global options are detailed here.

-h | --help
Show help text for status.
--verbose
Print full process summary.

Definition

The status command retrieves a status report of all Fugue processes. You may optionally provide an alias or FID to see a detailed view of the process and its resources.

If no processes are running, the output will show an empty list: [].

Status Fields

The following fields are returned with fugue2 status:

alias
Alias of process, if applicable; otherwise omitted
api_version
The version of the Fugue Platform 2.x API which created this process
created
When the process was created
current_operation

Type of operation currently taking place:

create_process
The process will be created on the next job
read_process
The process(es) will be read on the next job
update_process
The process will be updated on the next job
delete_process
The process will be deleted on the next job
suspend_process
The process will be suspended on the next job
resume_process
The process will be resumed on the next job
nothing
No operation is taking place
enforcement
Implementation pending
fid
Fugue ID, or the process’s unique identifier
job_status

Status of the last job:

pending
The job has been created but not scheduled
scheduled
The job has been scheduled
running
The job is running
succeeded
The job succeeded
failed
The job failed
last_error
Most recent error message, if applicable; otherwise an empty record {}
locked
Implementation pending
next_operation

The next queued action:

create_process
The process will be created on the next job
read_process
The process(es) will be read on the next job
update_process
The process will be updated on the next job
delete_process
The process will be deleted on the next job
suspend_process
The process will be suspended on the next job
resume_process
The process will be resumed on the next job
nothing
No operation is taking place
notifications

Contains the following fields:

drift
Whether drift notifications are on or off
enforcement
Whether enforcement notifications are on or off
principal
The user whose permissions are used when creating a process. Currently, only root is supported
process_status

State of the process:

alive
Process is running, not currently carrying out a job
busy
Process is carrying out a job
killed
Process has been terminated
suspended
Process is suspended, jobs are not issued
provider
Cloud provider hosting the process. Currently, only azure is supported
scheduled
When a job was last scheduled for the process
updated
When the user last initiated a state change
user
Fugue user who initiated the process. Currently, only root is supported

Example output:

[
  {
    "alias": "myProcess",
    "api_version": 1,
    "created": "2018-12-17T22:53:10.000Z",
    "current_operation": "nothing",
    "enforcement": true,
    "fid": "c179e237-d9df-4179-bdb5-a9e381b668e9",
    "job_status": "succeeded",
    "last_error": {},
    "locked": false,
    "next_operation": "nothing",
    "notifications": {
      "drift": "on",
      "enforcement": "on"
    },
    "principal": "root",
    "process_status": "alive",
    "provider": "azure",
    "scheduled": "2018-12-18T10:22:56.000Z",
    "updated": "2018-12-18T10:23:07.000Z",
    "user": "root"
  },
]

Examples

Getting the status of all processes

To get the status of all running processes, execute the status command:

fugue2 status

The CLI will return a JSON report of all current processes:

Fugue Status Report

[
  {
    "alias": "myProcess",
    "api_version": 1,
    "created": "2018-12-18T05:43:05.000Z",
    ...
  },
  {
    "alias": "resourceGrp",
    "api_version": 1,
    "created": "2018-12-18T05:34:24.000Z",
    ...
  }
]

For full output including field definitions, see Status Fields.

Getting the status of a specific process

To get the status of a specific process, execute the status command and specify the process FID or alias:

fugue2 status myProcess

The CLI will return a JSON report of the given process:

Fugue Status Report

[
  {
    "alias": "myProcess",
    "api_version": 1,
    "created": "2018-12-18T05:43:05.000Z",
    "current_operation": "nothing",
    "enforcement": true,
    "fid": "4b7c55c1-24b2-4686-a075-e9efe32c81d5",
    "job_status": "succeeded",
    "last_error": {},
    "locked": false,
    "next_operation": "nothing",
    "notifications": {
      "drift": "on",
      "enforcement": "on"
    },
    "principal": "root",
    "process_status": "alive",
    "provider": "azure",
    "scheduled": "2018-12-18T10:22:56.000Z",
    "updated": "2018-12-18T10:23:02.000Z",
    "user": "root"
  }
]

See Status Fields for field definitions.