Module: D3::Admin::Help

Extended by:
Help
Included in:
Help
Defined in:
lib/d3/admin/help.rb

Overview

This just exists to get the very lengthy help texts out of the d3admin and d3 executables.

Constant Summary collapse

USAGE = 
"Usage: d3admin action target [options]"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended_help_text ⇒ String

Return the d3amin help text

Returns:

  • (String) —

    the d3admin help text



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/d3/admin/help.rb', line 126

def extended_help_text
  helptxt = "\nd3admin is a tool for administering packages in d3, a package/patch\nmanagement & deployment tool that enhances the package-handling capabilities\nof Jamf Pro.\n\nFor detailed documentation see:\nhttps://github.com/PixarAnimationStudios/depot3/wiki/Admin\n\nImportant Terms:\n\n- basename:   A word used to identify all packages that install any version of\n        the same thing. E.g. 'filemaker' or 'transmogrifier' When a\n        basename is used to specify a package, it refers to the currently\n        live package for the basename. (see below)\n\n- edition:    A unique identifier for a package or receipt in d3. It is made of\n        the basename, version, and revision, joined by dashes.\n        E.g. 'transmogrifier-2.2.1-2'\n        Editions specify individual packages regardless of their status.\n\n- live:       Each edition has a status: pilot, live, skipped, deprecated, or\n        missing. Only one edition per basename can be 'live' a a time.\n        When an edition is made live, it's approved for general deployment\n        and is the edition installed with 'd3 install <basename>'. It will\n        also auto-install on computers in the packages auto-groups, and it\n        will auto-update on any computers with older editions of the same\n        basename already installed.\n\n- walkthru:   Any action can take the --walkthru option and you'll be prompted\n        for targets (if needed) and options.\n        Without --walkthru, you must provide all values with command-line\n        options. Anything not on the command-line will use a default or\n        inherited value, or cause an error if the option was required.\n\n\#{USAGE}\n\nWhen refering to a package on the server, a basename imples the currently live\nedition for that basename. Refering to a package by edition specifies an\nindividual package regardless of status.\n\n\n=== Actions and their required targets & options ===\n\n  add      Add a new pilot package to d3\n       Target = basename unless -w\n       Without -w, requires -v, -r, & -s\n\n  edit     Change properties of existing package in d3\n       Target = basename or edition unless -w\n\n  live     Make existing pilot package live\n       Target = edition unless -w\n\n  delete   Delete an existing package from d3\n       Target = basename or edition unless -w\n\n  info     Show details of an package in d3\n       Target = basename or edition unless -w\n\n  search   Search for and list packages in d3.\n        Target = search text (RegExp matching)\n        No target = list all packages unless -w\n\n  report   Report about d3 receipts or puppies on computers.\n       Target = basename, or computer name unless -w\n\n  config   Set up server info and default values for d3admin.\n       Target = all, jss, db, dist, workspace,\n       pkg-id-prefix or display. Defaults to all\n\n       Using 'display' prints out the current admin config settings.\n\n       Runs 'all' automatically on first run.\n\n  help     Show this help. Use -H for extended help.\n\n\nNOTE: Any action that requires stored passwords will prompt for your\nkeychain password if your login keychain is currently locked.\n\n=== Options ===\n\nNon-required options for add will use inherited or default values if unspecified.\n\nGeneral:\n\n  -w, --walkthru                     Interactively prompt for all options.\n                                 Options provided on the commandline are\n                                 ignored. Without -w, anything NOT provided\n                                 on the command-line will use a default or\n                                 inherited value or will raise an error.\n\n  -a, --auto-confirm                 Don't ask for confirmation before making\n                                 changes. For use in automation.\n                                 BE VERY CAREFUL\n\n  -H, --help                         Show this help text\n\n  -D, --debug                        Show LOTS of debugging info about whats\n                                 happening. If there's a Ruby error,\n                                 show the backtrace. Useful when reporting\n                                 problems.\n\nAction add:\n\n  -i, --import <name or id>          When the action is 'add', import an existing\n                                 JSS package into d3 by display-name or id.\n                                 Requires -w or  -v & -r\n\n  -W, --workspace <path>             Folder in which to build .dmgs & .pkgs\n                                 default is your home folder.\n                                 Preserved between uses of d3admin.\n\n  -I, --no-inherit                   Don't inherit default values from most\n                                 recent package with the same basename.\n\n  -s, --source-path <path>             Path to a .pkg, .dmg, or root-folder\n                                 from which to build one\n\n  --dmg                          When building from a root folder, build\n                                 a .dmg, rather than the default .pkg\n\n  --preserve-owners                  When building .pkgs, keep the ownership of\n                                 the pkg-root folder. Default is to let\n                                 the OS set ownership to standards based\n                                 upon where items are installed.\n\n  -p, --pkg-id <pkgid>               When building .pkgs, the apple package\n                                 identifier, e.g. 'com.mycompany.app'\n                                 Defaults to a prefix, plus the basename.\n                                 The prefix is either the the apple_pkg_id_prefix\n                                 setting from the d3admin config, or\n                                 '\#{D3::Admin::DFT_PKG_ID_PREFIX}'\n\nAction add and edit:\n\n  -v, --version <version>            Version of the thing installed by the\n                                 package, e.g. \"2.5\", \"1.1a3\".\n                                 May not contain a '-', which will be\n                                 converted to '_'\n\n  -r, --revision <revision>          Package-revision.\n                                 This integer represents how many times\n                                 a particular version of a basename has\n                                 been added to d3.\n\n  -n, --package-name <name>          The JSS 'display name' of the package.\n                                 Must be unique in the JSS\n                                 Defaults to <edition>.<pkg_type>\n                                 e.g. myapp-2.3a1-2.pkg\n\n  -f, --filename                     The name of the installer file on the\n                                 master distribution point. When uploading,\n                                 the file will be renamed to this.\n                                 If the installer is a .pkg bundle, it\n                                 will be zipped, and '.zip' appended\n                                 automatically when uploaded.\n                                 Defaults to <edition>.<pkg_type>\n                                 e.g. myapp-2.3a1-2.pkg\n\n  -d, --description <desc>           A textual description of this package,\n                                 and any notes or comments about it.\n\n  -e, --pre-install <script>         The name or id of an existing JSS script,\n                                 or the path to a file with a new script.\n                                 This script is run before installing.\n                                 Use \"n\" for 'none'.\n                                 See the full documentation for details.\n\n  -t, --post-install <script>        As for pre-install, but the script to run\n                                 after installing the package.\n\n  -E, --pre-remove <script>          As for pre-install, but the script to run\n                                 before uninstalling the package.\n\n  -T, --post-remove <script>         As for pre-install, but the script to run\n                                 after uninstalling the package.\n\n  -g, --auto-groups <groups>        Comma-separated list of JSS computer groups\n                                 whose members get this pkg automatically.\n                                 Use '\#{D3::STANDARD_AUTO_GROUP}'\n                                 to install on all machines.\n                                 Use \"n\" for 'none'.\n\n  -G, --excluded-groups <groups>      Comma-separated list of JSS computer groups\n                                 whose members can't install this pkg\n                                 without using force.\n                                 Use \"n\" for 'none'.\n\n  -x, --prohibiting-processes <proc>   Specify name(s) to match with process names\n                                 as output by `/bin/ps -A -c -o comm`.\n                                 If a match is found at install time,\n                                 graceful quit will be attempted. Use \"n\" for 'none'\n\n  -R, --reboot <y/n>                 Reboot is required after install.\n                                 (PuppyTime!)\n                                 Default is 'n'\n\n  -u, --removable <y/n>              Can this package be uninstalled?\n                                 Default is 'y'\n\n  -F, --remove-first  <y/n>          Uninstall older versions before installing\n                                 this one, if they are removable.\n                                 Default is 'n'  (installs over the top)\n\n  -o, --oses <oses>                  Comma-separated list of OS version to allow\n                                 installation of this package.\n                                   e.g. 10.5.8, 10.6.x\n                                 Use '>=' to set a min. OS version\n                                   e.g. >=10.6.0\n                                 Use \"n\" for no limitation\n\n  -c, --cpu <type>                   Limit to cpu type: 'ppc' or 'intel'\n                                 Use \"n\" for no limitation.\n\n  -C, --category <category>          The JSS Category for this package\n                                 Use \"n\" for none\n\n  -X, --expiration <days>            How many days of no use before this package\n                                 uninstalls itself. Pkg must be removable,\n                                 and expiration must be allowed in the\n                                 client config.\n\n  -P, --expiration-path(s) <path>    The path(s) to the executable(s) the must\n                                 be used within the expiration period to\n                                 avoid being uninstalled\n\nAction delete:\n\n  --keep-scripts                     Keep any scripts associated with this pkg\n                                 in Jamf Pro. Note: scripts used by other\n                                 packages or polices are never deleted.\n\n  --keep-in-jss                      Leave the package in Jamf Pro after deleting\n                                 it from d3. Note: packages used by\n                                 policies are never deleted from Jamf Pro.\n\n\nAction search:\n\n  -S, --status <status>              Limit the packages listed to those with\n                                 the given status. Can be used multiple\n                                 times to see multiple statuses.\n\n  --groups                           Instead of basenames, search computer\n                                 group names and report packages scoped\n                                 by those groups for auto-install or\n                                 exclusion.\n\nAction report:\n\n  -S, --status <status>              Limit the receipts listed to those with\n                                 the given status. Can be used multiple\n                                 times to see multiple statuses.\n\n  -z, --frozen                       Limit the receipts listed to frozen ones.\n\n  -q, --queue                        Report pending puppy installs rather than\n                                 receipts.\n\n  --computers                        The target of the report is a computer name\n                                 and the report is about receipts or\n                                 pending puppy installs on that computer.\n\n\n"
