Resource

Enqueue, dequeue, and wait for resource locks

• sfp server resource clearalllocks
• sfp server resource dequeue
• sfp server resource enqueue
• sfp server resource wait

sfp server resource clearalllocks

Clear all locks on a specified resource

USAGE
  $ sfp server resource clearalllocks [--json] [--repository <value>] [-r <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -r, --resource=<value>           [default: gh-vars] The resource to clear locks for
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Clear all locks on a specified resource

ALIASES
  $ sfp resource clearalllocks

EXAMPLES
  $ sfp server resource clearalllocks --repository owner/repo --resource pool-ci

See code: src/commands/server/resource/clearalllocks.ts

sfp server resource dequeue

Release a previously acquired lock on a resource

USAGE
  $ sfp server resource dequeue -t <value> [--json] [--repository <value>] [-r <value>] [-e <value>] [-t <value>]
    [--sfp-server-url <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -r, --resource=<value>           [default: gh-vars] The resource to release the lock for
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
  -t, --ticketid=<value>           (required) The ticket id to unlock
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Release a previously acquired lock on a resource

ALIASES
  $ sfp resource dequeue

EXAMPLES
  $ sfp server resource dequeue --repository owner/repo --resource pool-ci --ticketid abc123

See code: src/commands/server/resource/dequeue.ts

sfp server resource enqueue

Enqueue a lock on a resource for a specified duration

USAGE
  $ sfp server resource enqueue [--json] [--repository <value>] [-r <value>] [-t <value>] [-e <value>] [-t <value>]
    [--sfp-server-url <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -r, --resource=<value>           [default: gh-vars] The resource to be locked for
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
  -t, --leasefor=<value>           [default: 900] The time in seconds you need the resource to be leased for
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Enqueue a lock on a resource for a specified duration

ALIASES
  $ sfp resource enqueue

EXAMPLES
  $ sfp server resource enqueue --repository owner/repo --resource pool-ci --leasefor 900

See code: src/commands/server/resource/enqueue.ts

sfp server resource wait

Wait for a specific resource lock to be available

USAGE
  $ sfp server resource wait -t <value> [--json] [--repository <value>] [-r <value>] [-w <value>] [-e <value>] [-t
    <value>] [--sfp-server-url <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -r, --resource=<value>           [default: gh-vars] The resource to wait for
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
  -t, --ticketid=<value>           (required) The ticket id to wait for
  -w, --wait=<value>               [default: 900] The timeout in seconds for waiting for the lock
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Wait for a specific resource lock to be available

ALIASES
  $ sfp resource wait

EXAMPLES
  $ sfp server resource wait --repository owner/repo --resource pool-ci --ticketid abc123 --wait 900

See code: src/commands/server/resource/wait.ts