manage delete-physical-location

Remove the IBM Software Hub agents from the physical location.

Required role
To run this command, you must have the following permissions:
  • Cluster administrator You must be a cluster administrator on the remote cluster.
  • You must have the Manage physical locations (manage_locations) permission in the primary instance of IBM Cloud Pak for Data (the hub).

Prerequisites

Before you run this command, stop any workloads and delete any service instances that are running on the remote physical location.

Extended description

If the remote physical location was registered with an instance of Cloud Pak for Data, this command:
  • Tells the instance to stop watching the remote physical location.
  • Removes the remote physical location from the primary instance.

Syntax

cpd-cli manage delete-physical-location \
--physical_location_name=<unique-ID> \
--management_ns=<project-name> \
--cpd_hub_url=<route> \
--cpd_hub_api_key=<base64-encoded-API-key>

Arguments

The delete-physical-location command has no arguments.

Options

Table 1: Command options
Option Description
--cpd_hub_api_key Your base64-encoded API key for the primary instance of IBM Software Hub that you want to connect to.
Status
Required.
Syntax
--cpd_hub_api_key=<base64-encoded-API-key>
Default value
No default.
Valid values
The API key that you specified when you created the remote physical location.
--cpd_hub_url The route to the primary instance of IBM Software Hub that you want to connect to.
Status
Required.
Syntax
--cpd_hub_url=<route>
Default value
No default.
Valid values
The route that you specified when you created the remote physical location.
--management_ns The management project associated with the remote physical location.
Status
Required.
Syntax
--management_ns=<project-name>
Default value
No default.
Valid values
The management project associated with the remote physical location.
--physical_location_name The name that identifies a physical location.
Status
Required.
Syntax
--physical_location_name=<unique-ID>
Default value
No default.
Valid values
The name that you specified when you created the remote physical location.

Examples

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

It is strongly recommended that you use a script to create environment variables with the correct values for your remote physical location. For details, see Setting up environment variables for a remote physical location.

Delete a remote physical location
cpd-cli manage delete-physical-location \
--physical_location_name=${REMOTE_PHYSICAL_LOCATION_ID} \
--management_ns=${REMOTE_PROJECT_CERT_MANAGER} \
--cpd_hub_url=${CPD_HUB_URL} \
--cpd_hub_api_key=${CPD_HUB_API_KEY}