Click here to view and discuss this page in DocCommentXchange. In the future, you will be sent there automatically.

SAP SQL Anywhere, on-demand edition 1.0 SP 6 » Task syntax

ForgetHost task

Removes the metadata of the host.

Syntax 1 (SQL)
CALL DBCloud.ForgetHost ( host=host [, optional-parameters ] )
Syntax 2 (Cloud Command utility)
dbcloudcmd run ForgetHost host [ optional-parameters ]
Parameters
  • host

    The host to forget. Accepts a search query that identifies one host, for example a host name or ID. (Required)

  • unconditionally

    Set to 1 to forget the dependent objects when forgetting the host. If a dependent object exists, setting to 0 returns an error. The default is 0.

Required privileges

Administrator

Remarks

If unconditionally is set to 0, an error is returned if there is a cloud server, backup, or software version on the host. If unconditionally is set to 1, it forgets the target host, as well as all of the cloud servers, backups, and software versions on the host.

Forgetting a cloud object should only be done if repairing the object fails, and the object cannot be dropped from the cloud.

When possible, hosts should be removed from the cloud using the DropHost task. The DropHost task removes system resources (files, directories, and processes), and the host's metadata from the cloud. The ForgetHost task should be used only when the DropHost task cannot be used. The ForgetHost task does not attempt to remove or update system resources.

Since the ForgetHost task does not delete data files, you may want to delete the host's data files from the cloud data directory to ensure that subsequent cloud operations are not affected.

Example

Run the following task to remove the metadata of the host hostA:

dbcloudcmd run ForgetHost host=hostA