end

.help_text ⇒ String

Return the d3amin help text

Returns:

  • (String) —

    the d3admin help text



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/d3/admin/help.rb', line 40

def help_text
  helptxt = "\n\#{USAGE}\n\n=== Actions <target> ===\n\n  add <basename>                     Add a new pilot package\n  edit <basename/edition>            Change properties of existing package\n  live <edition>                     Make existing pilot package live\n  delete <basename/edition>          Delete a package\n  info <basename/edition>            Show details of an package\n  search <basename/group>            List matching pkgs on the server\n  report <basename/computer>         Report about receipts on computers\n  config <setting/display>           d3admin configutation on this machine\n  help                               Show this help.\n\n=== Options ===\n\nGeneral:\n  -w, --walkthru                     Interactively prompt for all options.\n  -a, --auto-confirm                 Don't ask for confirmation before acting\n  -h, --help                         Show this help text\n  -H, --extended-help                Show extended help\n  -D, --debug                        Show debug info and ruby backtraces\n\nAction add:\n  -i, --import <name or id>          Import an existing JSS package\n  -W, --workspace <path>             Folder in which to build .dmgs & .pkgs\n  -I, --no-inherit                   Don't inherit values from last package\n  -s, --source-path <path>           Path to a .pkg, .dmg, or root-folder\n  --dmg                              Build a .dmg, rather than a .pkg\n  --preserve-owners                  Keep the ownership of contents in built .pkgs\n  -p, --pkg-id <pkgid>               Apple pkg-identifier for built .pkgs\n\nAction add and edit:\n  -v, --version <version>            Version of the thing installed\n  -r, --revision <revision>          Sequential packaging of the same version\n  -n, --package-name <name>          The JSS 'display name' of the package\n  -f, --filename <name>              The filename on the distribution point\n  -d, --description <desc>           A textual description of this package\n  -e, --pre-install <script>         Name, id, or path to pre-install script\n  -t, --post-install <script>        Name, id, or path to post-install script\n  -E, --pre-remove <script>          Name, id, or path to pre-remove script\n  -T, --post-remove <script>         Name, id, or path to post-remove script\n  -g, --auto-groups <groups>         Computer groups to get this pkg automatically\n  -G, --excluded-groups <groups>     Computer groups that can't see this pkg\n  -x, --prohibiting-processes <proc> Process name(s) that prevent installation\n  -R, --reboot <y/n>                 Reboot required after install, puppies!\n  -F, --remove-first <y/n>           Uninstall older versions before installing\n  -u, --removable <y/n>              Can this package be uninstalled?\n  -o, --oses <oses>                  OS limitations for installation.\n  -c, --cpu <type>                   Limit installation to 'intel' or 'ppc'\n  -C, --category <category>          The JSS Category for this package\n  -X, --expiration <days>            Auto-uninstall if unused for <days>\n  -P, --expiration-path(s) <path>    Path(s) to executable(s) that must be used\n                               (Multiple paths should be comma separated)\n\nAction delete:\n  --keep-scripts                     Keep pre-/post- scripts in Jamf Pro\n  --keep-in-jss                      Delete pkg from d3 but leave in Jamf Pro\n\nAction search or report:\n  -S, --status <status>              Limit package list to this status\n  --groups                           Target is a group name. Shows packages\n                                 auto-installed or excluded for group\n\nAction report:\n  -S, --status <status>              Limit receipt list to this status\n  -z, --frozen                       Limit receipt list to frozen receipts\n  -q, --queue                        List puppy queue items rather than rcpts\n  --computers                        Target is a computer name. Reports\n                                  rcpts/puppies on that computer.\n\nFor details use -H or --extended-help\n\nSee also: https://github.com/PixarAnimationStudios/depot3/wiki/Admin\n\n"
