Resources CLI APIs

About XPRESSO Resources CLI APIs

XPRESSO provides the following public REST APIs to get and list resources-related (testbeds and execution engine) information.

Testbed CLI APIs

XPRESSO testbed get

• description: get a specific xpresso testbed info

• mandatory arguments:

  --name:

  • description: xpresso testbed name
  • usage: xpresso testbed get --name my_testbed

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO testbed list

• description: get a list of xpresso testbeds and related info

• mandatory arguments: none

• optional arguments:

  --filter:

  • description: filtering testbeds based on defined criteria (tags, name, owner, date_created)
  • usage: xpresso testbed list --filter tags=a,b,c name=my_tb owner=chuck date_created=2019-03-22

  --limit:

  • description: limit the number of matching output
  • usage: xpresso testbed list --limit 10

  --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO testbed create

• description: create a XPRESSO testbed

• mandatory arguments: All parameters are mandatory

• optional arguments:

  --name:

  • description: Testbed name

  --file:

  • description: A valid pyATS testbed.yaml file
  • usage: XPRESSO testbed submit --name testbed_name --max-retention-period 43200 --max-reservation-time 86400 --min-reservation-time 1800 --reservation-disabled False --site OTT --bldg ALL --file /abc/path_to/test.yaml

  --min-reservation-time:

  • description: Minimum reservation time in seconds
  • usage: XPRESSO testbed submit --name testbed_name --file /path/file.yaml --max-retention-period 43200 --max-reservation-time 86400 --reservation-disabled False --site OTT --bldg ALL --min-reservation-time 1800

  --max-reservation-time:

  • description: Maximum reservation time in seconds
  • usage: XPRESSO testbed submit --name testbed_name --file /path/file.yaml --max-retention-period 43200 --reservation-disabled False --site OTT --bldg ALL --min-reservation-time 1800 --max-reservation-time 86400

  --reservation-disabled:

  • description: If reservations should be disabled , True/False
  • usage: XPRESSO testbed submit --name testbed_name --file /path/file.yaml --max-retention-period 43200 --max-reservation-time 86400 --min-reservation-time 1800 --site OTT --bldg ALL --reservation-disabled False

  --max-retention-period:

  • description: Maximum retention period in seconds
  • usage: XPRESSO testbed submit --name testbed_name --file /path/file.yaml --max-reservation-time 86400 --min-reservation-time 1800 --site OTT --bldg ALL --reservation-disabled False --max-retention-period 43200

  --site:

  • description: site name
  • usage: XPRESSO testbed submit --name testbed_name --file /path/file.yaml --max-reservation-time 86400 --min-reservation-time 1800 --reservation-disabled False --max-retention-period 43200 --bldg ALL --site OTT

  --bldg:

  • description: Building
  • usage: XPRESSO testbed submit --name testbed_name --file /path/file.yaml --max-reservation-time 86400 --min-reservation-time 1800 --reservation-disabled False --max-retention-period 43200 --site OTT --bldg ALL

  --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

Topology CLI APIs

XPRESSO topology get

• description: get a specific xpresso topology info

• mandatory arguments:

  --name:

  • description: xpresso topology name
  • usage: xpresso topology get --name my_topology

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO topology list

• description: get a list of xpresso topologies and related info

• mandatory arguments: none

• optional arguments:

  --filter:

  • description: filtering topologys based on defined criteria (tags, name, owner, date_created)
  • usage: xpresso topology list --filter tags=a,b,c name=my_topo owner=chuck date_created=2019-03-22

  --limit:

  • description: limit the number of matching output
  • usage: xpresso topology list --limit 10

  --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.