CLI operation

You can modify the specified database definitions from the command line interface.

Before you begin

The current database must be initialized to use DCM.

You must be working as the DCM manager or administrator to use the -modify option.

You must be working as the CM administrator to use the -automatic_receive and -noautomatic_receive options.

About this task

ccm dcm -m|-modify -dbid|-database_id [-desc|-description description] 
        [-tm|-transfer_mode ((manual|manual_copy) | direct | 
        (cp|copy|local_copy) | (rcp|remote_copy) |
        (ftp|file_transfer_protocol) | (user|user_defined))] 
        ([-ar|-automatic_receive] | [-noar|-noautomatic_receive]) 
        ([-rb|-run_in_background] | [-norb|-norun_in_background]) [-host host] [-os|-operating_system (unix | (windows|windows_nt))] 
        [-path path] [-tp|-transfer_path path] [-ccm_home path] 
        ([-zip] | [-nozip]) ([-ga|-generate_allowed] | 
        [-noga|-nogenerate_allowed]) ([-handover_allowed] | 
        [-nohandover_allowed]) ([-hidden] | [-nohidden]) 
        [-location location] [-admin_info admin_info] 
        [-new_dbid|-new_database_id new_dbid] database_spec...
-admin_info admin_info
Specifies to modify the contact information for the specified database. The admin_info value can be any string that doesn't contain newline characters. For example, phone numbers and email addresses are valid entries.
-ar|-automatic_receive
Specifies to automatically receive transfer packages for the specified databases.
-ccm_home path
For the specified databases, modify the Synergy $CCM_HOME installation path to be used to perform an automatic receive. Enter an absolute path if a UNIX server hosts the corresponding database. Enter a UNC path if a Windows server hosts it.
database_spec
Specifies the database definitions to be modified. See Database specification.
-desc|-description description
Specifies to modify the specified database description. The description cannot contain newline characters.
-ga|-generate_allowed
Specifies to modify the database definitions so DCM generate can use them.
-handover_allowed
Specifies that the database definitions will be modified to allow handover of control of objects to them.
-hidden
Specifies to mark specified database definitions as hidden so that they don't appear in dialogs that list database identifiers. This option is useful when you want to retire a database definition without deleting it.
-host host
Specifies to modify the host for the specified database definitions. This is required for the remote copy and file transfer protocol transfer modes. Be sure that the host name is valid and is set to an IP address.
-location location
Specifies to modify the geographic location of the specified database. The location can be any string not containing newline characters.
-new_dbid|-new_database_id new_dbid
Specifies the new database ID that you want to assign to the specified database definition. To learn about restricted characters and why they are restricted, see Naming restrictions.
-noar|-noautomatic_receive
Specifies not to receive the transfer package automatically. Packages must be received manually.
-nohandover_allowed
Specifies that the database definitions will be modified to disallow handover of control of objects to them.
-nohidden
Specifies to show the specified database definition in dialogs that list database identifiers.
-noga|-nogenerate_allowed
Specifies to modify the database definitions so DCM generate cannot use them.
-norb|-norun_in_background
Specifies not to run automatic receive in the background, if it is being used.

If you are using automatic receive, when DCM generate completes generating and transferring the package, it will start a session on the destination database to start the receive of the package. If you're using -norun_in_background, the generate waits for completion of the receive and shows the results of the receive in the destination database.

This is the default.

-nozip
Specifies not to compress the transfer packages for the specified database. This is the default for the direct transfer mode. You cannot use this option with the file transfer protocol transfer mode.
-os|-operating_system (unix|(windows|windows_nt))
Specifies that the operating system for the machine hosting the database be modified for the specified database definitions.
-path path
Specifies to modify the database path for the specified database definitions. Use an absolute path for UNIX servers; use a UNC path for Windows servers. You must enter a database path value if you use a transfer mode other than manual.
-rb|-run_in_background
Specifies to run automatic receive in the background, if it is being used.

If you are using automatic receive, when DCM generate completes generating and transferring the package, it will start a session on the destination database to start the receive of the package. If you're using -run_in_background, the generate does not wait for completion of the receive and immediately returns. You do not have to wait for the transfer package to be received to continue using your session, but you will not see if the receive was successful. You can view details of the receive later, in the DCM event log in the destination database.

The default is -norb|-norun_in_background.

-tm|-transfer_mode value
Specifies the transfer mode to be modified for the specified database definition. The transfer mode defines the way transfer packages are transferred to the destination database:

The -transfer_modeoption must have one of these values:

  • manual | manual_copy

    The package is not copied by DCM and must be transferred manually.

  • cp | copy | local_copy

    The package is generated and then copied to the destination database's transfer path.

  • direct

    The package is generated directly into the destination database's transfer path.

  • ftp | file_transfer_protocol

    The package is generated and then transferred to the destination database's transfer path using ftp.

  • rcp | remote_copy

    The package is generated and then remote copied to the destination database's transfer path using rcp.

  • user | user_defined

    The package is generated and then transferred by invoking a user-customized shell script (Unix) or batch file (Windows).

-tp|-transfer_path transfer_path
Specifies to modify the transfer path to the database for the specified database definitions. The transfer path is the location where Synergy places transfer packages. This is an absolute path for UNIX servers, and a UNC path for Windows servers. If you leave a transfer path blank, Synergy places the packages under the dcm/receive directory under the database path.
-zip
Specifies to compress the transfer packages for the specified database. This is the default for the file transfer protocol transfer mode. You cannot use this option with direct.

Feedback