ibmcloudprov_config.json reference

The IBM® Cloud (previously SoftLayer®) provider configuration file, which contains account information and authentication credentials for provisioning from IBM Cloud.

Location

The ibmcloudprov_config.json file is located at:

%HF_TOP%\%HF_VERSION%\providerplugins\ibmcloud\sampleconf\ on Windows.
$HF_TOP/$HF_VERSION/providerplugins/ibmcloud/sampleconf/ on Linux®.

Tip: The ibmcloudprov_config.json sample file is renamed to ibmcloudinstprov_config.json when copied into the configuration directory location, for example: %HF_CONFDIR%\providers\ibmcloudinst\ on Windows or $HF_CONFDIR/providers/ibmcloudinst/ on Linux.

Parameter

SOFTLAYER_CREDENTIAL_FILE

Required. Full path to the IBM Cloud credential file on your primary host with credentials to connect to IBM Cloud. The credential file contains the user name and API key of your IBM Cloud account (see step 2 in the Setting up an IBM Cloud account topic). Ensure that the information is included in the format similar to the following snippet:

# cat credentials
# credentials
softlayer_access_user_name = clouduser1
softlayer_secret_api_key = fbae***********************************

SOFTLAYER_DOMAIN_NAME

Optional. Domain name for hosts provisioned from IBM Cloud. For hosts that join a Windows domain, this value must match the Windows domain name.

SOFTLAYER_API_ENDPOINT_BASE_URL

Optional. IBM Cloud API endpoint URL. Valid value is a string with the API endpoint URL.

If a valid API endpoint URL is specified in the parameter, then the specified endpoint is used by host factory for API connections withIBM Cloud.

If the parameter is not specified or is empty, then the default public API endpoint (https://api.softlayer.com/rest/v3.1/) is used.

If an invalid API endpoint URL is specified, IBM Cloud is unable to provision the virtual machines and exceptions are generated in the ibmcloudinst-provider.primary_hostname.log file that is located in the $EGO_TOP/hostfactory/log/ directory.