Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Configuring the CLM AWS SDK

This topic provides the steps for configuring the CLM AWS SDK.

Configuring the CLM AWS SDK

  1. Download the CLM AWS SDK.
  2. Extract the contents in the desired directory.

  3. Configure the CLM AWS SDK by using either of the following options:

    • Use a parameterized constructor - Specify the configuration parameters in the constructor at runtime.

    • Use a combination of a parameterized constructor and configuration file: Specify some parameter values by using the parameterized constructor and some by using the configuration file (config.properties). Ensure that you place the configuration file for the CLM AWS SDK in the clmsdk directory under the Users home directory. For example, under C:\Users\Administrator, create the clmsdk directory and copy the config.properties to it.

  4. Add the following .jar files to your project's classpath:
    • apiclient-1.0.0-nodep.jar
    • lib/log-1.0.0.jar
    • lib/objectmodel-1.0.0.jar
    • lib/com.springsource.org.apache.log4j-1.2.15.jar
    • lib/commons-logging-1.1.1.jar
    • lib/httpclient-4.1.2.jar
    • lib/httpcore-4.1.2.jar
    • lib/jackson-annotations-2.3.1.jar
    • lib/jackson-core-2.3.1.jar
    • lib/jackson-core-asl-1.6.3.jar
    • lib/jackson-databind-2.3.1.jar
    • lib/jackson-mapper-asl-1.6.3.jar
    • lib/aws-java-sdk-1.8.11.jar
  5. Replace references to AmazonEC2Client in your code with CLMEC2Client.

Back to top

Configuration parameters for the CLM AWS SDK

The following table lists the configuration parameters whose values you must set in the configuration file or specify by using the parameterized constructor (at runtime) prior to using the CLM AWS SDK methods:

Parameter

Description

Required

PLATFORM_MANAGER_URL

Specifies the connection properties (URL of the BMC Platform Manager) for BMC Cloud Lifecycle Management.

Yes

CLM_USER_ID

Specifies the connection properties (Cloud Administrator User ID) for BMC Cloud Lifecycle Management.

Yes

CLM_USER_PASSWORD

Specifies the connection properties (Cloud Administrator password) for BMC Cloud Lifecycle Management.

Note: You cannot specify this parameter in a configuration file. You must only specify it as a constructor argument.

Yes

TENANT

Specifies the BMC Cloud Lifecycle Management tenant name.

This parameter is used in the RunInstancesRequest for onboarding, and is required if the tenant admin belongs to multiple tenants.

If you do not specify this parameter, a random tenant from the associated tenants is selected.

No

NETWORK_CONTAINER_NAME

Specifies the BMC Cloud Lifecycle Management Logical Hosting Environment (LHE) name.

This parameter is used in the RunInstancesRequest for onboarding.

If you do not specify this parameter, a random LHE, which is mapped with the selected tenant is selected.

No

NETWORK

Specifies the BMC Cloud Lifecycle Management logical network name associated with the LHE.

This parameter is used in the RunInstancesRequest for onboarding.

 If you do not specify this parameter, a random network from the list of networks within the LHE is selected.

No

ENABLE_NAT

Indicates whether to enable Network Address Translation (NAT) in the NIC details.

This parameter is used in the RunInstancesRequest for onboarding.

Valid values: true/false (default)

 

ENTITLEMENT_PACKAGE

Specifies the BMC Cloud Lifecycle Management entitlement package.

This parameter is used in the RunInstancesRequest for onboarding.

Yes

VM_USERNAME

Specifies the user name for the local user created on a provisioned VM.

This parameter is used in the RunInstancesRequest for onboarding.

Default value: cloud

No

VM_PASSWORD

Specifies the password for the local user created on a provisioned VM.

This parameter is used in the RunInstancesRequest for onboarding.

Default: cloud

No

HOSTNAME_PREFIX

Specifies the host name prefix.

This parameter is used in the RunInstancesRequest for onboarding.

Default value: aws

No

DECOMMISSION_DATE

Specifies the number of days from the current date to decommission the service.

This parameter is used in the RunInstancesRequest for provisioning.

No

QUANTITY

Specifies the quantity of BMC Cloud Lifecycle Management Service Offering Instances (SOIs) that must be provisioned in one RunInstancesRequest.

Default value: 1

No

BLUEPRINT_NAME_SUFFIX

Specifies the blueprint name suffix to be used in the RunInstancesRequest for onboarding.

The blueprint name consists of the Image ID and suffix.

Suffix used is _BP.

Note

(Applies to on-premises cloud provider) For an onboard case, you must specify a name for the service blueprint as a configuration parameter in the <ImageId>.blueprintname=<Service Blueprint Name> format.

Replace <ImageId> with the name of template and<Service Blueprint Name> with the name of service blueprint used.

Note: The service blueprint name must not contain an image ID.

For example: To onboard image VMW-W2K8-64B-20GB, you must have the configuration parameter in config.properties set as follows:

VMW-W2K8-64B-20GB.blueprintname=Windows 2008 Service

Yes

CATALOG_NAME_SUFFIX

Specifies the Service Catalog name suffix to be used in the RunInstancesRequest for onboarding.

The Service Catalog name consists of the Image ID and suffix.

Suffix used is _SC.

Yes

OFFERING_NAME_SUFFIX

Specifies the Service Offering name suffix to be used in the RunInstancesRequest for onboarding.

The Service Offering name consists of the Image ID and suffix.

Suffix used is _SO.

Yes

REQUEST_OFFERING_NAME_SUFFIX

Specifies the Requestable Offering name suffix to be used in the RunInstancesRequest for onboarding.

The Requestable Offering name consists of the Image ID and suffix.

Suffix used is _RO.

Yes

PRODUCT_CATEGORIZATION_TIER_1

Specifies the property used in the RunInstancesRequest for creating an installable resource for onboarding an AMI.

Default value: Software Distribution

Yes

PRODUCT_CATEGORIZATION_TIER_2

Specifies the property used in the RunInstancesRequest for creating an installable resource for onboarding an AMI.

Default value: VM Template

Yes

PRODUCT_CATEGORIZATION_TIER_3

Specifies the property used in the RunInstancesRequest for creating an installable resource for onboarding an AMI.

Default value: Amazon

Yes

MANUFACTURER

Specifies the property used in the RunInstancesRequest for creating an installable resource for onboarding an AMI.

  • For Amazon, the default value is Amazon. 
  • For on-premises, the default value is vmware.

Yes

PROVIDER_DEF

Specifies the provider definition name to be used when creating an Installable Resource (IR).

  • For Amazon, the default value is AWS. 
  • For on premise, the default value is BBSA.

Yes

PROVIDER

Specifies the provider name to be used when creating an IR.

You must specify the provider instance name registered in BMC Cloud Lifecycle Management.

Default value: None

Yes

PROVISION_AFTER_ONBOARD

Specifies the property used in the RunInstancesRequest for onboarding.

If this parameter is set to true, after onboarding of the AMI is complete, provisioning is done automatically in the same request.

Default value: FALSE

No

LOG_LEVEL

Specifies the log level for the CLM AWS SDK.

Valid values: INFO (default), DEBUG

Yes

LOG_CLM_CALL

Specifies the additional logging parameter.

If the value is set to TRUE, all the REST calls to BMC Cloud Lifecycle Management are logged.

Default: FALSE

No

TASK_TIMEOUT_INTERVAL

Specifies the task timeout interval in milliseconds.

Default: 2400000

No

Back to top

Where to go from here

 

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