N1 Grid Service Provisioning System 5.0 Command-Line Interface Reference Manual

Appendix A Input Types

The following table describes the syntax of the input argument types that can be passed to a CLI command.

In addition to the typographic conventions described in Typographic Conventions, text that is surrounded by square brackets ([]) is optional.

Table A–1 Syntax of CLI Input Types

Input Type 

Syntax 

AppInstance,

AppInstanceID

One of the following: 

  • NM:host-name:RA

  • NM:host-name:LD

  • NM:host-name:MS

  • [ID:]ID

AppTypeCriteria

Comma-separated or pipe-separated list of the following values: 

  • RA

  • LD

  • MS

Or: 

empty

AttributeCriteriaList

attribute-criteria[;attribute-criteria]*

Where attribute-criteria is one of the following:

  • attribute-name-contains-glob-pattern-value

  • attribute-name-equals-glob-pattern-value

Where attribute-name is one of the following values:

sys.hostName, sys.description, sys.hostType, sys.ipAddress, sys.parent, sys.OS, sys.OSVersion, sys.OSArch, or user-defined-name

Where glob-pattern-value is a string that contain the wildcard characters * and .

Boolean

The following case-insensitive values for true and false: 

  • true, yes, t, or +

  • false, no, f or -

Category,

CategoryID,

CategoryIDSet

One of the following: 

  • NM:category-name

  • [ID:]ID

CompCheckInID

[ID:]ID

ComponentTypeRefID

One of the following: 

  • NM:component-type-ref-name

  • [ID:]ID

Component,

ComponentID

One of the following: 

  • NM:component-name[:version]

    If version is not specified, the latest version is used

  • [ID:]ID

ComponentVariableSettings, ComponentVariableSettingsID

One of the following: 

  • NM:component-name[:version]:var-settings-name

    If version is not specified, the latest version is used

  • [ID:]ID

ConnectionType

One of the following: 

  • raw

  • ssh

  • ssl

CriteriaShorthand

One of the following: 

  • any

  • planStart

  • planEndNormal

  • planEndAbnormal

  • diffStart

  • diffEndNormal

  • diffEndAbnormal

  • system

  • admin

  • custom

DifferenceSettings,

DifferenceSettingsID

One of the following: 

  • NM:diff-name

  • [ID:]ID

ExecutionPlan,

ExecutionPlanID

One of the following: 

  • NM:plan-name[:version]

    If version is not specified, the latest version is used

  • [ID:]ID

Folder,

FolderID

One of the following: 

  • NM:folder-name

  • [ID:]ID

Group,

GroupID

One of the following: 

  • NM:group-name

  • [ID:]ID

Hashtable

key[=value][;key[=value]]*

Where key is a keyword

Where value is one of the following:

  • single-value

  • [single-value,single-value[,single-value]*]

    The outermost square brackets are required

Examples: 

  • color=red;emptykey

  • arraykey=[value1,value2]

Host,

HostID

One of the following: 

  • NM:host-name

  • [ID:]ID

HostIDArrayArray

host-ID-array[;host-ID-array]*

Where host-ID-array is one of the following:

  • host-ID[,host-ID]*

  • host-set-ID[,host-set-ID]*

Where host-ID is H:host-ID and host-set-ID is HS:host-set-ID

Examples: 

  • H:NM:host1

  • HS:NM:hostSetFoo,H:NM:h1;H:NM:h2

HostIDSet

host-ID[,host-ID]*

HostSearch,

HostSearchID

One of the following: 

  • NM:host-search-name

  • [ID:]ID

HostSearchIDSet

host-search-ID[,host-search-ID]*

HostSet,

HostSetID

One of the following: 

  • NM:host-set-name

  • [ID:]ID

HostSetIDSet

host-set-ID[,host-set-ID]*

HostType.

HostTypeID

One of the following: 

  • NM:host-type-name

  • [ID:]ID

HostTypeVarList

key[=single-value][;key[=single-value]]*

InputStreamWrapper

One of the following: 

  • - for standard input

  • input-file-name

InstalledComponentRef

component-name:component-version:install-path

InstalledResourceRef

resource-ID:install-path

Level

One of the following: 

  • host

  • dir

  • file

NamedBlockType

One of the following: 

  • install

  • uninstall

  • call

OutputStreamWrapper

One of the following: 

  • [+]filename, where + means to append

  • - for standard output

  • -: for standard error

Permission,

PermissionID

One of the following: 

  • permID

  • NM:permID

  • NM:userdb.read

  • NM:userdb.write

  • NM:host.read

  • NM:host.write

  • NM:hostType.read

  • NM:hostType.write

  • NM:rule.read

  • NM:rule.write

  • NM:diff.read

  • NM:diff.write

  • NM:diffrun:allhosts

  • NM:diffrun:host-set-name

  • NM:folder:folder-name:write

  • NM:folder:folder-name:checkin-current

  • NM:folder:folder-name:autorun

  • NM:folder:folder-name:execute:allhosts

  • NM:folder:folder-name:execute:host-set-name

  • NM:folder:folder-name:owner

PhysicalCriteria

phys-attribute[|phys-attribute]*

Where phys-attribute is virt or phys

Or: 

empty

Plugin,

PluginID

One of the following: 

  • NM:plugin-name

  • [ID:]ID

ReaderWrapper

One of the following: 

  • - for standard input

  • input-file-name

RoxAddress

One of the following: 

  • IP-name:port-number

  • IP-address:port-number

RuleID,

RuleMetaData

One of the following: 

  • NM:rule-name

  • [ID:]ID

Scope

One of the following: 

  • component

  • host

  • hostset

SeverityArray

One of the following: 

  • empty

  • INFO[+], where + means “or greater”

  • WARNING[+]

  • ERROR[+]

StringArray

string[,string]*

StringArrayArray

string-array[;string-array]*

Style

One of the following: 

  • mm for model to model

  • mi for model to install

  • ii for install to install

SystemServiceRefID

One of the following: 

  • NM:system-service-ref-name

  • [ID:]ID

TimeInterval

One of the following: 

  • - for an indefinite interval

  • @Date from now to Date

    Where Date is of the form mm/dd/yyyy HH:MM

  • [#weeksw][#daysd][#hoursh][#minutesm]

    [#secondss][#millisecsms]

  • [#weeksw][#daysd][#hours:]#minutes[.#seconds

    [.#milliseconds]]

User,

UserID

One of the following: 

  • NM:user-name

  • [ID:]ID

WriterWrapper

One of the following: 

  • [+]filename, where + means to append

  • - for standard output

  • -: for standard error