Back up your custom Orchestrator server configuration and workflow elements, to ensure their reusability by other Orchestrator instances.

If you edit any standard workflows, actions, policies, or configuration elements, and then import a package containing the same elements with a later Orchestrator version number, your changes to the elements are lost. You can prevent the loss of customized workflows and other elements by exporting them before you migrate your Orchestrator instance.

Each Orchestrator server instance has unique certificates, and each vCenter Server plug-in instance has a unique ID. The certificates and the unique ID define the identity of the Orchestrator server and the vCenter Server plug-in. If you do not back up the Orchestrator elements or export the Orchestrator configuration for backup purposes, make sure that you change these identifiers.

Prerequisites

Deploy and configure a new Orchestrator server instance. See Configuring a Standalone Orchestrator Server.

Procedure

  1. Export the Orchestrator configuration.
    1. Log in to Control Center as root.
    2. Click Export/Import Configuration.
    3. Select the types of files you want to export.
    4. (Optional) Protect the configuration file by entering a password.
      Use the same password when you import the configuration.
    5. Click Export.
  2. Log in to the Orchestrator client application.
  3. Create a package that contains all the Orchestrator elements that you created or edited.
    1. Under the Administer view, click the Packages tab.
    2. Click the menu button in the title bar of the Packages list and select Add package.
    3. Enter a name for the new package and click OK.
      The syntax for package names is domain.your_company.folder.package_name.
      For example, com.vmware.myfolder.mypackage.
    4. Right-click the package and select Edit.
    5. On the General tab, add a description for the package.
    6. On the Workflows tab, add workflows to the package.
    7. (Optional) Add policy templates, actions, configuration elements, resource elements, access rights, and plug-ins to the package.
    8. Click Save and close.
  4. Export the package.
    1. Right-click the package you want to export and select Export package.
    2. Browse to and select a location where you want to save the package.
    3. (Optional) Use the corresponding certificate to sign the package.
    4. (Optional) Impose restrictions on the exported package.
    5. (Optional) To apply restrictions for the contents of the exported package, deselect the options as required.
      Option Description
      Export version history The version history of the package is not exported.
      Export the values of the configuration settings The attribute values of the configuration elements in the package are not exported.
      Export global tags The global tags in the package are not exported.
      Note: The Export the values of the configuration SecureString settings option is deselected by default. Export of these configuration settings can cause a security problem. Use with caution.
    6. Click Save.
  5. Import the Orchestrator configuration that your exported earlier to the new Orchestrator server instance.
    1. Log in to Control Center of the new Orchestrator instance as root.
    2. Click Export/Import Configuration and navigate to the Import Configuration tab.
    3. Browse to select the .zip file you exported from your previous installation.
    4. Type the password you used while exporting the configuration.
      This step is not necessary if you have not specified a password.
    5. Select the import type.
    6. Click Import.
  6. Import the package that you exported to the new Orchestrator instance.
    1. Log in to the Orchestrator client application of the new Orchestrator instance.
    2. From the drop-down menu in the Orchestrator client, select Administer.
    3. Click the Packages tab.
    4. Click the menu button in the title bar of the Packages list and select Import package.
    5. Browse to and select the package that you want to import and click Open.
      Certificate information about the exporter appears.
    6. Review the package import details and select Import or Import and trust provider.
      The Import package view appears. If the version of the imported package element is later than the version on the server, the system selects the element for import automatically.
    7. Select the elements that you want to import.
      Note: Deselect custom elements for which later versions exist.
    8. (Optional) Deselect the Import the values of the configuration settings check box if you do not want to import the attribute values of the configuration elements from the package.
    9. From the drop-down menu, select whether you want to import tags from the package.
      Option Description
      Import tags but preserve existing values Import tags from the package without overwriting existing tag values.
      Import tags and overwrite existing values Import tags from the package and overwrite their values.
      Do not import tags Do not import tags from the package.
    10. Click Import selected elements.

Results

You have successfully backed up the Orchestrator configuration and elements.