Administer > Content utilities > IDK commands

IDK commands

ISMTool argument types

The following table defines the argument types that are used in the ISMTool commands defined in the rest of this section. The ISMNAME argument type, for example, is specified by the syntax of the ISMTool --new command.

 

Argument Type

Description

Example

PATH

Absolute file system path.

/foo/bar

STRING

Text string with no spaces.

foobar

TEXT

Arbitrary quoted text. On Unix you enclose the text in single quotes; on Windows use double quotes.

'This is some text'

BOOL

Boolean

true or false

ISMFILE

Path to a valid .ism file in the file system. This file would unpack into an ISMDIR.

/foo/bar/name.ism

ISMDIR

Path to a valid extracted ISMFILE or to a newly created ISM.

xyz
/home/sam/xyz

ISMNAME

Name for a newly-created ISM. The ISMNAME can have the format STRING or STRING-VERSION.

ntp
ntp-4.1.2

VERSION

A STRING that represents the version of the ISM. The VERSION cannot contain spaces and must be a legal version string for the native packaging engine.

1.2.3
4.13
0.9.7b

HOST[:PORT]

Host and optional port.

www.foo.com
www.foo.com:8000
192.168.1.2:8000

BYTES

Integer number of bytes.

42

SECONDS

Integer number of seconds.

300

PARAMTYPE

Expected type of the parameter data. The only allowed values are the constants ‘String’ and ‘Template’. On Unix you enclose the values in single quotes; on Windows use double quotes.

‘String’
‘Template’