Previous Topic: dpmrm createfromtemplate Command--Create Reservation

Next Topic: dpmrm extend Command--Extend a Reservation

dpmrm cancel Command--Cancel a Reservation

The cancel command cancels a reservation.

This command has the following format:

dpmrm cancel [-sc sc_url] -resid reservationid [[-ws_user user name -ws_password password]|[-prompt yes|no]][-locale iso639value][-pre][-post]
-sc sc_url

(Optional) Defines the URL for the service controller host.

Example: https://hostname:port/...

hostname

Defines the fully qualified host where the service controller is installed.

Example: localhost.ca.com

port

Defines the listening port for the service controller server.

Example: 80

-resid reservationid

Defines the reservation identification number. Valid entry: positive integer.

-ws_user username -ws_password password

(Optional) Specifies the credentials to use for the web service security check. If you do not include credentials, you are prompted to enter them. Avoid the prompt for credentials by setting up your own session using caaipsecurity.

-locale iso639value

(Optional) Specifies an IS0 639_3166 combination (for example: fr_FR for French) to override the default English output. To use the locale of the command prompt, specify "native".

-prompt yes | no

Defines whether to prompt the user for username and password.

-pre

(Optional) Specifies whether to generate an event before the operation is performed.

-post

(Optional) Specifies whether to generate an event after the operation is performed.

Example: Cancel a Reservation

In this example, the reservation 4321 is canceled after prompting the user for validation.

dpmrm cancel -resid 4321 -prompt yes