end

Instance Method Details

#extended_help_text ⇒ String

Return the d3amin help text

Returns:

  • (String) —

    the d3admin help text



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/d3/admin/help.rb', line 126

def extended_help_text
  helptxt = "\nd3admin is a tool for administering packages in d3, a package/patch\nmanagement & deployment tool that enhances the package-handling capabilities\nof Jamf Pro.\n\nFor detailed documentation see:\nhttps://github.com/PixarAnimationStudios/depot3/wiki/Admin\n\nImportant Terms:\n\n- basename:   A word used to identify all packages that install any version of\n        the same thing. E.g. 'filemaker' or 'transmogrifier' When a\n        basename is used to specify a package, it refers to the currently\n        live package for the basename. (see below)\n\n- edition:    A unique identifier for a package or receipt in d3. It is made of\n        the basename, version, and revision, joined by dashes.\n        E.g. 'transmogrifier-2.2.1-2'\n        Editions specify individual packages regardless of their status.\n\n- live:       Each edition has a status: pilot, live, skipped, deprecated, or\n        missing. Only one edition per basename can be 'live' a a time.\n        When an edition is made live, it's approved for general deployment\n        and is the edition installed with 'd3 install <basename>'. It will\n        also auto-install on computers in the packages auto-groups, and it\n        will auto-update on any computers with older editions of the same\n        basename already installed.\n\n- walkthru:   Any action can take the --walkthru option and you'll be prompted\n        for targets (if needed) and options.\n        Without --walkthru, you must provide all values with command-line\n        options. Anything not on the command-line will use a default or\n        inherited value, or cause an error if the option was required.\n\n\#{USAGE}\n\nWhen refering to a package on the server, a basename imples the currently live\nedition for that basename. Refering to a package by edition specifies an\nindividual package regardless of status.\n\n\n=== Actions and their required targets & options ===\n\n  add      Add a new pilot package to d3\n       Target = basename unless -w\n       Without -w, requires -v, -r, & -s\n\n  edit     Change properties of existing package in d3\n       Target = basename or edition unless -w\n\n  live     Make existing pilot package live\n       Target = edition unless -w\n\n  delete   Delete an existing package from d3\n       Target = basename or edition unless -w\n\n  info     Show details of an package in d3\n       Target = basename or edition unless -w\n\n  search   Search for and list packages in d3.\n        Target = search text (RegExp matching)\n        No target = list all packages unless -w\n\n  report   Report about d3 receipts or puppies on computers.\n       Target = basename, or computer name unless -w\n\n  config   Set up server info and default values for d3admin.\n       Target = all, jss, db, dist, workspace,\n       pkg-id-prefix or display. Defaults to all\n\n       Using 'display' prints out the current admin config settings.\n\n       Runs 'all' automatically on first run.\n\n  help     Show this help. Use -H for extended help.\n\n\nNOTE: Any action that requires stored passwords will prompt for your\nkeychain password if your login keychain is currently locked.\n\n=== Options ===\n\nNon-required options for add will use inherited or default values if unspecified.\n\nGeneral:\n\n  -w, --walkthru                     Interactively prompt for all options.\n                                 Options provided on the commandline are\n                                 ignored. Without -w, anything NOT provided\n                                 on the command-line will use a default or\n                                 inherited value or will raise an error.\n\n  -a, --auto-confirm                 Don't ask for confirmation before making\n                                 changes. For use in automation.\n                                 BE VERY CAREFUL\n\n  -H, --help                         Show this help text\n\n  -D, --debug                        Show LOTS of debugging info about whats\n                                 happening. If there's a Ruby error,\n                                 show the backtrace. Useful when reporting\n                                 problems.\n\nAction add:\n\n  -i, --import <name or id>          When the action is 'add', import an existing\n                                 JSS package into d3 by display-name or id.\n                                 Requires -w or  -v & -r\n\n  -W, --workspace <path>             Folder in which to build .dmgs & .pkgs\n                                 default is your home folder.\n                                 Preserved between uses of d3admin.\n\n  -I, --no-inherit                   Don't inherit default values from most\n                                 recent package with the same basename.\n\n  -s, --source-path <path>             Path to a .pkg, .dmg, or root-folder\n                                 from which to build one\n\n  --dmg                          When building from a root folder, build\n                                 a .dmg, rather than the default .pkg\n\n  --preserve-owners                  When building .pkgs, keep the ownership of\n                                 the pkg-root folder. Default is to let\n                                 the OS set ownership to standards based\n                                 upon where items are installed.\n\n  -p, --pkg-id <pkgid>               When building .pkgs, the apple package\n                                 identifier, e.g. 'com.mycompany.app'\n                                 Defaults to a prefix, plus the basename.\n                                 The prefix is either the the apple_pkg_id_prefix\n                                 setting from the d3admin config, or\n                                 '\#{D3::Admin::DFT_PKG_ID_PREFIX}'\n\nAction add and edit:\n\n  -v, --version <version>            Version of the thing installed by the\n                                 package, e.g. \"2.5\", \"1.1a3\".\n                                 May not contain a '-', which will be\n                                 converted to '_'\n\n  -r, --revision <revision>          Package-revision.\n                                 This integer represents how many times\n                                 a particular version of a basename has\n                                 been added to d3.\n\n  -n, --package-name <name>          The JSS 'display name' of the package.\n                                 Must be unique in the JSS\n                                 Defaults to <edition>.<pkg_type>\n                                 e.g. myapp-2.3a1-2.pkg\n\n  -f, --filename                     The name of the installer file on the\n                                 master distribution point. When uploading,\n                                 the file will be renamed to this.\n                                 If the installer is a .pkg bundle, it\n                                 will be zipped, and '.zip' appended\n                                 automatically when uploaded.\n                                 Defaults to <edition>.<pkg_type>\n                                 e.g. myapp-2.3a1-2.pkg\n\n  -d, --description <desc>           A textual description of this package,\n                                 and any notes or comments about it.\n\n  -e, --pre-install <script>         The name or id of an existing JSS script,\n                                 or the path to a file with a new script.\n                                 This script is run before installing.\n                                 Use \"n\" for 'none'.\n                                 See the full documentation for details.\n\n  -t, --post-install <script>        As for pre-install, but the script to run\n                                 after installing the package.\n\n  -E, --pre-remove <script>          As for pre-install, but the script to run\n                                 before uninstalling the package.\n\n  -T, --post-remove <script>         As for pre-install, but the script to run\n                                 after uninstalling the package.\n\n  -g, --auto-groups <groups>        Comma-separated list of JSS computer groups\n                                 whose members get this pkg automatically.\n                                 Use '\#{D3::STANDARD_AUTO_GROUP}'\n                                 to install on all machines.\n                                 Use \"n\" for 'none'.\n\n  -G, --excluded-groups <groups>      Comma-separated list of JSS computer groups\n                                 whose members can't install this pkg\n                                 without using force.\n                                 Use \"n\" for 'none'.\n\n  -x, --prohibiting-processes <proc>   Specify name(s) to match with process names\n                                 as output by `/bin/ps -A -c -o comm`.\n                                 If a match is found at install time,\n                                 graceful quit will be attempted. Use \"n\" for 'none'\n\n  -R, --reboot <y/n>                 Reboot is required after install.\n                                 (PuppyTime!)\n                                 Default is 'n'\n\n  -u, --removable <y/n>              Can this package be uninstalled?\n                                 Default is 'y'\n\n  -F, --remove-first  <y/n>          Uninstall older versions before installing\n                                 this one, if they are removable.\n                                 Default is 'n'  (installs over the top)\n\n  -o, --oses <oses>                  Comma-separated list of OS version to allow\n                                 installation of this package.\n                                   e.g. 10.5.8, 10.6.x\n                                 Use '>=' to set a min. OS version\n                                   e.g. >=10.6.0\n                                 Use \"n\" for no limitation\n\n  -c, --cpu <type>                   Limit to cpu type: 'ppc' or 'intel'\n                                 Use \"n\" for no limitation.\n\n  -C, --category <category>          The JSS Category for this package\n                                 Use \"n\" for none\n\n  -X, --expiration <days>            How many days of no use before this package\n                                 uninstalls itself. Pkg must be removable,\n                                 and expiration must be allowed in the\n                                 client config.\n\n  -P, --expiration-path(s) <path>    The path(s) to the executable(s) the must\n                                 be used within the expiration period to\n                                 avoid being uninstalled\n\nAction delete:\n\n  --keep-scripts                     Keep any scripts associated with this pkg\n                                 in Jamf Pro. Note: scripts used by other\n                                 packages or polices are never deleted.\n\n  --keep-in-jss                      Leave the package in Jamf Pro after deleting\n                                 it from d3. Note: packages used by\n                                 policies are never deleted from Jamf Pro.\n\n\nAction search:\n\n  -S, --status <status>              Limit the packages listed to those with\n                                 the given status. Can be used multiple\n                                 times to see multiple statuses.\n\n  --groups                           Instead of basenames, search computer\n                                 group names and report packages scoped\n                                 by those groups for auto-install or\n                                 exclusion.\n\nAction report:\n\n  -S, --status <status>              Limit the receipts listed to those with\n                                 the given status. Can be used multiple\n                                 times to see multiple statuses.\n\n  -z, --frozen                       Limit the receipts listed to frozen ones.\n\n  -q, --queue                        Report pending puppy installs rather than\n                                 receipts.\n\n  --computers                        The target of the report is a computer name\n                                 and the report is about receipts or\n                                 pending puppy installs on that computer.\n\n\n"
