Skip to main content

Provisioning Service Commands

Commands: tprovision:

Command Parameter Usage
profile-create
  • profile-name

  • profile-category (for example: "system")

Optional:

  • auto-update: autoupdate in seconds

  • pool-interval: poolinterval in seconds

Primary command to create a new profile
profile-delete
  • profile-name

Deletes the entire profile (including all its existing versions).
profile-info
  • profile-name

Optional:

  • profile-version, with format ('<number>.<number>')

Shows information about the specified Profile. If the version is given, it shows the information for a specific version of the profile.
profile-release
  • profile-name

  • release-version, with format ('<number>.<number>')

Optional:

  • placeholders-category

  • placeholders-version

Releases a Profile (at the same time a placeholder category and version can also be set to replace placeholders used in this profile by the related values at lookup time).

Only released profiles can be used by agents. If autoupdate is activated for a profile, agents will automatically start to apply the new version once it is released.

profile-update
  • profile-name

  • auto-update

Optional:

  • pooling-interval

  • new-profile-name

  • placeholders-category

Can be used to update the optional parameters of the profile: auto-update, pool-interval and placeholders-category.

profiles-list
  • profile-name

Lists all the profiles existing within the server.

Note: It is not the list of applied profiles. For this, see the agent commands

feature-create
  • profile-name

  • feature-url

  • feature-name

  • feature-version

Optional:

  • feature-index: provide a way to define the order in which features within one profile will be applied.

Adds a feature definition to the profile. Features are supposed to be accessible by the container where the agent is running using a local system repository (as Talend Runtime provides it ) or by an external Maven repository (for example: the Talend Nexus Artifact Repository)

The feature name, URL and version is the standard Apache Karaf /Maven information for features.

Profiles with features can only be applied to Talend Runtime (OSGi).

feature-delete
  • profile-name

  • feature-index

Deletes a feature from the profile, using the index to specify which feature.
feature-update
  • profile-name

  • feature-index

  • new-feature-url

  • new-feature-name

  • new-feature-version

Allows to change the feature which the given index to a new feature name, URL, version
features-list
  • profile-name

Optional:

  • profile-version

Lists all features for a given profile
resource-create
  • profile-name

  • local-file-path

Optional:

  • resource-uri

Provides the ability to upload a local file into a profile.

The URI specifies a folder name under which this resource should be placed on the final agent container.

A resource can be essentially any kind of file, for example: .cfg file, .txt File, Keystore file and more.

The URI has two meanings: the unique name of a resource within the profile, but at the same time, it is also the relative path + file name of the resource.

resource-delete
  • profile-name

  • resource-uri

Removes a resource from the profile with the given URI.
resource-export
  • profile-name

  • resource-uri

  • local-file-path

Optional:

  • profile-version

Exports a profile resource into a file (released under specified version or sandbox one if no version specified)
resource-update
  • profile-name

  • resource-uri

  • new-resource-uri

Optional:

  • new-local-file-path

Allows to update a resource by profileName / resourceUri with a new Uri and new file content. It is also possible to just update the URI (e.g. the path / file name ) but not the content. The newReourcePath is optional and only used if also the content should be updated.
resources-list
  • profile-name

Optional:

  • profile-version

Lists all resources of the given profile.
placeholder-create
  • placeholders-category

  • placeholder-name

  • placeholder-value

Placeholders are key / value pairs grouped together with the category (for example: com.talend.esb.infra.placeholder)

One placeholder category (group) can be applied to one profile and allows to replace values in text based configuration files at lookup time. (For example: host name, users)

placeholder-delete
  • placeholders-category

Optional:

  • placeholder-name

Deletes either an entire placeholder category (including all its versions) or a specific placeholder via the placeholder-name parameter, within the given category.
placeholder-update
  • placeholders-category

  • placeholder-name

  • placeholder-value

Optional:

  • placeholder-version

Updates an existing placeholder with a new value.
placeholders-categories-list No parameter Lists placeholders categories.
placeholders-export
  • local-file-path

Optional:

  • placeholders-category

  • placeholders-version

Exports all placeholders or the one from the specified category / version to a local file.
placeholders-import

Optional:

  • -o to overwrite existing values

  • local-file-path

Imports placeholders from a related local export file into the provisioning service, either all, or just the one for the specified category / version.
placeholders-list
  • placeholders-category

Optional:

  • placeholders-version

Lists all Key / Value pairs of a placeholder category (and version)
placeholders-release
  • placeholders-category

  • release-version

Releases the set of key / value pairs for the given category with the given version.
export
  • local-file-path

Optional:

  • profile-name

  • profile-version

Exports all profiles or just the given profile (version). By this, profiles can be prepared on a test system and imported into production or any other environment.
Import

Optional:

  • -o to overwrite existing profiles if exists already

  • local-file-path

Imports profile(s) from a given profile export file.
service-help No parameter Shows a short online help of all tprovision: commands

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!