XPRESSO

Environment CLI APIs

About XPRESSO Environment CLI APIs

XPRESSO provides the following public CLI APIs to get, list, or register environment-related (OS, Platform, and Branch) information.

OS CLI APIs

XPRESSO OS get

  • description: get a specific xpresso os info

  • mandatory arguments:

    --name:

    • description: xpresso os name
    • usage: xpresso os get --name my_os

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

XPRESSO OS list

  • description: get a list of xpresso os info

  • mandatory arguments: none

  • optional arguments:

    --filter:

    • description: filtering os based on defined criteria (name)
    • usage: xpresso os list --filter name=my_os1,my_os2

    --limit:

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

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

Platforms CLI APIs

XPRESSO platform get

  • description: get a specific xpresso platform info

  • mandatory arguments:

    --name:

    • description: xpresso platform name
    • usage: xpresso platform get --name my_platform

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

XPRESSO platform list

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

  • mandatory arguments: none

  • optional arguments:

    --filter:

    • description: filtering platforms based on defined criteria (name, os)
    • usage: xpresso platform list --filter name=my_platform1,my_platform2 os=iosxe,nxos

    --limit:

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

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

Branch CLI APIs

XPRESSO branch get

  • description: get a specific xpresso branch info

  • mandatory arguments:

    --name:

    • description: xpresso branch name
    • usage: xpresso branch get --name my_branch

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

XPRESSO branch list

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

  • mandatory arguments: none

  • optional arguments:

    --filter:

    • description: filtering branches based on defined criteria (name, os)
    • usage: xpresso branch list --filter name=my_branch1,my_branch2 os=iosxe,nxos

    --limit:

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

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

XPRESSO branch register

  • description: register a new branch on xpresso

  • mandatory arguments:

    --os:

    • description: branch os info
    • usage: xpresso branch register --os ios --name my_branch

    --name:

    • description: branch name
    • usage: xpresso branch register --os ios --name my_branch

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

Next