Skip to content

phenix vlan

Every command on this page also accepts the global flags.

phenix vlan

Used to manage VLANs

phenix vlan [flags]

Options

  -h, --help   help for vlan

SEE ALSO

phenix vlan alias

View, pin or unpin VLAN aliases

Synopsis

View, pin or unpin VLAN aliases

  With no arguments, lists the VLAN aliases of every experiment. With an
  experiment name, lists that experiment's VLAN aliases. With an experiment
  name and an alias name, prints the VLAN ID of that alias. With a VLAN ID as
  well, pins the alias to that VLAN ID. With --unpin, clears the pin of the
  alias, so minimega gives it an ID when the experiment starts.

  The experiment must be stopped to pin or unpin an alias, and the alias must
  be in the experiment. A pin is refused when another experiment or a
  minimega namespace uses the VLAN ID, when minimega blacklists it, or when
  minimega does not answer. Use --force to pin it anyway.

  -o json and -o yaml print each alias as an object with its experiment,
  alias and VLAN ID; an alias lookup prints one object. --dry-run with
  --unpin checks the unpin and changes nothing.
phenix vlan alias [experiment name] [alias name] [vlan id] [flags]

Examples

phenix vlan alias
phenix vlan alias <experiment name>
phenix vlan alias <experiment name> <alias name>
phenix vlan alias <experiment name> <alias name> <vlan id>
phenix vlan alias <experiment name> <alias name> --unpin

Options

      --dry-run         Show what the command would change, and change nothing
  -f, --force           Pin the alias even when another experiment or namespace uses the VLAN ID, minimega blacklists it, or minimega does not answer
  -h, --help            help for alias
  -o, --output string   Output format (table, json, yaml) (default "table")
      --unpin           Clear the pin of the alias, so minimega gives it an ID at start

SEE ALSO

phenix vlan blacklist

View or change the minimega VLAN blacklist

Synopsis

View or change the minimega VLAN blacklist

  With no subcommand, lists the VLAN IDs that minimega does not give to any
  alias, one on each line. -o json and -o yaml print the body of
  GET /vlans/blacklist.
phenix vlan blacklist [flags]

Options

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

SEE ALSO

phenix vlan blacklist add

Add a VLAN ID to the minimega blacklist

phenix vlan blacklist add <vlan id> [flags]

Options

  -h, --help   help for add

SEE ALSO

phenix vlan blacklist remove

Remove a VLAN ID from the minimega blacklist

Synopsis

Remove a VLAN ID from the minimega blacklist

  Needs a minimega with the command "clear vlans blacklist <vlan>".
phenix vlan blacklist remove <vlan id> [flags]

Options

      --dry-run   Show what the command would change, and change nothing
  -h, --help      help for remove

SEE ALSO

phenix vlan check

Check VLAN pins and a VLAN range of an experiment against the cluster

Synopsis

Check VLAN pins and a VLAN range of an experiment against the cluster

  Starts from the VLAN pins and the VLAN range that the experiment has, pins
  each --alias, and replaces the range with --range. Then it lists the issues
  that the experiment would have in the cluster: duplicate pins, blacklisted
  pins, range overlaps and pins outside the range. The command changes
  nothing. The experiment does not have to exist. An --alias with the VLAN
  ID 0 has no pin. -o json and -o yaml print the body of POST /vlans/check.
phenix vlan check <experiment name> [flags]

Examples

phenix vlan check my-exp
phenix vlan check my-exp --alias EXP_1=101 --alias EXP_2=102
phenix vlan check my-exp --range 100-199

Options

      --alias stringArray   Pin a VLAN alias to a VLAN ID, as <alias>=<vlan id> (repeatable)
  -h, --help                help for check
  -o, --output string       Output format (table, json, yaml) (default "table")
      --range string        Replace the VLAN range, as <min>-<max>

SEE ALSO

phenix vlan free

Find a block of free VLAN IDs

Synopsis

