`manage apply-entitlement`

Give the License Service (provided by IBM Cloud Pak foundational services) information about the type of IBM Cloud Pak for Data license that you purchased.

Extended description

You are required to keep a record of the size of you deployments to report to IBM as requested. You can use the License Service to measure your IBM Cloud Pak® for Data use against your license terms.

Use the cpd-cli manage apply-entitlement command to provide information about the type of IBM Cloud Pak for Data license that you purchased, so that the License Service can provide accurate usage information against your license terms.

Syntax

cpd-cli manage apply-entitlement \
--cpd_instance_ns=<project-name> \
[--entitlement=cpd-enterprise|cpd-standard] \
[--production=true|false] \
[--preview=true|false]

Arguments

The apply-entitlement command has no arguments.

Options

Option	Description
`--cpd_instance_ns`	The project (namespace) where IBM Cloud Pak for Data is installed. Status Required. Syntax `--cpd_instance_ns=<project-name>` Default value No default. User-defined. Valid values The project (namespace) where IBM Cloud Pak for Data is installed.
`--entitlement`	The type of Cloud Pak for Data license that you purchased. Status Optional. Syntax `--entitlement=cpd-enterprise\|cpd-standard` Default value cpd-enterprise If you omit this option, the default value is used. Valid values cpd-enterprise You purchased IBM Cloud Pak for Data Enterprise Edition. cpd-standard You purchased IBM Cloud Pak for Data Standard Edition.
`--preview`	Preview the commands that run when you issue this CLI command. The command issues a series of `oc` commands. You can optionally see the list of `oc` commands that are associated with the command. The `oc` commands are saved to the `preview.sh` file in the `cpd-cli-workspace/olm-utils-workspace/work` directory. Status Optional. Syntax `--preview=true\|false` Default value false If you omit this option, the default value is used. Valid values false Run the commands to apply the changes to your cluster. true Preview the commands without running them. You can optionally copy the `oc` commands from the output and run them yourself. However, this method is not recommended. When you run the commands manually, you do not have access to the additional helper scripts that are included in the underlying Ansible® playbook.
`--production`	Specify whether you purchased a non-production license. Restriction: This option applies only to Cloud Pak for Data Enterprise Edition. Status Optional. Syntax `--production=true\|false` Default value true If you omit this option, the default value is used. Valid values false You are running a non-production instance of Cloud Pak for Data. true You are running a production instance of Cloud Pak for Data.

Examples

Note: The following example uses the recommended installation environment variables.

Use a script to create environment variables with the correct values for your environment. For details, see Best practice: Setting up install variables.

Tell the License Service that you using a production deployment of Cloud Pak for Data Enterprise Edition

cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--entitlement=cpd-enterprise

Tell the License Service that you using a non-production deployment of Cloud Pak for Data Enterprise Edition

cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--entitlement=cpd-enterprise \
--production=false