Skip to main content

OrBIT User Guide

OrBIT commands

In this section:

The OrBIT invocation syntax is:

orbit command [options] [arguments]

The order of the options that some commands take is not important.

For more information, see The OrBIT command line application.

Commands

The OrBIT commands are:

Command

Description

createPpkg

Generates a product package file (.ppkg).

getProductTemplates

Generates a list of Product Templates. See Product template.

getSampleConfigs

Generates sample files that you can base your configuration files on. See Configuration files.

getSupportedDevices

Generates a list of supported target device families.

header

Generates a C-style header file from a Dynamic provisioning configuration file. This command is only available in the eSecIP Professional edition.

Table 15. OrBIT commands


Global options

The OrBIT global options can be used together with any command. The global options are:

Global option

Description

--help|-h

Displays help information for the chosen command.

--output

Generates a file with the output from the command.

--version|-v

Displays version information for OrBIT.

Table 16. OrBIT global options


Command-specific options

A number of OrBIT options can only be specified together with a certain command. The command-specific options for OrBIT are:

Command

Option

Description

createPpkg

--bulk

Overrides prompts for missing passphrases.

--count

Sets the number of authorized products that can be provisioned.

--deviceName

Specifies the name of the target device family to provision.

--manufacturingConfiguration

Specifies the manufacturing configuration file

--oemIdentity

Specifies the path to the OEM Identity file.

--oemIdentityPassphrase

Specifies the passphrase for accessing the OEM signing key.

--output

Specifies where to generate the PPKG file.

--prEncryptPassphrase

Specifies the passphrase for accessing the Production Record (PR) encryption key.

--productConfiguration

Specifies the product configuration file.

--productName

Sets the name of the product as displayed in the applications Secure Deploy – Manufacturing and Secure Deploy – Prototyping.

--productTemplate

Specifies the name of a Product template file to use.

--prSignPassphrase

Specifies the passphrase for accessing the Production Record (PR) signing key.

--saCertificates

Specifies the path to the Security Appliance certificates file.

--verbose

Echoes the options used to create the PPKG to the command line.

getSampleConfigs

--productTemplate

Specifies the name of a Product template file.

Table 17. Summary of command-specific options


There are no command-specific options available for the commands getProductTemplates, getSupportedDevices, header, help, and version.