You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/3.0/content/userguide/tools/model_help.md
+87-8Lines changed: 87 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -24,23 +24,28 @@ Attributes and sub-folders for resources:/JDBCSystemResource
24
24
resources:
25
25
JDBCSystemResource:
26
26
'JDBC-1':
27
-
CompatibilityName: # string
28
-
DeploymentOrder: # integer
29
-
DeploymentPrincipalName: # string
30
-
DescriptorFileName: # string
31
-
ModuleType: # string
32
-
Notes: # string
33
-
SourcePath: # string
34
-
Target: # delimited_string
27
+
CompatibilityName: # string +
28
+
DeploymentOrder: # integer (default=100) +
29
+
DeploymentPrincipalName: # string +
30
+
DescriptorFileName: # string +
31
+
ModuleType: # string +
32
+
Notes: # string +
33
+
SourcePath: # string +
34
+
Target: # delimited_string +
35
35
36
36
JdbcResource:
37
37
# see /JDBCSystemResource/JdbcResource
38
38
39
39
SubDeployment:
40
40
'SubDeployment-1':
41
41
# see /JDBCSystemResource/SubDeployment
42
+
43
+
44
+
This bean defines a system-level JDBC resource. It links a separate
45
+
descriptor that specifies the definition.
42
46
```
43
47
This output shows the eight attributes and two sub-folders available for the `JDBCSystemResource` folder in the `resources` section of the model. Each attribute includes a comment describing the type of the value to be added.
48
+
A plus sign (`+`) on an attribute indicates that appending the attribute to the model path will yield more information about the attribute.
44
49
45
50
Folders that support multiple instances, such as `JDBCSystemResource` in this example, are shown with a derived name, such as `'JDBC-1'`.
46
51
@@ -88,6 +93,43 @@ If the section is not provided for a folder, then it will be derived and include
88
93
/JDBCSystemResource/JdbcResource
89
94
```
90
95
96
+
#### Per attribute help
97
+
To show help for a particular attribute in a folder, simply add it to the model path.
Attributes and sub-folders for topology:/Server/Log/StdoutSeverity
106
+
107
+
topology:
108
+
Server:
109
+
'Server-1':
110
+
Log:
111
+
StdoutSeverity: # string
112
+
113
+
Default=Notice
114
+
Legal values:
115
+
'Trace'
116
+
'Debug'
117
+
'Info'
118
+
'Warning'
119
+
'Error'
120
+
'Notice'
121
+
'Critical'
122
+
'Alert'
123
+
'Emergency'
124
+
'Off'
125
+
126
+
127
+
The minimum severity of log messages going to the standard out.
128
+
Messages with a lower severity than the specified value will
129
+
not be published to standard out.
130
+
```
131
+
132
+
91
133
#### Output options
92
134
There are several command-line options that you can use to control the output text for the model path. Use only one of these options at a time. If no output options are specified, then the attributes and immediate sub-folders for the specified path are listed.
93
135
@@ -127,6 +169,42 @@ resources:
127
169
'SubDeployment-1':
128
170
```
129
171
172
+
#### Interactive option
173
+
To access an interactive command line for exploring model paths using a directory style syntax, use `modelHelp.sh -interactive <starting_model_path>`.
174
+
175
+
For example:
176
+
```yaml
177
+
$ modelHelp.sh -interactive top
178
+
```
179
+
The output is:
180
+
```yaml
181
+
In interactive mode! Type 'help' for help.
182
+
[top] --> help
183
+
184
+
Commands:
185
+
186
+
ls - list contents of current location
187
+
top, cd, cd /, cd top - go to "top"
188
+
cd x[/[...]] - relative change (go to child location x...)
189
+
cd section[:/[...]] - absolute change (go to exact section and location)
190
+
cd /folder[/...] - find section that contains the folder and go there
0 commit comments