Pool

Configure and monitor org pools

sfp server pool cleanup

Cleanup sandboxes from a pool being deleted. Deletes sandboxes that are >= 24 hours old from Salesforce. This command is typically run by Hatchet cleanup flows.

USAGE
  $ sfp server pool cleanup -r <value> -t <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -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, --tag=<value>                 (required) Pool tag to cleanup
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --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
  Cleanup sandboxes from a pool being deleted. Deletes sandboxes that are >= 24 hours old from Salesforce. This command
  is typically run by Hatchet cleanup flows.

EXAMPLES
  $ sfp server pool cleanup --repository myorg/myrepo --tag dev_pool

  $ sfp server pool cleanup --repository myorg/myrepo --tag dev_pool --json

See code: src/commands/server/pool/cleanup.tsarrow-up-right

sfp server pool config create

Create a new sandbox pool configuration

See code: src/commands/server/pool/config/create.tsarrow-up-right

sfp server pool config delete

Delete a sandbox pool configuration and all its sandboxes

See code: src/commands/server/pool/config/delete.tsarrow-up-right

sfp server pool config get

Get details of a specific sandbox pool configuration

See code: src/commands/server/pool/config/get.tsarrow-up-right

sfp server pool config list

List all sandbox pool configurations

See code: src/commands/server/pool/config/list.tsarrow-up-right

sfp server pool config push

Push a scratch org pool configuration from a local file to the server

See code: src/commands/server/pool/config/push.tsarrow-up-right

sfp server pool config update

Update an existing sandbox pool configuration

See code: src/commands/server/pool/config/update.tsarrow-up-right

sfp server pool drain

Drop all sandbox/scratch-org instances from a pool by dispatching the cleanup Hatchet workflow with skipFinalize=true. The pool configuration is preserved so the pool can be replenished afterwards. Pass --tag all to drain every active pool in the repository (one workflow per pool).

See code: src/commands/server/pool/drain.tsarrow-up-right

sfp server pool monitor

Monitor a sandbox pool - reconcile states, activate sandboxes, process lifecycle, and provision if needed. This command is typically run by Hatchet scheduled jobs or manually for testing.

See code: src/commands/server/pool/monitor.tsarrow-up-right

sfp server pool replenish

Trigger the pool replenishment Hatchet workflow for a single pool or every active pool (--tag all). The workflow performs reconciliation, lifecycle processing, and quota maintenance asynchronously.

See code: src/commands/server/pool/replenish.tsarrow-up-right

sfp server pool scratch init

Prepare a pool of scratchorgs with all the packages upfront, so that any incoming change can be validated in an optimized manner

See code: src/commands/server/pool/scratch/init.tsarrow-up-right

sfp server pool status

Get detailed status and statistics for a sandbox pool. When a specific pool tag is provided, instance details are shown by default.

See code: src/commands/server/pool/status.tsarrow-up-right

Last updated

Was this helpful?