Docs
flxbl.ioStatusContact us
codevsfp CLIsfp serverlibraries

Pool

Manage scratch org and sandbox pools in sfp server

sfp server pool config create

Create a new sandbox pool configuration

USAGE
  $ sfp server pool config create -r <value> -n <value> -t <value> --dev-hub-username <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] [--sandbox-def-file <value>] [--source-sandbox
    <value>] [--branch-pattern <value>] [--min-instances <value>] [--max-instances <value>] [--days-keep-available
    <value>] [--refresh-strategy AUTO_REFRESH_EXPIRED|DELETE_EXPIRED|FLAG_EXPIRED|NOTIFY_ONLY] [--active]
    [--default-expiration-hours <value>] [--extended-expiration-hours <value>] [--avg-creation-time <value>]
    [--users-to-activate <value>...] [--post-creation-script <value>] [--data-seed-plan <value>]
    [--return-to-pool-on-unassign]

FLAGS
  -e, --email=<value>                      [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                           --application-token is provided.
  -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.
  -n, --name=<value>                       (required) Display name for the pool
  -r, --repository=<value>                 (required) Repository identifier in format org/repo
  -t, --application-token=<value>          [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes
                                           precedence over --email.
  -t, --tag=<value>                        (required) Unique tag identifier for the pool
      --active                             Whether the pool should be active immediately
      --avg-creation-time=<value>          [default: 30] Average time in minutes to create a sandbox
      --branch-pattern=<value>             Git branch pattern to associate with this pool (e.g., feature/*)
      --data-seed-plan=<value>             Path to data seed plan file
      --days-keep-available=<value>        [default: 3] Days to keep unassigned available sandboxes
      --default-expiration-hours=<value>   [default: 24] Default hours before a sandbox expires
      --dev-hub-username=<value>           (required) Username or alias of the Dev Hub to use for sandbox creation
      --extended-expiration-hours=<value>  [default: 72] Hours to extend when extension is requested
      --loglevel=<option>                  [default: info] logging level for this command invocation
                                           <options:
                                           trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --max-instances=<value>              [default: 10] Maximum total instances allowed in the pool
      --min-instances=<value>              [default: 3] Minimum number of available instances to maintain
      --post-creation-script=<value>       Path to script to run after sandbox creation
      --refresh-strategy=<option>          [default: AUTO_REFRESH_EXPIRED] Strategy for handling expired sandboxes
                                           <options: AUTO_REFRESH_EXPIRED|DELETE_EXPIRED|FLAG_EXPIRED|NOTIFY_ONLY>
      --return-to-pool-on-unassign         When true, unassigned sandboxes return to pool as AVAILABLE with reset timer.
                                           When false (default), they are marked as EXPIRED
      --sandbox-def-file=<value>           Path to the sandbox definition file
      --sfp-server-url=<value>             [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment
                                           variable `SFP_SERVER_URL` or config: sfp config:set server-url
      --source-sandbox=<value>             Name of the source sandbox to clone from
      --users-to-activate=<value>...       List of user emails to activate in each sandbox

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create a new sandbox pool configuration

EXAMPLES
  $ sfp server pool config create --repository myorg/myrepo --name "Development Pool" --tag dev_pool --dev-hub-username devhub@mycompany.com --min-instances 3 --max-instances 10

  $ sfp server pool config create --repository myorg/myrepo --name "CI Pool" --tag ci_pool --dev-hub-username devhub@mycompany.com --sandbox-def-file config/project-scratch-def.json --source-sandbox SOURCE_SB

See code: src/commands/server/pool/config/create.ts

sfp server pool config delete

Delete a sandbox pool configuration and all its sandboxes

USAGE
  $ sfp server pool config delete -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] [--no-confirm]

FLAGS
  -e, --email=<value>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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 org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag to delete
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --no-confirm                  Skip confirmation prompt
      --sfp-server-url=<value>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a sandbox pool configuration and all its sandboxes

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

  $ sfp server pool config delete --repository myorg/myrepo --tag dev_pool --no-confirm

See code: src/commands/server/pool/config/delete.ts

sfp server pool config get

Get details of a specific sandbox pool configuration

USAGE
  $ sfp server pool config get -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>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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 org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag to retrieve
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get details of a specific sandbox pool configuration

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

See code: src/commands/server/pool/config/get.ts

sfp server pool config list

List all sandbox pool configurations

USAGE
  $ sfp server pool config list [--json] [-r <value>] [-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>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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>          Filter by repository identifier in format org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all sandbox pool configurations

EXAMPLES
  $ sfp server pool config list

  $ sfp server pool config list --repository myorg/myrepo

See code: src/commands/server/pool/config/list.ts

sfp server pool config update

Update an existing sandbox pool configuration

USAGE
  $ sfp server pool config update -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] [-n <value>]
    [--dev-hub-username <value>] [--sandbox-def-file <value>] [--source-sandbox <value>] [--branch-pattern <value>]
    [--min-instances <value>] [--max-instances <value>] [--days-keep-available <value>] [--refresh-strategy
    AUTO_REFRESH_EXPIRED|DELETE_EXPIRED|FLAG_EXPIRED|NOTIFY_ONLY] [--active] [--default-expiration-hours <value>]
    [--extended-expiration-hours <value>] [--avg-creation-time <value>] [--users-to-activate <value>...]
    [--post-creation-script <value>] [--data-seed-plan <value>] [--return-to-pool-on-unassign]

FLAGS
  -e, --email=<value>                      [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                           --application-token is provided.
  -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.
  -n, --name=<value>                       New display name for the pool
  -r, --repository=<value>                 (required) Repository identifier in format org/repo
  -t, --application-token=<value>          [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes
                                           precedence over --email.
  -t, --tag=<value>                        (required) Pool tag to update
      --[no-]active                        Set pool active status
      --avg-creation-time=<value>          New average creation time in minutes
      --branch-pattern=<value>             New Git branch pattern
      --data-seed-plan=<value>             New data seed plan path
      --days-keep-available=<value>        New days to keep unassigned available sandboxes
      --default-expiration-hours=<value>   New default expiration hours
      --dev-hub-username=<value>           New Dev Hub username or alias
      --extended-expiration-hours=<value>  New extended expiration hours
      --loglevel=<option>                  [default: info] logging level for this command invocation
                                           <options:
                                           trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --max-instances=<value>              New maximum total instances
      --min-instances=<value>              New minimum number of available instances
      --post-creation-script=<value>       New post creation script path
      --refresh-strategy=<option>          New strategy for handling expired sandboxes
                                           <options: AUTO_REFRESH_EXPIRED|DELETE_EXPIRED|FLAG_EXPIRED|NOTIFY_ONLY>
      --[no-]return-to-pool-on-unassign    When true, unassigned sandboxes return to pool as AVAILABLE. When false, they
                                           are marked as EXPIRED
      --sandbox-def-file=<value>           New path to the sandbox definition file
      --sfp-server-url=<value>             [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment
                                           variable `SFP_SERVER_URL` or config: sfp config:set server-url
      --source-sandbox=<value>             New source sandbox name
      --users-to-activate=<value>...       New list of users to activate

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Update an existing sandbox pool configuration

EXAMPLES
  $ sfp server pool config update --repository myorg/myrepo --tag dev_pool --min-instances 5 --max-instances 15

  $ sfp server pool config update --repository myorg/myrepo --tag dev_pool --active false

  $ sfp server pool config update --repository myorg/myrepo --tag dev_pool --refresh-strategy DELETE_EXPIRED

See code: src/commands/server/pool/config/update.ts

sfp server pool instance delete

Force delete a sandbox instance from a pool. ERROR status instances are always deleted from database even if Salesforce deletion fails.

USAGE
  $ sfp server pool instance delete -r <value> -t <value> -s <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] [-f]

FLAGS
  -e, --email=<value>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -f, --force                       Force deletion even if: sandbox is less than 24 hours old, is immortal, or
                                    Salesforce deletion fails (for non-ERROR instances)
  -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 org/repo
  -s, --sandbox=<value>             (required) Name of the sandbox to delete
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag where the sandbox belongs
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Force delete a sandbox instance from a pool. ERROR status instances are always deleted from database even if
  Salesforce deletion fails.

EXAMPLES
  $ sfp server pool instance delete --repository myorg/myrepo --tag dev_pool --sandbox 123456

  $ sfp server pool instance delete --repository myorg/myrepo --tag dev_pool --sandbox 123456 --force

  $ # ERROR status instances are always deleted from database even if Salesforce deletion fails

See code: src/commands/server/pool/instance/delete.ts

sfp server pool instance extend

Extend the expiration time of an assigned sandbox and optionally change its immortal state

USAGE
  $ sfp server pool instance extend -r <value> -t <value> --assignment-id <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] [--extension-hours <value>] [--immortal]

FLAGS
  -e, --email=<value>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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 org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag where the sandbox belongs
      --assignment-id=<value>       (required) Assignment ID of the sandbox to extend
      --extension-hours=<value>     Number of hours to extend (defaults to pool configuration)
      --[no-]immortal               Set or change the immortal state of the sandbox (use --no-immortal to remove
                                    immortal status)
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Extend the expiration time of an assigned sandbox and optionally change its immortal state

EXAMPLES
  $ sfp server pool instance extend --repository myorg/myrepo --tag dev_pool --assignment-id PR-123

  $ sfp server pool instance extend --repository myorg/myrepo --tag dev_pool --assignment-id PR-123 --extension-hours 48

  $ sfp server pool instance extend --repository myorg/myrepo --tag dev_pool --assignment-id PR-123 --immortal

  $ sfp server pool instance extend --repository myorg/myrepo --tag dev_pool --assignment-id PR-123 --no-immortal

See code: src/commands/server/pool/instance/extend.ts

sfp server pool instance fetch

Fetch an available sandbox from the pool

USAGE
  $ sfp server pool instance fetch -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] [--assignment-id
    <value>] [--expiration-hours <value>] [--immortal]

FLAGS
  -e, --email=<value>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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 org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag to fetch from
      --assignment-id=<value>       Unique identifier for this assignment (e.g., PR-123, JIRA-456). If provided and a
                                    sandbox is already assigned to this ID, it will be reused
      --expiration-hours=<value>    Hours until the sandbox expires (overrides pool default)
      --immortal                    Make the sandbox immortal (never expires)
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Fetch an available sandbox from the pool

EXAMPLES
  $ sfp server pool instance fetch --repository myorg/myrepo --tag dev_pool --assignment-id PR-123

  $ sfp server pool instance fetch --repository myorg/myrepo --tag dev_pool --assignment-id PR-123 --expiration-hours 48

  $ sfp server pool instance fetch --repository myorg/myrepo --tag dev_pool --assignment-id PR-123 --immortal

See code: src/commands/server/pool/instance/fetch.ts

sfp server pool instance list

List all instances in a sandbox pool

USAGE
  $ sfp server pool instance list -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] [-s
    REQUESTED|PROVISIONING|ACTIVATING|AVAILABLE|ASSIGNED|ERROR]

FLAGS
  -e, --email=<value>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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 org/repo
  -s, --status=<option>             Filter by instance status
                                    <options: REQUESTED|PROVISIONING|ACTIVATING|AVAILABLE|ASSIGNED|ERROR>
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag to list instances from
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all instances in a sandbox pool

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

  $ sfp server pool instance list --repository myorg/myrepo --tag dev_pool --status AVAILABLE

See code: src/commands/server/pool/instance/list.ts

sfp server pool instance unassign

Unassign a sandbox and return it to the available pool

USAGE
  $ sfp server pool instance unassign -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] [--assignment-id
    <value> | --sandbox-id <value>]

FLAGS
  -e, --email=<value>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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 org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag where the sandbox belongs
      --assignment-id=<value>       Assignment ID of the sandbox to unassign
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sandbox-id=<value>          Sandbox ID to unassign directly (e.g., sb-pool-tag-sandboxname)
      --sfp-server-url=<value>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Unassign a sandbox and return it to the available pool

EXAMPLES
  $ sfp server pool instance unassign --repository myorg/myrepo --tag dev_pool --assignment-id PR-123

  $ sfp server pool instance unassign --repository myorg/myrepo --tag dev_pool --sandbox-id abc123def456

See code: src/commands/server/pool/instance/unassign.ts

sfp server pool provision

Provision new sandbox instances to meet pool capacity requirements

USAGE
  $ sfp server pool provision -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>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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 org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag to provision, or 'all' to provision all active pools
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Provision new sandbox instances to meet pool capacity requirements

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

  $ sfp server pool provision --repository myorg/myrepo --tag all

See code: src/commands/server/pool/provision.ts

sfp server pool replenish

Run complete pool replenishment workflow including reconciliation, lifecycle processing, and quota maintenance

USAGE
  $ sfp server pool replenish -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>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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 org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 (required) Pool tag to replenish
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Run complete pool replenishment workflow including reconciliation, lifecycle processing, and quota maintenance

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

See code: src/commands/server/pool/replenish.ts

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.

USAGE
  $ sfp server pool status -r <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] [-t <value>] [-i] [--filter-status
    ERROR|ASSIGNED|AVAILABLE|PROVISIONING|ACTIVATING|EXPIRED|DELETING]

FLAGS
  -e, --email=<value>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -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.
  -i, --[no-]instances              Show detailed instance information (default: true when tag is provided, use
                                    --no-instances to hide)
  -r, --repository=<value>          (required) Repository identifier in format org/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --tag=<value>                 Pool tag to get status for. When provided, instance details are shown by default
      --filter-status=<option>      Filter instances by status (ERROR, ASSIGNED, AVAILABLE, etc.)
                                    <options: ERROR|ASSIGNED|AVAILABLE|PROVISIONING|ACTIVATING|EXPIRED|DELETING>
      --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>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

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

EXAMPLES
  $ sfp server pool status --repository myorg/myrepo --tag dev_pool  # Shows pool summary + instances

  $ sfp server pool status --repository myorg/myrepo  # Shows all pools summary

  $ sfp server pool status --repository myorg/myrepo --tag dev_pool --no-instances  # Pool summary only

  $ sfp server pool status --repository myorg/myrepo --tag dev_pool --filter-status ERROR  # Show only ERROR instances

See code: src/commands/server/pool/status.ts

Org

Previous Page

Project

Next Page

On this page

sfp server pool config createsfp server pool config deletesfp server pool config getsfp server pool config listsfp server pool config updatesfp server pool instance deletesfp server pool instance extendsfp server pool instance fetchsfp server pool instance listsfp server pool instance unassignsfp server pool provisionsfp server pool replenishsfp server pool status