Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user IT Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

A command reference is a sequential file containing two sections:

  1. Universal Command - Command References#Options Options SectionUniversal Command -
  2. Command References#Command Section

The sections are separate with a logical end-of-file marker. The logical end-of-file market is the string <eof>.

...

Name                

Description

Values

-format

Format of the Universal Command - Command References#Command Section.
 
This option is required.

Valid values are:

  • cmd
    Command section contains a command.
  • script
    Command section contains a script. The script is defined in the same format as if it was being defined normally in a self-contained file.

-type

Type of command or script in the Universal Command - Command References#Command Section.
 
This option is not required.

Values depend on the UCMD Server operating system.

See the UCMD Server COMMAND_TYPE and SCRIPT_TYPE options for description of valid values.

-allow_options

Specification for whether or not the command or script accepts user-provided options or command line arguments from the UCMD Manager.
 
This option is not required.

Valid values are:

  • yes
    Options are passed.
    • For commands, the UCMD Manager options are concatenated to the end of the command.
    • For scripts, the UCMD Manager options are passed to the script as command line arguments.
  • no
    Options are not passed. This is the default.

...

The following figure is an example command reference that executes a Windows DIR command. The two sections are separated with a logical end-of-file marker, <eof>.

Panel
Html bobswift
<pre>
# Comments describing the command reference.
#
# Execute the DIR command.
#

-format         cmd
-type           shell
-allow_options  no
  
&lt;eof&gt;

DIR
</pre>

Anchor
Command Reference Request
Command Reference Request
Command Reference Request

...

Anchor
1133906
1133906
The command line options used in these examples are:

summary
HTML Table
cellspacing0
stylemargin-top: 0.0pt; text-align: left; width: 100%;
classTable_with_Header
Table Row (tr)
Table Cell (td)
stylebackground-color: #F0F0F0; border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: middle; width: 108pt;

Anchor
1133909
1133909
Option

Table Cell (td)
stylebackground-color: #F0F0F0; border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: middle; width: 324pt;

Anchor
1133911
1133911
Description

Table Row (tr)
Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1133916
1133916
-cmd

Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Command to execute on the remote system.

Table Row (tr)
Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1133916
1133916
-cmd_type

Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Type of command specified by -cmd.

...