Working with Resources of the SAP Service Manager Using the btp CLI

Use the SAP BTP command line interface to perform various operations related to your platforms, attached service brokers, service instances, and service bindings.

You can also get information about the service plans and service offerings associated with your subaccount.

For more information about the SAP Service Manager, see SAP Service Manager.

Tip:

All of these commands are executed in subaccounts. If you know you are working in a specific subaccount, we recommend using the btp target command to set the target to this subaccount. Then you won't have to provide the subaccount ID with every command call. See Set a Target for Subsequent Commands with btp target.

For detailed descriptions of all SAP Service Manager CLI commands, see SAP Service Manager Commands for SAP BTP command line interface.

Managing Platforms

Task	Run the command ...	Command help
List all registered platforms in the current subaccount	`btp list services/platform`	btp list services/platform
Get details about a specific platform registered in the current subaccount	`btp get services/platform`	btp get services/platform
Register a new platform in the current subaccount	`btp register services/platform`	btp register services/platform
Update an existing platform registered in the current subaccount	`btp update services/platform`	btp update services/platform
Unregister an existing platform in the current subaccount	`btp unregister services/platform`	btp unregister services/platform

Managing Service Brokers

Task	Run the command ...	Command help
List all registered brokers in the current subaccount	`btp list services/broker`	btp list services/broker
Get a specific service broker in the current subaccount	`btp get services/broker`	btp get services/broker
Register a new service broker in the current subaccount	`btp register services/broker`	btp register services/broker
Update an existing service broker in the current subaccount	`btp update services/broker`	btp update services/broker
Unregister an existing service broker in the current subaccount	`btp unregister services/broker`	btp unregister services/broker

Managing Service Instances

Task	Run the command ...	Command help
List all service instances associated with the current subaccount.	`btp list services/instance`	btp list services/instance
Get details about a specific service instance associated with the current subaccount.	`btp get services/instance`	btp get services/instance
Create a new service instance of the service you want to consume.	`btp create services/instance`	btp create services/instance
Delete an existing service instance.	`btp delete services/instance`	btp delete services/instance
Share a service instance	`btp share services/instance`
Unshare a service instance	`btp unshare services/instance`

Note:

The optional --show-parameters available for btp get services/instance and btp get services/binding commands returns parameters only if the service offering associated with the instance or binding for which to view parameters has the instances_retrievable or bindings_retrievable parameter values respectively set to true.

Tip:

To check associated service offering's instances_retrievable value, run the following commands:

btp get services/instance and find the plan_id for the instance. Use the plan ID in

btp get services/plan and check the offering_id for the instance. Use the offering ID in

btp get services/offering and see whether the instances_retrievable parameter's value is set to true.

Start with btp get services/binding and then use the same commands for plan and offering details if you're checking the bindings_retrievable value.

Managing Service Bindings

Task	Run the command ...	Command help
List all service bindings associated with the current subaccount.	`btp list services/binding`	btp list services/binding
Get details about a specific service binding associated with the current subaccount.	`btp get services/binding`	btp get services/binding
Create a new binding between an existing service instance and an application.	`btp create services/binding`	btp create services/binding
Delete an existing binding between a service instance and an application.	`btp delete services/binding`	btp delete services/binding

Viewing Service Plans

Task	Run the command ...	Command help
List all service plans of services available for consumption that are associated with your current subaccount.	`btp list services/plan`	btp list services/plan
Get details about a specific service plan of a service that is available for consumption and associated with your current subaccount.	`btp get services/plan`	btp get services/plan

Viewing Service Offerings

Task	Run the command ...	Command help
List all service offerings associated with your current subaccount.	`btp list services/offering`	btp list services/offering
Get details about a specific service offering associated with your subaccount.	`btp get services/offering`	btp get services/offering