XPRESSO

Working with XPRESSO CLI APIs

NOTE:
The XPRESSO CLI is intended for submitting job requests and fetching the needed information to effectively do so. Use the full XPRESSO application to manage users and resources.

Supported CLI APIs with XPRESSO

Refer to the following list of supported CLI API commands in XPRESSO.

  • Management CLI APIs: Provides access to the following Management-related CLI APIs:

    • all Help CLI commands
    • XPRESSO login details
    • XPRESSO configuration settings
    • XPRESSO configuration listing
    • optional arguments

  • Environment CLI APIs: Provides access to the following environment-related CLI APIs:

    • Operating System (OS): Get | List
    • Platforms: Get | List
    • Branch: Get | List | Register

  • Resource CLI APIs: Provides access to the following Resource-related CLI APIs:

    • Testbeds: Get | List
    • Topologies: Get | List

  • Job CLI APIs: Provides access to the following Job-related REST API:

    • Job: Get | List

  • Reservation CLI APIs: Provides access to the following Reservation-related REST API:

    • Reservation: Get | List | Extend | Release

  • Requests, Bundle, Results, and Baseline CLI APIs: Provides access to the following Requests, Bundle, Results, and Baseline-related CLI APIs:

    • Standalone Requests: Get | List | Submit | Stop
    • Bundled Requests: Get | List
    • Results: Compare | Attach
    • Baseline: Compare | List | Propagate | Set | Set-attribute | Unset | Unset-attribute | Update

General CLI API usage rules

General CLI API command usage rules in XPRESSO include:

  • Ensure you are working in the following directory: /auto/pyats/bin/xpresso.
  • You must be logged in to run any XPRESSO CLI command; for example to run xpresso job list.
  • Help lists are layered and limited to the current command you are trying to execute. For example: /auto/pyats/bin/xpresso job --help will only display the parameters for the 'job' command.
Next