Skip to content

phenix util

Every command on this page also accepts the global flags.

phenix util

Utility commands

phenix util [flags]

Options

  -h, --help   help for util

SEE ALSO

phenix util app-json

Print application JSON input for given experiment to STDOUT

phenix util app-json <experiment name> [flags]

Options

  -h, --help            help for app-json
  -o, --output string   Output format (json, yaml) (default "json")
  -p, --pretty          Print indented JSON (the same as -o json)

SEE ALSO

phenix util role-table

Print a table for permissions and roles

phenix util role-table [flags]

Options

  -h, --help            help for role-table
  -o, --output string   Output format (csv, markdown, json, yaml) (default "csv")
  -p, --pretty          Print the table as markdown (the same as -o markdown)

SEE ALSO

phenix util scheduler-json

Print user scheduler JSON input for given experiment to STDOUT

Synopsis

Print user scheduler JSON input for given experiment to STDOUT

  Prints the JSON that a user scheduler (phenix-scheduler-<name>) gets on
  stdin when phenix schedules the stored experiment: the experiment spec
  (spec) and the schedulable cluster hosts with their disk usage (hosts).
  The command uses the code of a user scheduler run. It reads the hosts
  from minimega within the time limit of a user scheduler, and it stores
  nothing. With -o json (the default), the output is the exact bytes that
  the scheduler gets, with a newline at the end.
phenix util scheduler-json <experiment name> [flags]

Examples

phenix util scheduler-json my-exp
phenix util scheduler-json my-exp | phenix-scheduler-custom

Options

  -h, --help            help for scheduler-json
  -o, --output string   Output format (json, yaml) (default "json")

SEE ALSO

phenix util scorch-json

Print SCORCH component JSON input for given experiment to STDOUT

Synopsis

Print SCORCH component JSON input for given experiment to STDOUT

  Prints the JSON that the program of a SCORCH user component
  (phenix-scorch-component-<type>) gets on stdin in a SCORCH run of the
  stored experiment. The command uses the code of a SCORCH run that starts
  from the web UI, the REST API or phenix experiment scorch, and it stores
  nothing. With -o json (the default), the output is the exact bytes that
  the component gets, with a newline at the end.

  --run, --loop and --stage select where the run starts the component. Loop
  0 is the run, loop 1 is the loop of the run, and so on. When you do not
  give them, the command uses the first place that runs the component.
  --count is the pass of that loop, from 0. Only the arguments change with
  the stage and the count.

  A SCORCH run picks a random value for each replacement (replace) at each
  pass of a loop. The command picks the values in the same way. --replace
  KEY=VALUE sets a value. The command reads VALUE as JSON when it is valid
  JSON, and as text when it is not.

  --runtime adds the cluster hosts and the VMs of the experiment (hosts and
  vms). A component gets them when an external app ran before the scorch
  app in the same app stage.

  On stderr, the command prints the program, its arguments, the PHENIX_*
  variables that phenix adds, the replacement values and warnings. When you
  give -o json, it prints only the warnings.
phenix util scorch-json <experiment name> <component name> [flags]

Examples

phenix util scorch-json my-exp capture
phenix util scorch-json my-exp capture --run 1 --loop 1 --stage stop --count 2
phenix util scorch-json my-exp capture --replace '{{DURATION}}=30' -o json \
  | phenix-scorch-component-tcpdump start capture 0 0 0

Options

      --count int             Pass of the loop, from 0
  -h, --help                  help for scorch-json
      --loop int              Depth of the loop, 0 for the run (default: the first loop that runs the component)
  -o, --output string         Output format (json, yaml) (default "json")
      --replace stringArray   Value of a replacement as KEY=VALUE, read as JSON when it is valid JSON
      --run int               Index of the SCORCH run (default: the first run that runs the component)
      --runtime               Add the cluster hosts and the VMs of the experiment
      --stage string          Stage: configure, start, stop, cleanup (default: the first stage that runs the component)

SEE ALSO