Commands
The API service supports the commands described in this topic, constructed as follows:
- All commands take zero or more arguments.
- Argument names that end with _id must be numeric values that represent the type of entity specified.
- All other arguments are string values.
- Use double quotes (" ") to enclose arguments that contain spaces.
- Enclose each optional argument in the command declaration into square brackets, [ ].
The commands are organized into the following sections:
- Analyzer command
- Blueprint (channel template) commands
- Bridge (server) commands
- Channel commands
- Deployment commands
- Environment commands
- Global commands
- Instance commands
- Module command
- Notification command
- Pack command
- Package commands
- Process commands
- Repository commands
- Role command
- Route commands
- Schedule commands
- User command
- VM command
- Load Balancer commands
For some usage examples, see Socket-based-protocol-example.
Analyzer command
- analyzer list
Lists the analyzers currently defined for use with references
Blueprint (channel template) commands
- blueprint concurrency <blueprint> <number>
Sets the number of deployment processes that can run at the same time on a channel with a channel template of the <blueprint> type blueprint list [<channel template>]
Lists the available blueprints(channel templates).Optionally filtered by <channel template>.
If <channel template> equals integer, only channel template with specified ID is shown.
If <channel template> equals string, only channel template with specified value is shown.
If <channel template> equals Regex (e.g. %test%), all channel templates that fit this Regex are shown.- blueprint add <pack> <name> <role> | 0
Creates a new channel template with the specified <name> of the specified <pack> type and associates it with <role>, where <pack> can be either the pack ID or the pack name. If the role argument is 0 (zero), the repository is available to all users. blueprint (channel template) channel list <blueprint>
Lists the channels using the blueprint(channel template) <blueprint>.- blueprint delete <blueprint>
Deletes from the system the specified channel template of the <blueprint> type, which must not be in use by any channels - blueprint property list <blueprint>
Lists the environment properties assigned to the specified channel template of the <blueprint> type. - blueprint property add <blueprint> <name> <value>
Adds a new environment variable property to the specified channel template of the <blueprint> type. The property <name> string must conform to the environment variable name requirements. - blueprint property delete <blueprint> <name>
Deletes the named environment variable property from the specified channel template of the <blueprint> type. - blueprint role add <blueprint> <name>
Adds the role <name> to the specified <blueprint>. - blueprint role delete<blueprint> <name>
Deletes the role <name> from the specified <blueprint>. - blueprint role list <blueprint>
List the roles defined for the specified <blueprint>. - blueprint sync <blueprint>
Schedules a sync operation for all channels that are children of the specified channel template of the <blueprint> type. The operation has no effect if the managed property of the template is not enabled. See the blueprint managed command. blueprint managed <blueprint> on | off
Sets the channel template managed property on or off. Channels of managed templates perform configuration sync actions upon deployments.- blueprint refchannel <blueprint> <channel> | 0
Sets the reference channel for the channel template. If the second argument is 0 (zero), the reference channel is cleared. If a channel is specified, the template reference channel is set to that channel.
Bridge (server) commands
- bridge add <hostname> <role> [<vm>] [-d <dispatcher> <platform>]
Adds a new bridge using <hostname> with the specified <role>. Optionally associates the bridge with the virutual configuration <vm> and a dispatcher uri -d <dispatcher> and remote platform <platform>. For the remote platform, use the values of Windows or Unix. bridge (server) channel list <bridge>
Lists the channels using the bridge(server) <bridge>.- bridge delete <hostname>
Deletes the server identified by <hostname>. Servers can be deleted only if they are not in use by a VM definition or a channel. bridge list [<server>]
Lists the bridges (servers) defined in the BMC Release Package Deployment database.
Optionally filtered by <server>.
If <server> equals integer, only server with the specified ID is shown.
If <server> equals string, only server with the specified value is shown.
If <server> equals Regex (e.g. %test%), all servers that fit this Regex are shown.- bridge property add <bridge(server)> <name> <value>
Adds a new environment variable property of <name> and <value> to the specified <bridge(server)>. The <name> string must conform to environment variable name requirements. If the property already exists, the function fails. - bridge property delete <bridge(server)> <name>
Deletes the named environment variable property from the specified <bridge(server)>. - bridge property list <bridge(server)>
Lists the environment properties defined for the specified <bridge(server)>. - bridge role add <bridge> <name>
Adds the role <name> to the specified <bridge>. - bridge role delete <bridge> <name>
Deletes the role <name> from the specified <bridge>. - bridge role list <bridge>
Lists the roles defined for the specified <bridge>.
Channel commands
- channel add <blueprint> <bridge> <name>
Adds a new channel called <name>, using the specified channel template of the <blueprint> type and the specified <bridge>. - channel delete <channel>
Deletes the specified <channel>. The channel cannot be a member of any environment. - channel bridge (server) list <channel>
Lists the bridge (server) associated with the channel <channel>. - channel blueprint (channel template) list <channel>
Lists the blueprint (channel template) associated with the channel <channel>.
channel list [<channel>]
Lists the channels currently defined in the BMC Release Package Deployment database.
Optionally filtered by <channel>.
If <channel> equals integer, only channel with specified ID is shown.
If <channel> equals string, only channel with specified value is shown.
If <channel> equals Regex, (e.g. %test%) all channels that fit this Regex are shown.- channel property add <channel> <name> <value>
Adds a new environment variable property of <name> and <value> to the specified <channel>. The <name> string must conform to environment variable name requirements. If the property already exists, the function fails. - channel property delete <channel> <name>
Deletes the named environment variable property from the specified <channel>. - channel property list <channel>
Lists the environment properties defined for the specified <channel>. - channel role list<channel>
Lists the roles defined for the specified <channel>. - channel sync <channel>
Initiates a configuration sync operation on the specified <channel>
- channel lbs add<channel> <lbs>
Adds a load balancer <lbs> to a specified channel <channel>. - channel lbs delete<channel>
Deletes a load balancer from the specified channel <channel>.
Deployment commands
- deploy list [<deployment>]
Lists the deployments in the BMC Release Package and Deployment database.
Optionally filtered by <deployment>.
if <deployment> equals integer, only package with specified ID will be shown.
if <deployment> equals string, only deployment with specified value will be shown.
if <deployment> equals Regex (e.g. %test%), all deployments that fit this Regex will be shown. Regex will be applied to package/instance/env.
- deploy processes <id>
Lists the deployment processes associated with the deployment with the specified <id> - deploy status <id>
Retrieves the deployment status of the specified deployment <id>
Environment commands
- environment add <notification> | 0 <role> | 0 <protected> <name>
Creates a new environment of <name> associated with <role> and set to <protected> state. The new environment will use the specified <notification> method. A 0 (zero) setting for either the <notification> or <role> argument means no notification or role is assigned. The <protected> argument must be either 1 (enable) or 0 (disable) to set the protection status. - environment channel add <environment> <channel>
Adds the specified <channel> to the specified <environment>. - environment channel delete <environment> <channel>
Removes the specified <channel> from the <environment>. - environment channel list <environment>
Lists the channels currently associated with the specified <environment>. - environment delete <environment>
Deletes the specified <environment>. The environment must not be assigned to any routes and cannot have any channel members. environment list [<environment>]
Lists the environments currently defined in the BMC Release Package Deployment database.
Optionally filtered by the <environment>.
If <environment> equals integer, only environment with specified ID is shown.
If <environment> equals string, only environment with specified value is shown.
If <environment> equals Regex, (e.g. %test%) all environments that fit such Regex are shown.- environment property add <environment> <name> <value>
Adds an environment variable property of <name> and <value> to the specified <environment>. If the property already exists, it is replaced. - environment property delete <environment> <name>
Deletes the named environment variable property from the specified <environment>. This operation does not fail if the property does not already exist. - environment property list <environment>
Lists the environment variable properties set for the specified <environment>. - environment role add <environment> <name>
Adds the role <name> to the specified <environment>. - environment role delete<environment> <name>
Deletes the role <name> from the specified <environment>. - environment role list<environment>
Lists the roles defined for the specified <environment>.
- environment pool add <environment> <pool>
Creates a <pool> in the environment <environment>. - environment pool delete <environment> <pool>
Removes the specified <pool> from <environment>. - environment pool list <environment>
Lists the pools currently associated with <environment>. - environment pool channel add <environment> <pool> <channel>
Adds a <channel> to a <pool> in the <environment>. - environment pool channel delete <environment> <pool> <channel>,
Removes the specified <channel> from the <pool> in the <environment>. - environment pool channel list <environment> <pool>
Lists the channels currently associated with the <pool> from <environment>.
Global commands
- global property add <name> <value>
Adds a new global-level environment variable property of <name> and <value>. The <name> string must conform to environment variable name requirements. If the property already exists, the function fails. - global property delete <name>
Deletes the named global-level environment variable property. - global property list
Lists the global-level environment properties.
Instance commands
- instance create locked package <package> [i ]
Creates an instance from the specified <package> using the standard naming process. If the optional [i ] argument is specified, the instance is created with that name. The instance is created with the locked flag set. - instance create package <package> [name]
Creates and populates an instance from the named package. The <package> argument can be either the package ID or name. The optional [name] argument sets the name for the newly created instance. Otherwise, the instance is created with the default name. - instance create repo <repo> [name]
Creates an instance from the named repository. The <repo> argument can be either the repository ID or name. The optional [name] argument sets the name for the newly created instance. Otherwise, the instance is created with the default name. - instance delete <instance_id>
Deletes the specified instance. The instance argument must be the instance ID number to delete. instance deploy <instance> <route> [<environment>] [-r<ref1> <ref2> <refn>] [-c<channel1> <channel2> <channeln>]
Deploy the specified <instance> to <route>. If the optional <environment> argument is present and the route is an open route, the specified environment is targeted for the deployment.
If the route is not open and an environment is specified an error is returned. The <instance> argument may be the instance id value or specified using package:instance name format. Any number of reference names <refn> can be optionally passed to deploy only those specific references. Sending zero references will assume a full instance deployment. Any number of channel names or ids <channeln> can be selected from the environment and passed to deploy only to these specific channels. Sending zero channels will assume a deployment to all channels of environment.- instance environment list <instance>
Lists all environments where the specified <instance> has been deployed - instance lock <instance_id> on | off
Sets the locked flag either on or off for the specified <instance_id>. The instance can be either the instance ID or the package:instance name format. - instance log <instance> [gmt]
Returns the instance log data for the specified <instance>. The instance can be either the instance ID or the package:instance name format. To only return log data newer than a certain date, specify the optional [gmt] argument. instance package list <package> [<status>] [<instance>]
Lists the instances created from the specified <package>.
Optionally filtered by <status> and <instance>.
If <instance> equals integer, only instance with specified ID is shown.
If <instance> equals string, only instance with specified value is shown.
If <instance> equals Regex, (e.g. %test%) all instances that fit this Regex are shown.- instance promote <instance>
Promotes the specified <instance> to the next environment in its route. The instance can be either the instance ID or the package:instance name format. The instance must have already been deployed to a route. instance property add <instance> <name> <value> [locked]
Adds a new property to <instance> using <name> and <value>.
If locked argument is supplied, the property is locked from modification.
instance property list <source> [lock_status]
Listі the properties assigned to the instance identified by <source>.
The source argument is the package:instance or repo:instance.
If lock_status argument is supplied, an additional field will display the property lock status.
- instance property delete <instance> <name>
Deletes the property <name> from the specified <instance>. Deleting a property that does not exist does not produce an error. - instance rename <instance_id> <name>
Renames the specified instance to <name> instance repo list <repository> [<status>] [<frozen>] [<instance>]
Lists the instances created from the specified <repository>.
Optionally filtered by <status> and <frozen> and <instance>.
If <instance> equals integer, only instance with specified ID is shown.
If <instance> equals string, only instance with specified value is shown.
If <instance> equals Regex, (for example. %test%) all instances that fit this Regex are shown.- instance role add<instance> <name>
Adds the role <name> to the specified <instance>. - instance role delete<instance> <name>
Deletes the role <name> from the specified <instance>. - instance role list<instance>
List the roles defined for the specified <instance>. - instance route get <instance>
Retrieves the current route associated with the specified <instance> - instance route set <instance> <route>
Associates the specified <route> with the specified <instance> - instance status <instance_id>
Reports the current status of the specified instance
Module command
- module list
Lists the available "reference fetch" modules
Notification command
- notification list
Lists the notifications currently defined
Pack command
- pack list
Lists the action pack names currently defined
Package commands
- package add <role> | 0 <name>
Creates a new package container called <name>. If the <role> argument is 0, the package is available to all users. - package delete <package>
Deletes the specified <package>. The package can be either the package ID or name. The package and all its associated properties, references, and other data are deleted. However, instances created from the package are not deleted. package list [<package>]
Lists the packages currently defined in the BMC Release Package Deployment database.
Optionally filtered by <package>.
If <package> equals integer, then only package with the specified ID is shown.
If <package> equals string, then only package with the specified value is shown.
If <package> equals Regex (for example %test%), all packages that fit such Regex are shown.- package lock <package> on | off
Sets the lock flag for the specified <package> to turn locking on or off - package nameformat <package> <format>
Sets the naming convention pattern for the specified <package> to the specified <format>. The format field specifies the default naming format for instances created from the package. The format string can contain the special sequence [#], which is replaced with the next incremented value based on the last instance created from the package. - package property add <package> <name> <value>
Adds a new property of <name> and <value> to the specified <package>. The package can be either the package ID or name. If the property exists, its value is replaced with the new value. package property add <package> <name> <value> [locked] [encrypt]
Adds a new property of <name> and <value> to the specified <package>.The <name> and <value> arguments must be valid property values. If the property already exists, it is replaced with the new value.
If the locked argument is supplied, the property will be locked from modification during creation of an instance. If the encrypt argument is supplied, the property will be encrypted.- package property delete <package> <name>
Deletes the property <name> from the specified <package>. Deleting a property that does not exist does not produce an error. - package property list <package>
Lists the properties defined for the specified <package> package property list <package>[lock_status]
Lists the properties defined for the specified <package>. If lock_status argument is supplied, an additional field displays the property status as locked.- package reference add <package> <name> <module> <bridge> <uri>
Adds a new reference to a package. The specified <package> must exist. The <name> argument must be the name of the reference to add, enclosed in double quotes if the name contains spaces. The <module> argument must be a valid module (you can see the module list on the System tab) and can be either the module name or ID value. The <uri> argument is a URI format string appropriate for the module specified. No checking is done on the URI. - package reference analyzer add <package> <reference> <analyzer>
Assigns the specified <analyzer> to the specified <reference> for the specified <package>. The new analyzer is added to the end of the analyzer chain for the reference. - package reference analyzer delete <package> <reference> <analyzer>
Removes the specified <analyzer> from the specified <reference> in the specified <package>. Attempting to delete an analyzer that is not associated with the reference does not produce an error. - package reference analyzer list <package> <reference>
Lists all of the analyzers associated with the specified <reference> in the specified <package> - package reference bridge <package> <reference> <bridge>
Assigns the server specified as <bridge> to the specified <reference> in the specified <package>. All of the arguments can be either the name or ID value of the objects. - package reference delete <package> <reference>
Deletes the reference in the specified <package>. The <package> and <reference> arguments can be either the ID or the name value. This function returns an error if the specified <reference> does not exist. - package reference depend add <package> <parent_reference> <child_reference>
Creates a dependency in the specified <package> between <parent_reference> and <child_reference>. The parent and child references must exist in the package and can be specified by either name or ID value. - package reference depend delete <package> <parent_reference> <child_reference>
Removes a dependency definition between two references in the specified <package>. The parent and child references must exist in the package and can be specified by either name or ID value. If no dependency is defined for the specified references, an error is returned. - package reference depend list <package> <reference>
Lists the dependencies associated with the specified <reference> in the specified <package> - package reference filter add <package> <reference> A | R <regex>
Adds an accept (A) or reject (R) filter to the specified <reference> in the specified <package>. The <regex> argument specifies a regular expression for filtering content stored in the instance. - package reference filter delete <package> <reference> <regex>
Deletes the filter with a regular expression matching <regex> from the specified <reference> in the specified <package>. If the filter is not found, an error is returned. - package reference filter list <package> <reference>
Lists the filters associated with the specified <reference> in the specified <package> - package reference list <package>
Lists all of the references defined in the specified <package>. The package can be either the package ID or name. - package rename <package> <newname>
Renames the existing specified <package> to <newname>. The <newname> argument must be a name. If the new name already exists, the operation fails. - package role add<package> <name>
Adds the role <name> to the specified <package>. - package role delete<package> <name>
Deletes the role <name> from the specified <package>. - package role list<package>
List the roles defined for the specified <package>.
Process commands
- process activity list <process_id>
Lists the activities defined for the specified process - process task list <activity_id>
Lists the tasks defined for the specified activity - process task log <task_id>
Retrieves the process log data for the specified task - process log<process_id> [ stdout, stderr, system, env ]
Lists the full log for specified process, including all tasks. - process deployment log<deployment_id> [ stdout, stderr, system, env ]
Lists the full log for specified deployment. - process activity list<process_id>
Lists the activities defined for the specified process. - process task list<activity_id>
Lists the tasks defined for the specified activity. - process task log <task_id>
Retrieves the process log data for the specified task. - process role add<process> <name>
Adds the role <name> to the specified <process>. - process role delete<process> <name>
Deletes the role <name> from the specified <process>. - process role list<process>
Lists the roles defined for the specified <process>. - process set role add<process set> <name>
Adds the role <name> to the specified <process set>. - process set role delete<process set> <name>
Deletes the role <name> from the specified <process set>. - process set role list<process set>
Lists the roles defined for the specified <process set>.
Repository commands
- repo add <role> | 0 <name>
Creates a new repository of <name> and associates it with <role>. If the role argument is 0 (zero), the repository is available to all users. - repo artifact add artifact <destination_repo> <source_repo> [<artifact>]
Adds references to the specified <destination_repo> using the specified <source_repo> as the source. If no other arguments are given, all references from the source repository are added to the destination repository. If an optional reference argument is given only that reference is added to the repository. - repo artifact add data <repo> <name> <path> <md5> <bytes>
Adds data to a repository. The API service reads <bytes> characters of data from the input stream and adds that data as an artifact in the specified repository. The <name> argument specifies the name of the artifact in the repository. The <path> argument identifies where in the artifact table of contents the data originated. The <md5> argument must specify the MD5 digest, and is used to verify that the data was received successfully. - repo artifact add instance <repo> <instance> [artifact]
Adds references to the specified repository using the specified <instance> as the source. The optional [artifact] argument identifies the specific artifact to be added to the repository. If no [artifact] is specified, all references from the source instance are added to the destination repository. - repo artifact add reference <repo> <package> [reference]
Adds references to the specified repository using the specified <package> as the source. The optional [reference] argument identifies a specific reference to be added to the repository. If no [reference] is specified, all references from the package are added to the repository. - repo artifact config add <repo> <artifact> <path>
Adds a configuration data entry to the specified <artifact> within the specified repository using <path> as the configuration data entry. Configuration data entries are always appended to existing data. No check for duplicates is performed. - repo artifact config delete <repo> <artifact> <name>
Deletes the configuration data entry of <name> from the specified <artifact> in the specified repository. If the configuration data entry does not exist in the artifact, no error is returned. - repo artifact config list <repo> <artifact>
Lists the configuration data entries currently associated with the specified <artifact> in the specified repository. - repo artifact delete <repo> <artifact>
Deletes the specified <artifact> from the specified repository. If the artifact does not exist in the repository, the operation returns success. - repo artifact list <repo>
Lists the artifacts contained in the specified repository - repo artifact meta add <repo> <artifact> <name=value>
Adds metadata of <name=value> to the <artifact> in the specified repository. The metadata entry is always appended to existing metadata. No check for duplicates is performed. - repo artifact meta delete <repo> <artifact> <name>
Deletes metadata from the specified <artifact> in the specified repository. The <name> argument is compared to the metadata entries as long as a match is found, and any matches are deleted. - repo artifact meta list <repo> <artifact>
Lists the metadata entries associated with the specified <artifact> in the specified repository - repo artifact rename <repo> <artifact> <name>
Changes the name of the specified <artifact> to a new <name> in the specified repository - repo artifact refresh <repository> <artifact>
Causes the specified <artifact> in the specified <repository> to be fetched. - repo artifact status <repo> <artifact>
Displays the status for the specified <artifact>in the specified repository. The status can be:- Empty
The artifact was created successfully but has not been processed. - Constructing
- Fetching
- Analyzing
- Processing
The artifact is processing, and the system is fetching content for it. - Ready
It worked.
- Empty
- repo artifact depend add <repository> <target> <dependency> [ <dependencies>...]
Allows you to assign single or multiple dependencies on a group or solid.
repo artifact depend delete <repository> <target> <dependency> [ <dependencies>...]
Allows you to remove a single or multiple dependencies on a group or solid.
- repo delete <repo>
Deletes the specified repository - repo deploy<repository> <route>
Deploy a copy of the specified <repository> to the specified <route>. repo list [<status>] [<repository>]
Lists the repositories currently defined in the BMC Release Package Deployment database.
Optionally filtered by <status> and <repository>
If <repository> equals integer, only repository with specified ID will be shown.
If <repository> equals string, only repository with specified value will be shown.
If <repository> equals Regex, (e.g. %test%) all repositories that fit this Regex are shown.- repo nameformat <repo> <format>
Sets the naming convention pattern for the specified repository to <format>. The format field specifies the default naming format for instances created from the repository. The format string can contain the special sequence [#], which is replaced with the next incremented value based on the last instance created from the repository. - repo property add <repo> <name> <value>
Adds a property of <name> and <value> to the specified repository. If the property already exists, its value is replaced with the new value. repo property add <repo> <name> <value>[locked]
Adds a property of <name> and <value> to the specified repository. If the property already exists, its value is replaced with the new value.If locked argument is supplied, the property is locked from modification.
- repo property delete <repo> <name>
Deletes a property of <name> from the specified repository. Deleting a property that does not exist does not produce an error. - repo property list <repo>
Lists the properties for the specified repository repo property list <repo>[lock_status]
Lists the properties for the specified repository.If lock_status argument is supplied, an additional field displays the property status as locked.
- repo rename <repo> <name>
Renames the existing specified repository to <name>. A repository of the same name must not already exist. - repo refresh<repository>
Causes all artifacts in the specified repository to be fetched. - repo role <repo> <role> | 0
Assigns the existing specified repository to the specified <role>. If the <role> argument is 0 (zero), the repository is available to all users. - repo role add<repo> <name>
Adds the role <name> to the specified <repo>. - repo role list <repo>
Lists the roles defined for the specified <repo>. - repo role delete<repo> <name>
Deletes the role <name> from the specified <repo>.
Role command
- role list: Lists the roles currently defined
Route commands
- route add <name> [open | mixed | strict ]
Adds a deployment route of <name> to the system. Optionally, you can specify a mode of open, mixed, or strict. - route delete <route>
Deletes the specified <route>. For the operation to succeed, the route must not be in use by any deliverable. - route environment add <route> <environment>
Adds the specified <environment> to the specified <route>. The environment is added to the end of the route. - route environment delete <route> <environment>
Deletes the specified <environment> from the specified <route>. Any environment can be deleted from a route. - route environment list <route>
Lists the environments currently associated with the specified <route> - route next environment list <name> [instance]
Lists the allowed environments which can be deployed to in a route. If an instance is specified, the command lists the next allowed environment to which the instance can be deployed. route list [<route>]
Lists the routes currently defined in the BMC Release Package Deployment database.
Optionally filtered by <route>.
If <route> equal integer, only route with specified ID is shown.
If <route> equal string, only route with specified value is shown.
If <route> equal Regex (for example %test%) all routes that fit such Regex are shown.
Schedule commands
- schedule list
Lists the scheduled tasks currently defined - schedule disable <schedule>
Disables the specified schedule entry. The <schedule> argument can be either the schedule ID or name. - schedule enable <schedule>
Enables the specified schedule entry. The <schedule> argument can be either the schedule ID or name. - schedule run <schedule>
Forces the specified schedule entry to run immediately. The <schedule> argument can be either the schedule ID or name.
User command
- user list
Lists the user accounts currently defined
VM command
- vm list
Lists the virtual machine resources currently defined
Load Balancer commands
- lbs add <name> <module>
Adds a load balancer with the specified <name> and <module>. - lbs delete <name>
Deletes a load balancer with the specified <name>. - lbs list
Lists the load balancers. lbs module
Lists the load balancer's modules