end

#help_text ⇒ String

Return the d3amin help text

Returns:

  • (String) —

    the d3admin help text



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/d3/admin/help.rb', line 40

def help_text
  helptxt = "\n\#{USAGE}\n\n=== Actions <target> ===\n\n  add <basename>                     Add a new pilot package\n  edit <basename/edition>            Change properties of existing package\n  live <edition>                     Make existing pilot package live\n  delete <basename/edition>          Delete a package\n  info <basename/edition>            Show details of an package\n  search <basename/group>            List matching pkgs on the server\n  report <basename/computer>         Report about receipts on computers\n  config <setting/display>           d3admin configutation on this machine\n  help                               Show this help.\n\n=== Options ===\n\nGeneral:\n  -w, --walkthru                     Interactively prompt for all options.\n  -a, --auto-confirm                 Don't ask for confirmation before acting\n  -h, --help                         Show this help text\n  -H, --extended-help                Show extended help\n  -D, --debug                        Show debug info and ruby backtraces\n\nAction add:\n  -i, --import <name or id>          Import an existing JSS package\n  -W, --workspace <path>             Folder in which to build .dmgs & .pkgs\n  -I, --no-inherit                   Don't inherit values from last package\n  -s, --source-path <path>           Path to a .pkg, .dmg, or root-folder\n  --dmg                              Build a .dmg, rather than a .pkg\n  --preserve-owners                  Keep the ownership of contents in built .pkgs\n  -p, --pkg-id <pkgid>               Apple pkg-identifier for built .pkgs\n\nAction add and edit:\n  -v, --version <version>            Version of the thing installed\n  -r, --revision <revision>          Sequential packaging of the same version\n  -n, --package-name <name>          The JSS 'display name' of the package\n  -f, --filename <name>              The filename on the distribution point\n  -d, --description <desc>           A textual description of this package\n  -e, --pre-install <script>         Name, id, or path to pre-install script\n  -t, --post-install <script>        Name, id, or path to post-install script\n  -E, --pre-remove <script>          Name, id, or path to pre-remove script\n  -T, --post-remove <script>         Name, id, or path to post-remove script\n  -g, --auto-groups <groups>         Computer groups to get this pkg automatically\n  -G, --excluded-groups <groups>     Computer groups that can't see this pkg\n  -x, --prohibiting-processes <proc> Process name(s) that prevent installation\n  -R, --reboot <y/n>                 Reboot required after install, puppies!\n  -F, --remove-first <y/n>           Uninstall older versions before installing\n  -u, --removable <y/n>              Can this package be uninstalled?\n  -o, --oses <oses>                  OS limitations for installation.\n  -c, --cpu <type>                   Limit installation to 'intel' or 'ppc'\n  -C, --category <category>          The JSS Category for this package\n  -X, --expiration <days>            Auto-uninstall if unused for <days>\n  -P, --expiration-path(s) <path>    Path(s) to executable(s) that must be used\n                               (Multiple paths should be comma separated)\n\nAction delete:\n  --keep-scripts                     Keep pre-/post- scripts in Jamf Pro\n  --keep-in-jss                      Delete pkg from d3 but leave in Jamf Pro\n\nAction search or report:\n  -S, --status <status>              Limit package list to this status\n  --groups                           Target is a group name. Shows packages\n                                 auto-installed or excluded for group\n\nAction report:\n  -S, --status <status>              Limit receipt list to this status\n  -z, --frozen                       Limit receipt list to frozen receipts\n  -q, --queue                        List puppy queue items rather than rcpts\n  --computers                        Target is a computer name. Reports\n                                  rcpts/puppies on that computer.\n\nFor details use -H or --extended-help\n\nSee also: https://github.com/PixarAnimationStudios/depot3/wiki/Admin\n\n"
end