manage get-physical-locations

Get information about one or more physical locations that are associated with an instance of Cloud Pak for Data.

Required role
To run this command, you must have the Manage physical locations (manage_locations) permission in the primary instance of IBM Cloud Pak for Data (the hub).

Extended description

You can get information about a specific remote physical location or all of the remote physical locations that are associated with an instance of Cloud Pak for Data.

You can optionally get information about the data planes the remote physical location is included in.

Syntax

cpd-cli manage get-physical-locations \
--cpd_hub_url=<route> \
--cpd_hub_api_key=<base64-encoded-API-key> \
--name=<name-of-a-physical-location> \
--all \
--include_data_planes=true|false

Arguments

The get-physical-locations command has no arguments.

Options

Table 1: Command options
Option Description
--all Use this option to get information about all of the physical locations that are associated with an instance of Cloud Pak for Data.
Status
Optional.

If you don't use this option, you must use the --name option.

Syntax
--all
Default value
Not applicable.
Valid values
Not applicable.
--cpd_hub_api_key Your base64-encoded API key for the primary instance of Cloud Pak for Data 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 Cloud Pak for Data 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.
--include_data_planes A physical location can be included added to multiple data planes. Specify whether to return the list of data planes the physical location is included in.
Status
Optional.
Syntax
--include_dependency=true|false
Default value
false
Valid values
false
Do not include the list of data planes.
true
Include the list of data planes.
--name Use this option if you want to get information about a specific physical location.
Status
Optional.

If you don't use this option, you must use the --all option.

Syntax
--name=<name-of-a-physical-location>
Default value
No default.
Valid values
The name of a 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.

Get information about all of the remote physical locations associated with an instance of Cloud Pak for Data

Return the list of data planes for each remote physical locations.

cpd-cli manage get-physical-locations \
--cpd_hub_url=${CPD_HUB_URL} \
--cpd_hub_api_key=${CPD_HUB_API_KEY} \
--include_data_planes=true \
--all
Get information about a specific remote physical location
cpd-cli manage get-physical-locations \
--cpd_hub_url=${CPD_HUB_URL} \
--cpd_hub_api_key=${CPD_HUB_API_KEY} \
--name=${REMOTE_PHYSICAL_LOCATION_ID}