prb business-function command reference
Reference for 7 commands under prb business-function, including usage, flag types and defaults, required flags, source examples, and implementation links
Manage business functions. This page documents 7 commands under prb business-function.
Flags and examples below come from the command definitions. A Required flag is explicitly marked required by Cobra; an unmarked flag can still be needed by runtime validation or a non-interactive workflow. Empty strings and empty lists are registered defaults, not sample values.
Every command also inherits the global flags. Run prb <command> --help to check your installed version. Replace placeholder IDs and names in source examples before running them. Return to the complete CLI command reference to browse another command.
Commands
Section titled “Commands”| Command | Description | Usage | Source |
|---|---|---|---|
prb business-function | Manage business functions. | prb business-function <command> | View implementation |
prb business-function create | Create a new business function. | prb business-function create | View implementation |
prb business-function delete | Delete a business function. | prb business-function delete <id> | View implementation |
prb business-function list | List business functions in an organization. | prb business-function list | View implementation |
prb business-function publish | Publish the business function register as a document version. | prb business-function publish | View implementation |
prb business-function update | Update a business function. | prb business-function update <id> | View implementation |
prb business-function view | View a business function. | prb business-function view <id> | View implementation |
prb business-function
Section titled “prb business-function”Manage business functions.
prb business-function <command>prb business-function create
Section titled “prb business-function create”Create a new business function.
prb business-function createAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--asset | string array | [] | — | Asset ID (can be repeated) |
--classification | string | "" | — | Classification: CRITICAL, IMPORTANT, SECONDARY, STANDARD (required) |
--impact-tolerance | string | "" | — | Impact tolerance |
--mtd-minutes | integer | 0 | — | Maximum tolerable downtime in minutes (required) |
--name | string | "" | — | Business function name (required) |
--notes | string | "" | — | Notes |
--org | string | "" | — | Organization ID |
--owner | string | "" | — | Owner profile ID |
--rpo-minutes | integer | 0 | — | Recovery point objective in minutes (required) |
--rto-minutes | integer | 0 | — | Recovery time objective in minutes (required) |
--third-party | string array | [] | — | Third party ID (can be repeated) |
Examples
Section titled “Examples”# Create a business function interactivelyprb business-function create
# Create a business function non-interactivelyprb business-function create --name "Payments" --classification CRITICAL --mtd-minutes 60 --rto-minutes 30 --rpo-minutes 15prb business-function delete
Section titled “prb business-function delete”Delete a business function.
prb business-function delete <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
prb business-function list
Section titled “prb business-function list”List business functions in an organization.
prb business-function listAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--classification | string | "" | — | Filter by classification (CRITICAL, IMPORTANT, SECONDARY, STANDARD) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of business functions to list |
--order-by | string | "" | — | Order by field (CREATED_AT, REFERENCE_ID, NAME, CLASSIFICATION, MTD_MINUTES, RTO_MINUTES, RPO_MINUTES) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--org | string | "" | — | Organization ID |
--output, -o | string | "" | — | Output format: json, table (default) |
Examples
Section titled “Examples”# List business functions in the default organizationprb business-function list
# List critical business functions onlyprb business-function ls --classification CRITICAL --output jsonprb business-function publish
Section titled “prb business-function publish”Publish the business function register as a document version.
prb business-function publish| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--approver | string array | [] | — | Approver profile ID (can be repeated; ignored with —minor) |
--minor | boolean | false | — | Publish as a minor version (no approval flow) |
--org | string | "" | — | Organization ID |
Examples
Section titled “Examples”# Publish the business function registerprb business-function publish --org ORG_ID
# Publish with approversprb business-function publish --org ORG_ID --approver PROFILE_ID1 --approver PROFILE_ID2prb business-function update
Section titled “prb business-function update”Update a business function.
prb business-function update <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--asset | string array | [] | — | Asset ID (can be repeated) |
--classification | string | "" | — | Classification: CRITICAL, IMPORTANT, SECONDARY, STANDARD |
--impact-tolerance | string | "" | — | Impact tolerance |
--mtd-minutes | integer | 0 | — | Maximum tolerable downtime in minutes |
--name | string | "" | — | Business function name |
--notes | string | "" | — | Notes |
--owner | string | "" | — | Owner profile ID |
--rpo-minutes | integer | 0 | — | Recovery point objective in minutes |
--rto-minutes | integer | 0 | — | Recovery time objective in minutes |
--third-party | string array | [] | — | Third party ID (can be repeated) |
prb business-function view
Section titled “prb business-function view”View a business function.
prb business-function view <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |