Skip to end of metadata
Go to start of metadata

foamctl is the primary interface for administrative control of FOAM. This is the interface by which administrator can approve and reject slivers, as well as configure essential FOAM options.

For those commands which support common options, those are:

-n / --name

Hostname of FOAM instance, defaults to localhost

--user

Username, defaults to foamadmin

--passwd-file

File containing admin user password

Command Name

Options

Description

init-db

DO NOT USE COMMAND LINE OPTIONS (FOAM-57)

Initializes database for FOAM operation - must be called before FOAM is started. Calling without commandline options will query the user interactively with sane defaults for most options.

set-password

--foam-admin-passwd-file (File containing password for foamadmin user

Sets the password used by nginx and FOAM for the admin user

bundle-certs

no arguments

Bundles the certifications for use by nginx. Must be called if certificates are added.

add-datapath

common options
-d / --dpid

Creates a datapath in the FOAM database that will be advertised as if it had once connected to the FlowVisor. Will always be marked as down in advertisements (unless it actually shows up later).

approve-sliver

common options
-u / --urn (sliver URN)
-p / --priority (FlowVisor slice priority)

Approves the indicated sliver rspec and installs the slice and flowspace into FlowVisor with the specified priority.

disable-sliver

common options
-u / --urn (Sliver URN)

Disables the sliver specified. Marks the sliver as disabled in FOAM and removes it from FlowVisor if previously approved.

delete-sliver

common options
-u / --urn (Sliver URN)

Deletes the specified sliver. Marks the sliver as deleted in FOAM and removes it from FlowVisor if previously approved.

get-config

common options
-k / --key (Config Item Key)

Returns the value for the given config key.

get-version

common options

Returns the running FOAM version.

list-slivers

common options
-d / --deleted (Show deleted slivers only)
-s / --status=[approved|DOCS:rejected|pending]

Lists all slivers matching the argument criteria.

reject-sliver

common options
-u / --urn (Sliver URN)

Rejects the specified sliver. Marks the sliver as rejected in FOAM and removes it from FlowVisor if previously approved.

remove-datapath

common options
-d / --dpid

Removes the specified datapath from the database. Note this will not prevent the datapath from reappearing when FOAM re-queries the FlowVisor. This is only useful for clearing location data or datapaths which will no longer be present on this FlowVisor.

show-sliver

common options
-u / --urn (Sliver URN)
-f / --flowspace (Show flowspace)
-s / --flowspec (Show flowspec)
-r / --rspec (Show request rspec)

Shows information for the sliver specified. Additional options provide additional data.

  • No labels