Find a block of free VLAN IDs

  Prints the first block of --count VLAN IDs in a row, from --min to --max,
  that no experiment pins, minimega does not use or blacklist, and, with
  --outside-ranges, no VLAN range of an experiment holds. -o json and
  -o yaml print the body of GET /vlans/free.
phenix vlan free [flags]

Examples

phenix vlan free
phenix vlan free --count 4 --min 100 --max 199
phenix vlan free --outside-ranges

Options

      --count int        Number of VLAN IDs in a row to find (default 1)
  -h, --help             help for free
      --max int          Highest VLAN ID to give (default 4094)
      --min int          Lowest VLAN ID to give (default 1)
  -o, --output string    Output format (table, json, yaml) (default "table")
      --outside-ranges   Give only VLAN IDs outside the VLAN range of each experiment

SEE ALSO

phenix vlan list

List the VLAN IDs of the cluster

Synopsis

List the VLAN IDs of the cluster

  Merges the VLAN pins and ranges of every experiment with the live aliases
  and the blacklist of minimega, one row for each owner, alias and VLAN ID.
  A second table lists the differences and conflicts.

  -o json and -o yaml print the report of GET /vlans. -o csv prints the rows
  as GET /vlans?format=csv does: one line for each row, then, when no
  --vlan, --state or --issues is given, one line with no ID for each alias
  that has no pin and no live ID.
phenix vlan list [flags]

Examples

phenix vlan list
phenix vlan list --experiment substation-a
phenix vlan list --vlan 101
phenix vlan list --state blacklisted
phenix vlan list --issues
phenix vlan list -o csv > vlans.csv

Options

  -e, --experiment string   Show only this experiment or minimega namespace
  -h, --help                help for list
      --issues              Show only the rows with an issue
  -o, --output string       Output format (table, json, yaml, csv) (default "table")
      --state string        Show only the rows in this state: pinned, allocated or blacklisted
      --vlan string         Show only the rows of this VLAN ID

SEE ALSO

phenix vlan pin-live

Pin the live VLAN IDs of a running experiment

Synopsis

Pin the live VLAN IDs of a running experiment

  Copies the VLAN IDs that minimega gave the aliases of a running experiment
  into its spec, so the next start gives the same IDs.
phenix vlan pin-live <experiment name> [flags]

Options

  -h, --help   help for pin-live

SEE ALSO

phenix vlan range

View, set or clear the VLAN range of an experiment

Synopsis

View, set or clear the VLAN range of an experiment

  With no arguments, lists the VLAN range of every experiment. With an
  experiment name, lists the VLAN range of that experiment. With a range
  minimum and maximum as well, sets the VLAN range of the experiment and
  replaces its current range. With --clear, clears the VLAN range of the
  experiment.

  The experiment must be stopped to set or clear its range. A range that
  leaves out a pinned alias is refused. A range that overlaps the VLAN range
  of another experiment is refused. Use --force to set it anyway.

  -o json and -o yaml print each range as an object with its experiment,
  minimum and maximum. --dry-run with --clear checks the clear and changes
  nothing.
phenix vlan range [experiment name [range minimum range maximum]] [flags]

Examples

phenix vlan range
phenix vlan range <experiment name>
phenix vlan range <experiment name> <range minimum> <range maximum>
phenix vlan range <experiment name> --clear

Options

      --clear           Clear the VLAN range of the experiment
      --dry-run         Show what the command would change, and change nothing
  -f, --force           Set the range even when it overlaps the VLAN range of another experiment
  -h, --help            help for range
  -o, --output string   Output format (table, json, yaml) (default "table")

SEE ALSO

phenix vlan release

Release the VLAN IDs of a minimega namespace that no experiment has

Synopsis

Release the VLAN IDs of a minimega namespace that no experiment has

  Clears the VLAN aliases of the namespace, so minimega can give the IDs to
  other experiments. It refuses a namespace that an experiment has, or whose
  VMs are on its VLAN IDs.
phenix vlan release <namespace> [flags]

Options

      --dry-run   Show what the command would change, and change nothing
  -h, --help      help for release

SEE ALSO