Remote Agent Utility Command Line Applet switches

Article:HOWTO24148  |  Created: 2010-01-01  |  Updated: 2011-08-09  |  Article URL http://www.symantec.com/docs/HOWTO24148
Article Type
How To

Product(s)

Subject


Remote Agent Utility Command Line Applet switches

The following table describes the switches that you can use with the Remote Agent Utility Command Line Applet.

See About the Remote Agent Utility Command Line Applet.

Table: Remote Agent Utility Command Line Applet switches

Switch

Description

status:[n]

Status output is repeated every <n> seconds, with a range of 1 - 86400. Press Q to stop the output from running.

ramcmd /status:[n]

When you use the /status switch without a time value, the Remote Agent status appears in the command window and then the applet exits.

/publish:[on | off | add | remove | interval][/ms:<media server>] [/t:<x>]

Use the following parameters with the /publish switch:

  • No parameter specified- Displays the publishing status and then exits.

  • [on] - Turns publishing on. Lets the Remote Agent send information about itself, such as its version and IP address.

  • [off] - Turns publishing off.

  • [add], [remove] - Used with /ms. You can use this parameter to add or remove media servers from the Remote Agent&apos;s publish list.

  • [interval] - Used with /t. Specifies the time interval that the Remote Agent sends information about itself to the media server.

    You can set the time interval in minutes using the /t:[<x>] parameter.

Note:

The [interval] switch must be used with the /t: switch. Using [interval] alone on the command line is not supported.

ramcmd /publish:[on|off|add|remove|interval] [/ms<media server>][/t:<x>]

/oracle: [new | edit | delete]

/in:[<instance name>]

/ms:[<media server | address>]

/jt:[<job template>]

/user:[<username>]

/password:[<password> | * ]

/rc: [yes | no]

/tns:[<TNS name>]

Use the following parameters with the /oracle switch:

  • No parameter specified- Displays the existing Oracle instances and then exits.

  • [new], [edit], [delete] - Used with switch /in.

  • /in:[<instance name>] - Used to add, edit, and delete Oracle instance names from the Oracle instance list.

  • /ms:[<media server name | address>] - Sets the media server name or its IP address.

  • /jt:[<job template>] - Sets a Backup Exec job template.

  • /user:[<username>] - Sets a username.

  • /password:[<password> | *] - Sets a password to be used with /user:[<username>]. If you omit the password, or you use an asterisk [*], you do not need to enter the password on the command line. After the command runs, a prompt appears asking you for a password.

  • /rc:[yes | no] - Turns the Use recover catalog setting on or off. If /rc appears without a parameter, then the current status for that instance is displayed.

  • /tns:[TNS name] - Sets the TNS name alias of an available Oracle database and the server it resides on in the Oracle TNSNAMES file.

    ramcmd.exe /oracle:edit /in:<instance name> /rc:[yes|no][/tns:<TNS name>][/user:<username>][/password:password|*]

/db2: [new | edit | delete]

/in:[<instance name>]

/ms:[<media server | address>]

/jt:[<job template>]/user:[<username>]

/password:[<password> | * ]

/al:<archive log template>

/tns:[<TNS name>]

Use the following parameters with the /db2 switch:

  • No parameter specified- Displays the existing DB2 instances and then exits.

  • [new], [edit], [delete] - Used with switch /in.

  • /in:[<instance name>] - Used to add, edit, and delete DB2 instance names from the DB2 instance list.

  • /ms:[<media server name | address>] - Sets the media server name or its IP address.

  • /jt:[<job template>] - Sets a Backup Exec job template.

  • /user:[<username>] - Sets a username.

  • /password:[<password> | *] - Sets a password to be used with /user:[<username>]. If you omit the password, or you use an asterisk [*], you do not need to enter the password on the command line. After the command runs, a prompt appears asking you for a password.

  • /al:<archive log template>- Sets the archive log template name to <archive log template>.

  • /tns:[TNS name] - Sets the TNS name alias of an available Oracle database and the server it resides on in the Oracle TNSNAMES file.

    ramcmd .exe /db2:new /in:<instance name> /ms:<media server|address> [/jt:<job template>] [/al:<archive log template>] /user:<username> [/password:<password>|*]

/auth:[on | off] [/user:<username>] [/password:<password> | *]

Enables or disables media server authentication for Oracle and DB2 operations.

  • /auth:on - Turns the state on. Requires /user parameter.

  • /auth:off - Turns the state off. Requires /user parameter.

  • /user:<username> - Sets a username.

  • /password:<password> - Sets a password to be used with /user:<username>. If you enter an asterisk for the password or omit the password, you are prompted for the password.

/port:[<port>]

Displays or sets a custom port that is used to connect to the media server during Oracle and DB2 operations.

  • /port - Displays the current port number. If the port is the default port, displays "(default)".

  • /port:<port> - Sets the port number to <port>. To change the port to the default port number, type [/port:0].

/log_path:[<log path>]

Displays or sets a custom path for debug logs.

  • /log_path - Displays the log directory path and then exits.

  • /log_path:<"logs path"> - Creates the directory <"logs path">. If the path has a space in the name, enclose the path in quotes. For example, "C:\Program files\LogsFolder".

See Using the Remote Agent Utility Command Line Applet


Legacy ID



id-SF700163095_be2010_adm


Article URL http://www.symantec.com/docs/HOWTO24148


Terms of use for this information are found in Legal Notices