Managing eZDeploy profiles

A profile is an environment that stores the credentials of a particular user who is authorized to run the eZDeploy commands. To avoid specifying the user credentials each time you run eZDeploy commands, you refer to a profile.

This topic describes how to manage an eZDeploy profile. The following sections describe how to create, view, and delete an eZDeploy profile:

To view help for the profile command

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

eZDeploy> help profile

Command: profile -Add, Delete, List, Set eZDeploy CLM Profile.

Usage:
profile [options] <input parameters>

[options]      <input parameters>      <description>  

Add 			
				-host					CLM AR Host Name or IP Address.
 				-user					CLM AR Admin Username.
 				-password				AR Admin Password.
				-port             		CLM AR Port.
 				-name              		eZDeploy CLM Profile Name.

Delete 			-name             		eZDeploy CLM Profile Name.

Set 			-name              		eZDeploy CLM Profile Name.

[example]

Add : profile add -name <name> -host <host> -port <port> -user <user> 
-password <password>

Delete : profile delete -name <name>

Set : profile set -name <name>

List : profile list

To create an eZDeploy profile

You must create an eZDeploy profile before you start using the import and export functionality of the eZDeploy utility. You can create a profile by using the profile command on the command-line interface (CLI). Ensure that the user creating the profile has AR Administrator privileges. Otherwise, problems occur during profile creation.

Before you create eZDeploy profiles, the CLI automatically gets the BMC Cloud Lifecycle Management Platform Manager details, the associated BMC Server Automation details, and the BMC Atrium Orchestrator details from the BMC Cloud Lifecycle Management configuration files, but requires the Enterprise AR server details as an input while creating the profile.

To create an eZDeploy profile, perform the following steps: 

  1. Run the following command from the eZDeploy directory:

     profile add -name <name> -host <host> -port <port> -user <user> -password <password>

    The following table lists the inputs that you must provide to run the command:

    ParameterDescription
    name
    eZDeploy profile name
    host
    BMC Cloud Lifecycle Management Enterprise AR host name or IP address
    port
    BMC Cloud Lifecycle Management Enterprise AR port
    user

    BMC Cloud Lifecycle Management Enterprise AR Admin username

    Note: Ensure that the BMC AR System server user has the Administrator and Cloud Administrator privileges.

    password

    (Optional) BMC Cloud Lifecycle Management Enterprise AR Admin password

    Note: If no password is assigned to the BMC Cloud Lifecycle Management Enterprise AR user, you do not need this parameter.

  2. Press Enter
    The eZDeploy profile is created and eZDeploy stores the BMC Server Automation Server and BMC Atrium Orchestrator Server details.

  3. Verify that the eZDeploy profile is created correctly:
    1. Use the profile list command to view the profile details.
      See To view eZDeploy profiles for details.
    2. Navigate to the BMC Server Automation console in your eZDeploy environment and ensure that the prefix ZProfile- is appended to the BMC Server Automation Server name in the newly created BMC Server Automation Authentication Profile as shown in the following figure:

      If you cannot view the profile, relaunch the BMC Server Automation console.

Note

If eZDeploy fails to detect BMC Server Automation or BMC Atrium Orchestrator configuration, it will prompt you for the following inputs:

  • For BMC Server Automation, provide the BMC Server Automation host name, user name, password, authentication port, server port for REST calls, and server protocol (http/https).
  • For BMC Atrium Orchestrator, provide the BMC Atrium Orchestrator Repository details such as host name, server protocol (http/https), port, user name, and password. Ensure that you have specified the correct BMC Atrium Orchestrator details because eZDeploy does not validate these details when you create a user profile.

Back to top

To view eZDeploy profiles

To view the list of eZDeploy profiles that you created, perform the following steps:

  1. Run the profile list command from the eZDeploy directory.
  2. Press Enter.

A list of profiles is displayed as shown in the following figure:

Back to top

To set a global eZDeploy profile

Setting a global profile for an environment saves you from remembering and retyping the profile details each time you execute the eZDeploy import or export commands. eZDeploy allows you to have only one global profile for an environment. If there is an existing global profile in an environment and you set another profile as global, the last profile created becomes the new global profile.

To set a particular eZDeploy profile as a global profile, perform the following steps:

  1. Run the profile set -name <name> command from the eZDeploy directory.

  2. Press Enter.

    The eZDeploy profile is marked as Global in the list of eZDeploy profiles in your environment.

The profile is set as a global profile as shown in the following figure:

Back to top

To delete an eZDeploy profile

To delete a particular eZDeploy profile, perform the following steps:

  1. Run the profile delete -name <name> command from the eZDeploy directory.
  2. Press Enter.

For example: eZDeploy> profile delete -name Source

Back to top

Where to go from here

Using the eZDeploy utility

Back to top

Was this page helpful? Yes No Submitting... Thank you

Comments