You can import a package by using the Orchestrator REST API.

About this task

Depending on the library of your REST client application, you can use custom code that defines the properties of the package.

By default, if you import an Orchestrator package with a duplicate name, the existing package is not overwritten. You can specify whether to overwrite existing packages by using a parameter in the request.

By default, Orchestrator packages are imported with the attribute values of configuration elements. You can import a package without attribute values by using a parameter in the request.

By default, tags contained in Orchestrator packages are imported, but if the same tags already exist on the Orchestrator server, the values of existing tags are preserved. You can specify whether existing tag values are preserved by using parameters in the request.

Prerequisites

The package binary content should be available as multi-part content. For details, see RFC-2387.

Procedure

  1. In a REST client application, add request headers to define the properties of the package that you want to import.
  2. Make a POST request at the URL of the package objects:
    POST http://{vcoHost}:{port}/vco/api/packages/
  3. (Optional) : To import a package and overwrite an existing package with the same name, use the overwrite parameter in the POST request:
    POST http://{vcoHost}:{port}/vco/api/packages/?overwrite=true
  4. (Optional) : To import a package without the attribute values of the configuration elements from the package, use the importConfigurationAttributeValues parameter in the POST request:
    POST http://{vcoHost}:{port}/vco/api/packages/?importConfigurationAttributeValues=false
  5. (Optional) : To import a package without the tags that it contains, use the tagImportMode parameter in the POST request:
    POST http://{vcoHost}:{port}/vco/api/packages/?tagImportMode=DoNotImport
  6. (Optional) : To import a package with the tags that it contains and overwrite existing tag values, use the tagImportMode parameter in the POST request:
    POST http://{vcoHost}:{port}/vco/api/packages/?tagImportMode=ImportAndOverwriteExistingValue

Results

If the POST request is successful, you receive the status code 202.