N1 Service Provisioning System 4.1 Reference Guide

CLI Input Types

Table 4–6 describes the syntax of each type of input argument that may be passed to a CLI command.

Table 4–6 Syntax of CLI Input Types

Input Type 

Syntax 

AppInstance, AppInstanceID 

NM:<host name>:(RA|LD|MS) or 

[ID:]<ID> 

AppTypeCriteria  

<comma or pipe separated list of (RA|LD|MS)> or 

EMPTY 

AttributeCriteriaList  

<semicolon separated list of <attribute criteria>> 

where <attribute criteria> is <attribute name>-(contains|equals)-<glob pattern value> 

where <attribute name> is one of: 

name or 

description or 

hostTypeName or 

IP or 

parentHostName or 

<user defined name> 

Boolean  

case insensitive, one of: 

true or 

yes or 

t or 

+ or 

false or 

no or 

f or 

Category, 

CategoryID, 

Category ID Set 

<ID> 

ID:<ID> 

NM:<category name> 

CompCheckInID 

[ID:]<ID> 

ComponentTypeRefID 

NM:<comp type ref name> 

[ID:]<ID> 

Component, 

ComponentID 

NM:<comp name>[:<build number>] or 

[ID:]<ID> 

ComponentVariableSettings, ComponentVariableSettingsID  

NM:<comp name>[:<version>]:<var settings name> or 

[ID:]<ID> 

CriteriaShorthand  

any or 

planStart or 

planEndNormal or 

planEndAbnormal or 

diffStart or 

diffEndNormal or 

diffEndAbnormal or 

system or 

admin or 

custom 

DifferenceSettings, 

DifferenceSettingsID 

NM:<diff name> or 

[ID:]<ID> 

ExecutionPlan, 

ExecutionPlanID 

NM:<plan name>[:<version>] or 

[ID:]<ID> 

Group, 

GroupID 

NM:<group name> or 

[ID:]<ID> 

Hashtable  

<semicolon separated list of <key>[=<value>]> 

where <value> is one of: 

<single value> or 

[<comma separated list of <single values>>] 

Examples: 

color=red;emptykey or 

arraykey=[value1,value2] 

Host, 

HostID 

NM:<host name> or 

[ID:]<ID> 

HostIDArrayArray  

<semicolon separated list of <host ID arrays>> 

where <host ID array> is a <comma separated list of <host or host set IDs>> 

where <host or host set ID> is one of: 

HS:<HostSetID> or 

H:<HostID> 

Examples: 

H:NM:host1 or 

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

HostIDSet  

<comma separated list of <HostIDs>> 

HostSearch, 

HostSearchID  

NM:<host search name> or 

[ID:]<ID> 

HostSearchIDSet  

<comma separated list of <HostSearchIDs>> 

HostSet, 

HostSetID 

NM:<host set name> or 

[ID:]<ID> 

HostSetIDSet  

<comma separated list of <HostSetIDs>> 

HostType. 

HostTypeID 

NM:<host type name> or 

[ID:]<ID> 

HostTypeVarList  

<semicolon separated list of <key>[=<single value>]> 

InputStreamWrapper  

- {for stdin} or 

<input filename> 

InstalledComponentRef  

<comp name>:<comp build>:<install path> 

InstalledResourceRef  

<resource ID>:<install path> 

Level  

host or 

dir or 

file 

NamedBlockType 

One of the three literal constants: 

install 

uninstall 

call 

OutputStreamWrapper  

one of: 

[+]<filename> {plus means append}

- {for stdout} 

-: {for stderr} 

Permission, 

PermissionID  

NM:userdb.read or 

NM:userdb.write or 

NM:host.read or 

NM:host.write or 

NM:hostType.read or 

NM:hostType.write or 

NM:rule.read or 

NM:rule.write or 

NM:component.read or 

NM:component.write or 

NM:plan.read or 

NM:plan.write or 

NM:plan.run:allhosts or 

NM:plan.run:<host set name> or 

NM:diff.read or 

NM:diff.write or 

NM:diff.run:allhosts or 

NM:diff.run:<host set name> or 

[ID:]<ID> 

PhysicalCriteria  

<comma or pipe separated list of (VIRT|PHYS)> or 

EMPTY 

ReaderWrapper  

- {for stdin} or 

<input file name> 

ResourceID  

[ID:]<ID> 

RoxAddress  

<IP name or address>:<port number> 

RuleID, 

RuleMetaData  

NM:<rule name> or 

[ID:]<ID> 

Scope  

component or 

host or 

hostset 

SystemServiceRefID 

NM:<system service ref name> 

[ID:]<ID> 

SeverityArray  

<empty> or 

INFO[+] {plus means “or greater”} or 

WARNING[+]or 

ERROR[+] 

StringArray  

<comma separated list of <strings>> 

StringArrayArray  

<semicolon separated list of <StringArrays>> 

Style  

mm {for model to model} or 

mi {for model to directory} or 

ii {for directory to directory} 

TimeInterval  

- {for indefinite} or 

@<Date> {from now to Date} or 

[<weeks>w][<days>d] 

[<hours>h][<minutes>m] 

[<seconds>s][<millisecs>ms] or 

[<weeks>w][<days>d] 

[<hours>:]<minutes>[. 

<seconds>[.<millisecs>]] 

User, 

UserID 

NM:<user name> or 

[ID:]<ID> 

WriterWrapper  

one of: 

[+]<filename> {plus means append}

- {for stdout} 

-: {for stderr}