Skip to content

Suggested searches

    Search all documentation ↑↓ to navigate Enter to open Esc to close

    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

    Markdown

    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.

    CommandDescriptionUsageSource
    prb business-functionManage business functions.prb business-function <command>View implementation
    prb business-function createCreate a new business function.prb business-function createView implementation
    prb business-function deleteDelete a business function.prb business-function delete <id>View implementation
    prb business-function listList business functions in an organization.prb business-function listView implementation
    prb business-function publishPublish the business function register as a document version.prb business-function publishView implementation
    prb business-function updateUpdate a business function.prb business-function update <id>View implementation
    prb business-function viewView a business function.prb business-function view <id>View implementation

    Manage business functions.

    prb business-function <command>

    View command implementation.

    Create a new business function.

    prb business-function create

    Accepts no positional arguments.

    FlagTypeDefaultRequiredDescription
    --assetstring array[]—Asset ID (can be repeated)
    --classificationstring""—Classification: CRITICAL, IMPORTANT, SECONDARY, STANDARD (required)
    --impact-tolerancestring""—Impact tolerance
    --mtd-minutesinteger0—Maximum tolerable downtime in minutes (required)
    --namestring""—Business function name (required)
    --notesstring""—Notes
    --orgstring""—Organization ID
    --ownerstring""—Owner profile ID
    --rpo-minutesinteger0—Recovery point objective in minutes (required)
    --rto-minutesinteger0—Recovery time objective in minutes (required)
    --third-partystring array[]—Third party ID (can be repeated)
    Terminal window
    # Create a business function interactively
    prb business-function create
    # Create a business function non-interactively
    prb business-function create --name "Payments" --classification CRITICAL --mtd-minutes 60 --rto-minutes 30 --rpo-minutes 15

    View command implementation.

    Delete a business function.

    prb business-function delete <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --yes, -ybooleanfalse—Skip confirmation prompt

    View command implementation.

    List business functions in an organization.

    prb business-function list

    Accepts no positional arguments.

    FlagTypeDefaultRequiredDescription
    --afterstring""—Cursor from the previous page (the Next cursor line)
    --classificationstring""—Filter by classification (CRITICAL, IMPORTANT, SECONDARY, STANDARD)
    --jsonbooleanfalse—Output JSON (same as —output json)
    --limit, -Linteger30—Maximum number of business functions to list
    --order-bystring""—Order by field (CREATED_AT, REFERENCE_ID, NAME, CLASSIFICATION, MTD_MINUTES, RTO_MINUTES, RPO_MINUTES)
    --order-directionstring"DESC"—Sort direction (ASC, DESC)
    --orgstring""—Organization ID
    --output, -ostring""—Output format: json, table (default)
    Terminal window
    # List business functions in the default organization
    prb business-function list
    # List critical business functions only
    prb business-function ls --classification CRITICAL --output json

    View command implementation.

    Publish the business function register as a document version.

    prb business-function publish
    FlagTypeDefaultRequiredDescription
    --approverstring array[]—Approver profile ID (can be repeated; ignored with —minor)
    --minorbooleanfalse—Publish as a minor version (no approval flow)
    --orgstring""—Organization ID
    Terminal window
    # Publish the business function register
    prb business-function publish --org ORG_ID
    # Publish with approvers
    prb business-function publish --org ORG_ID --approver PROFILE_ID1 --approver PROFILE_ID2

    View command implementation.

    Update a business function.

    prb business-function update <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --assetstring array[]—Asset ID (can be repeated)
    --classificationstring""—Classification: CRITICAL, IMPORTANT, SECONDARY, STANDARD
    --impact-tolerancestring""—Impact tolerance
    --mtd-minutesinteger0—Maximum tolerable downtime in minutes
    --namestring""—Business function name
    --notesstring""—Notes
    --ownerstring""—Owner profile ID
    --rpo-minutesinteger0—Recovery point objective in minutes
    --rto-minutesinteger0—Recovery time objective in minutes
    --third-partystring array[]—Third party ID (can be repeated)

    View command implementation.

    View a business function.

    prb business-function view <id>

    Requires 1 positional argument.

    FlagTypeDefaultRequiredDescription
    --jsonbooleanfalse—Output JSON (same as —output json)
    --output, -ostring""—Output format: json, table (default)

    View command implementation.