Windows operating systems

Dsmcutil valid options

This section lists the valid dsmcutil options that you can specify to use the scheduler service.

About this task

/autostart:[Yes|No]
Specifies whether the Scheduler Service starts automatically at system boot time. The default is No.
/cadschedname:schedulername
Specifies the name of the scheduler service to manage with the client acceptor. Use this option when the managedservices option is set to schedule in the client options file dsm.opt. You can specify this option only with the client acceptor service.
/clientdir:clientdir
The fully qualified directory path where the Client Service files reside. This directory should be relative to the target workstation where the service is installed. UNC names are not allowed if the local system account is set to logon. The default is the current directory.
/clustername:clustername
This option replaces the /group option.

The /clustername option specifies the cluster name to which the system belongs. You can determine the cluster name in any of the following ways:

  • On MSCS, run the MSCS command, CLUSTER /LIST, from the command line or use the Cluster Administrator utility. When the Cluster Administrator utility starts, it displays a tree-like structure with the cluster name at the top.
  • On VCS, use the VCS Cluster Manager - Java™ Console or open the main.cf file in the %VCS_HOME%\config directory.
  • On VCS, use the following command:
    haclus -display
Restriction: Do not specify a clustername of more than 64 characters. If you specify more than 64 characters and you are using Veritas Storage Foundation with High Availability or a Microsoft Cluster Server configuration, you might not be able to install or start the IBM Spectrum Protect™ scheduler service.

This option must be used with the /clusternode:Yes option. This option must be specified when using the INSTALL command in a cluster environment. It must also be specified when using the UPDATE command to modify the cluster settings (/clusternode and /clustername).

This option can also be specified when using the UPDATEPW command in a cluster environment. Normally this is not required. However, if more than one scheduler service with different cluster settings are defined for a particular node, the utility cannot determine which settings are correct. In this case, correct the discrepancies between the services.

Alternatively, you can specify this option with /clusternode:Yes and /force:Yes, to force the utility to show or update the password with the specified cluster settings.

This option is not required if /clusternode:No is specified.

/clusternode:Yes|No
Specifies whether to enable support for cluster resources. The default value is No. You must be running the MSCS or VCS to specify /clusternode:Yes. This option must be specified when using the INSTALL command in a cluster environment. This option must also be specified when using the UPDATE command to modify the cluster settings (/clusternode, /clustername).

This option can also be specified when using the UPDATEPW command in a cluster environment. Normally this is not required. However, if more than one scheduler service with different cluster settings are defined for a particular node, the utility cannot determine which settings are correct. In this case, correct the discrepancies between the services.

Alternatively, you can specify this option with /clustername and /force:Yes, to force the utility to show or update the password with the specified cluster settings. If /clusternode:No is specified, /clustername is not required.

/commmethod:protocol
Specifies client communications protocol to communicate with the IBM Spectrum Protect server. Valid protocols are: TCP/IP and Named Pipes. If you do not specify a value, the value is obtained from the client options file or set to the default client value. You can also use this option with the UPDATEPW command to specify a communication protocol to connect to a server when updating passwords.
/commport:serverport
Specifies the protocol specific IBM Spectrum Protect server port. For TCP/IP, this is the port on the specified hostname. If this option is not specified, the value is obtained from the client options file or set to the default client value. You can also use this option with the UPDATEPW command to specify a protocol specific server port to connect to for updating passwords.
/commserver:servername
Specifies the protocol specific IBM Spectrum Protect server name. Depending on the protocol used, this can be a TCP/IP hostname or a Named Pipes name. If not specified, the value is obtained from the client options file or set to the default client value.

This option can also be used with the UPDATEPW command to specify a protocol specific server name to connect to for updating passwords.

/copyfiles
Specifies that the service installation is copied to another location prior to installing the service. Use the /srcdir option to specify the fully qualified source path.
/errorlog:errorlog
Specifies the fully qualified name of the client error log.
/eventlogging:[Yes|No]
Turns detailed event logging on or off for the specified scheduler service. The default is Yes.
/force:[Yes|No]
This option can also be specified when using the UPDATEPW command in a cluster environment. Normally this is not required. However, if more than one scheduler service with different cluster settings is defined for a particular node, the utility cannot determine which settings are correct. In this case, correct the discrepancies between the services.

Alternatively, you can specify this option with /clusternode and /clustername (if /clusternode:Yes is specified), to force the utility to show or update the password with the specified cluster settings.

/httpport:httpport
Specifies a TCP/IP port address for the web client.
/machine:machinename
Specifies the name of a remote workstation to connect to.
/name:servicename
Specifies the name of the Client service. The name must be quote delimited if it contains embedded spaces.
/node:nodename
Specifies the IBM Spectrum Protect node name the Client Service uses when connecting to the IBM Spectrum Protect server. Also used when displaying or updating the IBM Spectrum Protect password. The default is the workstation name.
/ntaccount:ntaccount
Specifies the Windows account which the service logs in as.
/ntdomain:ntdomain
Specifies the Windows domain which the service logs in as.
/ntpassword:ntpassword
Specifies the Windows password for the account under which the service logs in.
/oldpassword:oldpw
Current® IBM Spectrum Protect server password. Used in conjunction with the /updateonserver option when updating a password on the server.
/optfile:optionsfile
The fully qualified path of the client options file. This is the options file the specified Client Service uses to connect to the IBM Spectrum Protect server. The utility also uses the file to connect to the IBM Spectrum Protect server to validate and update passwords. Note that although this option overrides the default option file in the current directory (dsm.opt), the IBM Spectrum Protect API requires that a default option file exists in the current directory. UNC names are not allowed if the local system account is set to logon. The default is the dsm.opt file in the /clientdir directory.
/partnername:partner service name
This option is used when installing a Remote Client Agent Service to specify the partner Client Acceptor Service.
/password:password
The IBM Spectrum Protect password which is generated and encrypted.
/schedlog:schedlog
Specifies the fully qualified name of the client schedule log.
/srcdir:pathname
Use this option in conjunction with the /copyfiles option to specify the fully qualified source path to copy the service installation to another location prior to installing the service.
/startnow:[Yes|No]
Specifies whether dsmcutil starts the specified service after executing the command; the default is Yes. If you specify No, you must start the service manually using the services control panel applet, or the NET START name of the service.
/updateonserver:[Yes|No]
Specifies whether the specified password is updated on the IBM Spectrum Protect server. Requires using the /oldpassword option.
/validate:[Yes|No]
Specifies whether to perform validation when displaying or updating the encrypted password. The default is Yes.
/webports: webports
Specifies the TCP/IP port number used by the Client Acceptor service and the web client agent service for communications with the web GUI.