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

AlterCloud task

Changes parameters global to the cloud.

Syntax 1 (SQL)
CALL DBCloud.AlterCloud ( [ optional-parameters ] )
Syntax 2 (Cloud Command utility)
dbcloudcmd run AlterCloud [ optional-parameters ]
Parameters
  • retention_period_num

    The length of the data retention period. The default is NULL.

  • retention_period_unit

    The unit type of the data retention period. The default is the current value.

    The following values are supported:

    • L

      Milliseconds.

    • S

      Seconds.

    • M

      Minutes.

    • H

      Hours.

    • D

      Days.

    • W

      Weeks.

  • smtp_from_address

    The sending email address. The default is the current value.

  • smtp_server

    The host name or IP address of the SMTP server. The default is the current value.

  • smtp_port

    The port number of the SMTP server. The default is the current value.

  • smtp_certificate

    The certificate for validating the SMTP server if a TLS connection is used. The default is the current value.

  • smtp_username

    The user name for the SMTP server. The default is the current value.

  • smtp_password

    The password for the SMTP server. The default is the current value.

  • tcp_ports

    The TCP/IP port numbers and/or port ranges separated by commas. The default is the current value.

  • http_ports

    The HTTP port numbers and/or port ranges separated by commas. The default is the current value.

  • https_ports

    The HTTPS port numbers and/or port ranges separated by commas. The default is the current value.

  • tenant_isolation_enabled

    Tenant isolation enabled. Set to 1 to enable tenant isolation and 0 to disable tenant isolation. The default is the current value.

  • secure_feature_list

    The secure feature list for the cloud. The default is the current value.

  • secure_feature_key

    The password for secure features. The default is the current value.

  • language

    The language code for the cloud. The default is the current value.

    The following values are supported:

    • cloud

      Cloud default language.

    • de

      German.

    • en

      English.

    • fr

      French.

    • ja

      Japanese.

    • zh

      Chinese.

  • usage_proxy

    The proxy server (host:port) to use when uploading usage information to SAP. The default is the current value.

  • cloud

    The cloud ID. The default is the current cloud.

  • autostart_timeout

    The maximum time that a connection waits while attempting to automatically start a database before it times out. The minimum timeout is 30 seconds and the maximum timeout is 600 seconds. Applies to databases that are configured to autostart. The default is the current value.

  • description

    The description of the cloud, in quotes. The default is the current value.

  • object_etag

    Internal use only. The default is NULL.

  • object_updated

    The last time the object was modified. If provided, the task fails if the object has changed since the specified time. The default is NULL.

Required privileges

AlterCloud

Remarks
  • language

    This parameter modifies the language used by the cloud. Strings that have already been stored (for example, error messages for previously executed tasks) are not changed.

  • retention_period_num

    This parameter is used by the CleanCloud task to identify expired data that can be deleted from the cloud. The retention period's initial setting is 30 days.

  • smtp parameters

    The smtp_from_address, smtp_server, smtp_port, smtp_certificate, smtp_username, and smtp_password parameters are used for sending notification emails. The cloud partners must have access to your SMTP server.

  • tcp_ports, http_ports, and https_ports

    These parameters are used to change the default port ranges that are assigned when hosts are added to the cloud. Use AlterHost to change the port ranges once the host has been added.

  • secure_feature_key

    See information about secure feature keys.

  • secure_feature_list

    Use this parameter to provide a list of features that are secure. Specify a hyphen (-) in front of features that you want to remove from the list of secure features for the cloud. When the cloud is created, all secure features are disabled, except the backup feature.

  • tenant_isolation_enabled

    When the cloud is created, tenant isolation is enabled. It is strongly recommended that tenant isolation remains enabled to ensure tenant data security.

  • object_updated

    To ensure that you are not over-writing another user's changes, run dbcloudcmd -v describe task to get the time the cloud was last modified. Specify this value as the object_updated parameter. If the cloud has been altered since the specified time, then the task fails with an error. If this occurs, run the task again after re-running dbcloudcmd -v describe task.

Example

The following command alters the retention period to five weeks:

dbcloudcmd run AlterCloud retention_period_num=5 retention_period_unit=W

The following command deletes the contents of the smtp_from_address parameter for the cloud:

dbcloudcmd run AlterCloud default default null