Documentation Home
> N1 Service Provisioning System 4.1 Reference Guide
N1 Service Provisioning System 4.1 Reference Guide
Book Information
Preface
Chapter 1 An Overview of N1 Service Provisioning System Software XML Schemas
Types of Plans
Types of Steps
Types of Components
Component References
Universal Install Path Format
Requirements for Locales and Character Sets
Pattern Matching
Variables and Parameter Passing
Call Compatibility
Install Compatibility
Boolean Operators
istrue Boolean Operator
istrue Boolean Operator Attributes
istrue Boolean Operator Examples
equals Boolean Operator
equals Boolean Operator Attributes
equals Boolean Operator Examples
matches Boolean Operator
matches Boolean Operator Attributes
matches Boolean Operator Examples
not Boolean Operator
not Boolean Operator Examples
and Boolean Operator
and Boolean Operator Examples
or Boolean Operator
or Boolean Operator Examples
Attribute Types
entityName Type
systemName Type
identifier Type
pathName Type
pathReference Type
modifierEnum Type
accessEnum Type
version Type
schemaVersion Type
Component Change Compatibility
Component Attribute Changes
Platform Changes
LimitToHostSet Changes
Extends Changes
Variable Changes
Component Ref List Changes
Component Ref Changes
Resource Changes
Install, Control and Uninstall Block Changes
Snapshot Block Changes
Diff Ignore Changes
Attribute and Child Element Ordering
Chapter 2 The N1 Service Provisioning System Software Component Schema
Components
The component Element
component Element attributes
component access attribute
component modifier attribute
component platform attribute
component limitToHostSet attribute
component attribute inheritance
component Child Elements
The extends Element
extends Child elements
The type Element
type Element attributes
The component varList Element
component varList Child elements
component varList Inheritance and Overriding
The component var Element
component var Element attributes
var access Attribute
var modifier Attribute
var Inheritance and Overriding
The resourceRef Element
resourceRef Element attributes
resourceRef modifier Attribute
resourceRef Child elements
resourceRef Inheritance and Overriding
The installSpec Element
installSpec Element attributes
The resource Element
resource Element attributes
The componentRefList Element
componentRefList Element attributes
componentRefList modifier Attribute
componentRefList Child elements
componentRefList Inheritance and Overriding
The componentRef Element
The componentRef Element attributes
componentRef modifier Attribute
componentRef installMode Attribute
The componentRef Child elements
componentRef Inheritance and Overriding
The componentRef/argList Element
The componentRef/component Element
The installList Element
installList Child elements
installList Inheritance and Overriding
The installSteps Element
installSteps Element attributes
installSteps access Attribute
installSteps modifier Attribute
installSteps Child elements
installSteps Inheritance and Overriding
The paramList Element
paramList Child elements
The param Element
param Element attributes
The local varList Element
local varList Child elements
The local var Element
local var Element attributes
uninstallList Element
uninstallList Child elements
uninstallList Inheritance and Overriding
The uninstallSteps Element
uninstallSteps Element attributes
uninstallSteps access Attribute
uninstallSteps modifier Attribute
uninstallSteps Child elements
uninstallSteps Inheritance and Overriding
The dependantCleanup Block Element
The snapshotList Element
snapshotList Child elements
snapshotList Inheritance and Overriding
The snapshot Element
snapshot Element attributes
snapshot access Attribute
snapshot modifier Attribute
snapshot Child elements
snapshot Inheritance and Overriding
The snapshot prepare Child element
prepare Child elements
The snapshot capture Child element
capture Child elements
The capture addFile Child element
addFile Element attributes
addFile ownership attribute
The capture addSnapshot Child element
addSnapshot Element attributes
addSnapshot Child elements
The capture addResource Child element
The snapshot cleanup Child element
The snapshot cleanup Child elements
The controlList Element
controlList Child elements
controlList Inheritance and Overriding
The control Element
control Element attributes
control access Attribute
control modifier Attribute
control Child elements
control Inheritance and Overriding
The diff Element
diff Child elements
diff Inheritance and Overriding
The ignore Element
ignore Element attributes
Installed Component Targeters
The systemService Installed Component Targeter
installedComponent Targeter attributes
systemService Targeter attributes
The systemType Installed Component Targeter
The installedComponent Installed Component Targeter
systemType Targeter attributes
The thisComponent Installed Component Targeter
The superComponent Installed Component Targeter
The nestedRef Installed Component Targeter
nestedRef Targeter Attributes
The allNestedRefs Installed Component Targeter
The toplevelRef Installed Component Targeter
toplevelRef Targeter Attributes
The dependee Installed Component Targeter
dependee Targeter Attributes
The allDependants Installed Component Targeter
allDependants Targeter Attributes
Repository Component Targeters
The component Repository Component Targeter
component Targeter Attributes
The thisComponent Repository Component Targeter
The superComponent Repository Component Targeter
The nestedRef Repository Component Targeter
nestedRef Targeter Attributes
The allNestedRefs Repository Component Targeter
The toplevelRef Repository Component Targeter
toplevelRef Targeter Attributes
Component Install-only Steps
createDependency Step
createDependency Step attributes
createDependency Step Child elements
createDependency Step Uninstall Implications
createDependency Step Reinstall Implications
createDependency Step Naming Conventions
createSnapshot Step
createSnapshot Step attributes
install Step
Simple Component Install-only Steps
deployResource Step
Component Uninstall-only Steps
uninstall Step
Simple Component Uninstall-only Steps
undeployResource Step
Chapter 3 The N1 Service Provisioning System Software Plan Schema
The executionPlan Element
executionPlan Element attributes
executionPlan child elements
The Plan paramList Element
Plan paramList Element child elements
The Plan param Child Element
Plan param Child Element attributes
The Plan varList Element
Plan varList Element
The Plan var Child Element
Plan var Child Element attributes
The simpleSteps Element
simpleSteps Element attributes
The simpleSteps limitToHostSet Attribute
Child Elements of the simpleSteps Elements
The compositeSteps Element
Child Elements of the compositeSteps Element
Child Elements of the compositeSteps Element
Shared Steps
call Step
call Step attributes
call Step child elements
The argList Child Element
argList Child Element attributes
CheckDependency Step
checkDependency Step child elements
execJava Step
execJava Step attributes
execJava Child elements
execNative Step
execNative Step attributes
execNative Element child elements
The env Child Element
env Element attributes
background element
outputFile element
outputFile Attributes
errorFile element
errorFile Attributes
The inputText Child Element
inputFile Child Element
inputFile Element attributes
The exec Child Element
exec Element attributes
exec Element child elements
arg Child Element attributes
The shell Child Element
Attributes of the shell Element
The successCriteria Element
successCriteria Element attributes
if Step
if Step Child Elements
if Step Example
condition Element
then Element
else Element
pause Step
pause Step attributes
processTest Step
processTest Step attributes
raise Step
raise Step attributes
raise Step Example
reboot Step
reboot Step attributes
retarget Step
retarget Step attributes
retarget Step Child Elements
retarget Step host Attribute
retarget Step Execution Semantics
retarget Step Example
The sendCustomEvent Step
sendCustomEvent Step attributes
transform Step
transform Step attributes
transform Element child elements
The stylesheet transform Child Element
Example of the stylesheet Element
The subst transform Child Element
subst Element attributes
An Example of the subst Element
The source transform Child Element
source Element attributes
The type Attribute of the source Element
try Step
try Step Child Elements
try Step Examples
block Element
catch Element
finally Element
urlTest Step
Attributes of the urlTest Step
Composite Plan-only Steps
execSubplan Step
execSubplan Step attributes
execSubplan Step child elements
inlineSubplan Step
inlineSubplan Step attributes
inlineSubplan Element child elements
Simple Plan-only Steps
install Step
install Step attributes
install Step child elements
uninstall Step
uninstall Step attributes
uninstall Step child elements
Chapter 4 The N1 Service Provisioning System Software Command-Line Interface
The Structure of CLI Commands
Invoking CLI Commands
Working with the CLI
Authentication by Username and Password or Session ID
Listing the Commands
Getting Help with the CLI
CLI Syntax
Selecting the Output Format of a CLI Command
Standard Output Formats
Command-Specific Output Formats
Specifying the Output Format
Passing Output Data to a File
Passing Data to an Individual CLI Argument
Converting the Output Format
Passing Arguments to the CLI from a File
Descriptions and Multi-word Names
ID Substitution Using NM:
Showing and Hiding Objects
Working with CLI Commands
Required Arguments and Optional Arguments
The cr_cli Tool
The cr_clij Tool
Jython Scripts
CLI Input Types
Chapter 5 cat: Commands for Managing Categories
Overview of the cat Commands
cat.add
cat.del
cat.mod
cat.la
Chapter 6 cdb: CLI Commands for Managing Components
Overview of the cdb Commands
cdb.c: Managing Components
cdb.c.ci
cdb.c.co
cdb.c.la
cdb.c.lo
cdb.c.lv
cdb.c.mod
cdb.c.sc
cdb.c.sc
cdb.c.del
cdb.ic: Managing Installed Components
cdb.ic.lbc
cdb.ic.lbh
cdb.ic.vs.lo
cdb.vs: Managing Variable Settings
cdb.vs.add
cdb.vs.del
cdb.vs.imp
cdb.vs.la
cdb.vs.lo
cdb.vs.mod
cdb.ssr: System Service Ref Commands
cdb.ssr.add
cdb.ssr.mod
cdb.ssr.del
cdb.ssr.lo
cdb.ssr.la
cdb.ctr: Component Type Commands
cdb.ctr.add
cdb.ctr.mod
cdb.ctr.del
cdb.ctr.lo
cdb.ctr.la
Chapter 7 cfg: CLI Commands for Performing Config-Generation
Overview of the cfg Command
cfg.gen
Chapter 8 cmp: CLI Commands for Running Comparisons
Overview of the cmp Commands
cmp.dj.add
cmp.dj.del
cmp.dj.la
cmp.dj.lo
cmp.ds.add
cmp.ds.la
cmp.ds.lo
cmp.ds.del
cmp.ds.mod
cmp.ds.sc
Chapter 9 hdb: CLI Commands for Managing Hosts
Introduction
hdb.a: Managing Application Instances
hdb.a.add
hdb.a.del
hdb.a.la
hdb.a.lo
hdb.a.mod
hdb.a.clear
hdb.h: Managing Hosts
hdb.h.add
hdb.h.del
hdb.h.la
hdb.h.lo
hdb.h.lq
hdb.h.mod
hdb.hr: Managing Host Searches
Overview
hdb.hr.add
hdb.hr.del
hdb.hr.la
hdb.hr.le
hdb.hr.lo
hdb.hr.mod
hdb.hs: Managing Host Sets
hdb.hs.add
hdb.hs.del
hdb.hs.la
hdb.hs.le
hdb.hs.lo
hdb.hs.mod
hdb.ht: Managing Host Types
Overview
hdb.ht.add
hdb.ht.del
hdb.ht.la
hdb.ht.lo
hdb.ht.mod
Chapter 10 net: CLI Commands for Performing Network Operations
Overview of the net Commands
net.gencfg
net.traceroute
Chapter 11 pdb: CLI Commands for Managing Plans
Overview of the pdb Commands
pdb.p.ci
pdb.p.co
pdb.p.genplan
pdb.p.la
pdb.p.lo
pdb.p.del
pdb.p.lv
pdb.p.sh
pdb.p.sc
Chapter 12 pe: CLI Commands for Running Plans
Overview of the pe Commands
pe.h.prep
pe.p.en
pe.p.la
pe.p.lo
pe.p.del
pe.p.lp
pe.p.run
pe.p.stop
pe.pi.lo
Chapter 13 CLI Commands for Managing Resources
Overview of the cdb Commands
cdb.rsrc.ci
cdb.rsrc.cib
Overview of Batch Files
Example of a Line in a Batch File
Batch File Syntax
Invocation
The haltonerror Argument
The pwdrelative Argument
Batch File Processing
cdb.cj.la
cdb.cj.lo
cdb.cj.stop
cdb.rsrc.co
cdb.rsrc.rci
Chapter 14 rule: CLI Commands for Notifications
Overview of the rule Commands
rule.add
rule.del
rule.la
rule.lo
rule.mod
Chapter 15 udb: CLI Commands for Managing Users and Groups
Overview of the udb Commands
udb.g: Managing User Groups
udb.g.add
udb.g.del
udb.g.la
udb.g.lo
udb.g.lp
udb.g.lu
udb.g.mod
udb.u: Managing User Accounts
udb.u.add
udb.u.cp
udb.u.la
udb.u.lo
udb.u.lp
udb.u.mod
udb.sv: Managing Session Variables
udb.sv.add
udb.sv.del
udb.sv.la
udb.sv.lo
udb.sv.mod
Authentication Commands
udb.login
udb.logout
udb.whoami
udb.p: Commands for Managing Permissions
udb.p.la
udb.p.lo
Chapter 16 Configuration Generation
Adding Substitution Variable Definitions to Components
Variable Substitution Values
Generation Context
Types of Variables Available for Substitution
Simple Substitution Variables
External Substitution Variables
Explicit External Component Expansion
Nested Component Expansion
Toplevel Component Expansion
Dependee Component Expansion
System Service Component Expansion
System Type Component Expansion
Container Component Expansion
External Component Substitution Reference Resolution
Session Variables Substitution Variables
Target Substitution Variables
Predefined Host Substitution Shorthands
Using Substitution Variables
Escape Sequences Within Files With Substitution Variable Definitions
Predefined Substitution Variables for Components and Configuration Files
© 2010, Oracle Corporation and/or its affiliates