Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

Using eZDeploy export

This topic explains how to use the export feature of the eZDeploy utility.

Before you begin

  • Ensure that the eZDeploy profile is created in the source environment prior to exporting a service blueprint or a service catalog. See Managing-eZDeploy-profiles for details.
  • Ensure that the option included in the exported service has at least one option choice.

  • Ensure that eZDeploy can locate the objects in the following specified locations; otherwise, the export process might fail.
     The following table lists the object types and their locations in BMC Server Automation:

    Object type

    Location in BMC Server Automation

    Application component template

    Component Templates/CSM_Application_Packages

    System package

    Depot/CSM_OS_Packages

    VGP

    Depot/CSM_Virtual_Guest_Packages

    BLPackage deploy job

    Jobs/CSM_Applications

    Software deploy job

    Jobs/CSM_Applications

    NSH script

    Depot/CSM_Script

Back to top

To view help for the export command

Run the following command to view the help for the export command:

eZDeploy> help export

Command: export = Export Service/Service Offering/Blueprint/Software
Packages as eZDeploy Package/s.

Usage: export [options]
[options]    [example]
-softwarepackages   export -softwarepackages <softwarepackages-name>
-blueprint    export -blueprint <blueprint-name>
-serviceoffering    export -serviceoffering <serviceoffering-name>
-version    export -version <version-name>
-profile    export -profile <profile-name>
-service    export -service <service-name>
-path    export -path <path-name>
         
[options]    [description]
-softwarepackages   Name of Software Package/s to be Exported.
[Mandatory : if it is the only one which needs to
be exported]
-blueprint    Name of Service Blueprint to be Exported.
[Mandatory : if it is the only one which needs to
be exported]
-serviceoffering    Name of Service Offering to be Exported.
[Mandatory : if it is the only one which needs to
be exported]       
-version    Number of the Service Blueprint version to
be exported.
Default as Latest Selected. [Mandatory : if user
wants to export different version]
-profile    Name of eZDeploy Profile which is going to be used.
[Mandatory]
-service    Name of Service to be exported.
[Mandatory : if it is the only one which needs to
be exported]
-path    Absolute Export Path/Directory to which .eZ Package/s
will export.
[Mandatory : if it is the only export path needs to
be used]

[example : exporting blueprint to default directory with
profile parameter]
export -blueprint <blueprint-name> -profile <profile-name>

[example : exporting service to different directory]
export -service <service-name> -path <path-name>

Back to top

 

Note

  • If the exported entity contains a space in the name, ensure that you enclose it within double quotes when you run the export command; for example, "Windows Single Tier SO".

To export a business service

To export a business service, which includes one or more service blueprints and one or more service offerings to a custom directory, run the following command:

export -profile <profile-name> -service <service-name>
 -path <path-name>

The following table describes the input parameters:

Parameter

Description

profile

(Optional) Name of the eZDeploy source profile that is created

Note: If you have set a global profile, you can skip specifying this parameter.

service

Name of the service from the service catalog to be exported

path

(Optional) Directory to which the .eZ packages are exported

Specify this parameter only if the package is to be exported to a directory other than the export directory, which is the default location of the eZDeploy utility.

Note

If the keyword parameter is set to a specific value in the requestable offering, that value is not exported by using eZDeploy

 

Back to top

To export a service blueprint

To export a service blueprint, run the following command:

export -blueprint <blueprint-name> -profile <profile-name>
-version <version-name>

The following table describes the parameters.

Parameter

Description

blueprint

Name of the BMC Cloud Lifecycle Management service blueprint 

profile 

(Optional) Name of the eZDeploy source profile that is created

Note: If you have set a global profile, you can skip specifying this parameter.

version

(Optional) Version number of service blueprint

Note: If you do not specify this parameter, the eZDeploy utility exports the latest version of the service blueprint.

If eZDeploy detects any BMC Atrium Orchestrator workflows that are associated with the service blueprint, you must provide the module version at the eZDeploy prompt.

Note

If you do provide the correct BMC Atrium Orchestrator module version, the export does not proceed. For details, see eZDeploy issues. 

Tip

eZDeploy logs each step in the eZDeploy Installed Directory/ezdeploy.log. For any issues, you can check the log file.

For detailed activity logs of eZDeploy, refer to Troubleshooting eZDeploy issues.

Back to top

To export a service offering

To export an individual service offering, run the following command:

export -profile <profile-name> -serviceoffering <serviceoffering-name>

The following table describes the parameters.

Parameter

Description

profile

(Optional) Name of the eZDeploy source profile that is created

Note: If you have set a global profile, you can skip specifying this parameter.

serviceoffering

Name of the service offering from the service catalog to be exported

Note: The exported eZ package is named as <service offering name>_<service name>.eZ; for example, serviceOfferingName_serviceName.eZ. This naming convention helps in distinguishing service offerings that have the same name but belong to different service catalogs. During import, specify only the service offering name; for example, serviceOfferingName without appending _<service name>.eZ

Note

If the keyword parameter is set to a specific value in the requestable offering, that value is not exported by using eZDeploy

Back to top

To export a software package

To export an individual service package, run the following command:

export -profile <profile-name> -softwarepackages <softwarepackages-name>

The following table describes the parameters.

Parameter

Description

profile

(Optional) Name of the eZDeploy source profile that is created

Note: If you have set a global profile, you can skip specifying this parameter.

softwarepackages

Name of the software package

Note: Ensure that the software package name is the same as that published on the BMC Cloud Lifecycle Management Console because this command exports the package as published on the Console.

Back to top

To validate the export

To validate that a BMC Cloud Lifecycle Management service catalog, service blueprint, or a service offering export is successful, ensure that under the eZDeploy directory in your environment, in a folder named export, an .eZ file is created.

The following table lists the export parameter and the corresponding folder created under the export folder:

Parameter

Output folder created

softwarepackages

softwarepackages

blueprint

blueprints

serviceoffering

serviceofferings

service

businessservices

Where to go next

Using-eZDeploy-import-from-the-command-line

Using-eZDeploy-import-from-an-answer-file

Back to top

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*