usr/src/man/man1m/projmod.1m

   1 '\" te
   2 .\" Copyright (c) 2018 Peter Tribble.
   3 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH PROJMOD 1M "Jan 7, 2018"
   8 .SH NAME
   9 projmod \- modify a project's information on the system
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBprojmod\fR [\fB-n\fR] [\fB-A\fR|\fB-f\fR \fIfilename\fR | -]
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fBprojmod\fR [\fB-n\fR] [\fB-A\fR|\fB-f\fR \fIfilename\fR | -] [\fB-p\fR \fIprojid\fR [\fB-o\fR]]
  19      [\fB-c\fR \fIcomment\fR] [\fB-a\fR|\fB-s\fR|\fB-r\fR] [\fB-U\fR \fIuser\fR[,\fIuser\fR]...]
  20      [\fB-G\fR \fIgroup\fR[,\fIgroup\fR]...]
  21      [\fB-K\fR \fIname\fR[=\fIvalue\fR[,\fIvalue\fR]...]]...
  22      [\fB-l\fR \fInew_projectname\fR] \fIproject\fR
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .LP
  27 The \fBprojmod\fR utility modifies a project's definition on the system.
  28 \fBprojmod\fR changes the definition of the specified project and makes the
  29 appropriate project-related system file and file system changes.
  30 .SH OPTIONS
  31 .LP
  32 The following options are supported:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fB-A\fR\fR
  37 .ad
  38 .RS 29n
  39 Apply the project's resource controls, as defined in the system's project
  40 database, to the project if it is active.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fB-a\fR\fR
  47 .ad
  48 .RS 29n
  49 Specify that the users, groups, attributes, or attribute values specified by
  50 the \fB-U\fR, \fB-G\fR or \fB-K\fR options should be added to the project,
  51 rather than replacing the existing member or attribute list.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fB-c\fR \fIcomment\fR\fR
  58 .ad
  59 .RS 29n
  60 Specify \fIcomment\fR as a text string. Generally, \fIcomment\fR contains a
  61 short description of the project. This information is stored in the project's
  62 \fB/etc/project\fR entry.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB-f\fR \fIfilename\fR | -\fR
  69 .ad
  70 .RS 29n
  71 Specify the project file to modify or validate or specify input from stdin for
  72 validation. As noted under OPERANDS, if you do not specify a project in a
  73 \fBprojmod\fR command line, \fBprojmod\fR validates the argument to \fB-f\fR.
  74 If you do not use this option, the system project file, \fB/etc/project\fR, is
  75 modified.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB-G\fR \fIgroup\fR[,\fIgroup\fR]...]fR
  82 .ad
  83 .RS 29n
  84 Specify a replacement list of member groups of the project. When used in
  85 conjunction with the \fB-a\fR or \fB-r\fR options, this option specifies a list
  86 of groups to be added or removed from the project.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-K\fR \fIname\fR[=\fIvalue\fR[,\fIvalue\fR]...]\fR
  93 .ad
  94 .RS 29n
  95 Specify a replacement list of project attributes for the project. When used in
  96 conjunction with the \fB-a\fR, \fB-r\fR, or \fB-s\fR options, this option
  97 specifies a list of attribute values to be added, removed, or replaced in the
  98 project. Attributes must be delimited by semicolons (\fB;\fR). Multiple
  99 \fB-K\fR options can be specified to set, add, remove, or substitute values on
 100 multiple keys, such as:
 101 .sp
 102 .in +2
 103 .nf
 104 -K \fIkey1\fR=\fIvalue1\fR -K "\fIkey2\fR=(\fIvalue2a\fR),(\fIvalue2b\fR)"
 105 .fi
 106 .in -2
 107
 108 Resource control attributes use parentheses to specify values for a key.
 109 Because many user shells interpret parentheses as special characters, it is
 110 best to enclose an argument to \fB-K\fR that contains parentheses with double
 111 quotes, as shown above and in EXAMPLES, below. See \fBresource_controls\fR(5)
 112 for a description of the resource controls you can specify for a project.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fB-l\fR \fInew_projectname\fR\fR
 119 .ad
 120 .RS 29n
 121 Specify the new project name for the project. The \fInew_projectname\fR
 122 argument is a string consisting of characters from the set of alphabetic
 123 characters, numeric characters, period (\fB\&.\fR), underline (\fB_\fR), and
 124 hyphen (\fB-\fR). The first character should be alphabetic. An error message is
 125 written if these restrictions are not met. The project name must also be unique
 126 within the project file.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB-n\fR\fR
 133 .ad
 134 .RS 29n
 135 Syntax check. Check the format of the existing system project file and
 136 modifications only. The contents of the existing project file, such as user
 137 names, group names, and resources that are specified in the project attributes
 138 are not checked.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fB-o\fR\fR
 145 .ad
 146 .RS 29n
 147 This option allows the project ID specified by the \fB-p\fR option to be
 148 non-unique within the project file.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fB-p\fR \fIprojid\fR\fR
 155 .ad
 156 .RS 29n
 157 Specify a new project \fBID\fR for the project. It must be a non-negative
 158 decimal integer less than \fBMAXUID\fR as defined in \fB<sys/param.h>\fR. This
 159 value must be unique within the project file if the \fB-o\fR option is not
 160 specified.
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fB-r\fR\fR
 167 .ad
 168 .RS 29n
 169 Specify that the users, groups, attributes, or attribute values specified by
 170 the \fB-U\fR, \fB-G\fR or \fB-K\fR options should be removed from the project,
 171 rather than replacing the existing member or attribute list.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB-s\fR\fR
 178 .ad
 179 .RS 29n
 180 Specify that the list of attributes specified by the \fB-K\fR option should
 181 have their values replaced. If the attributes do not exist, they are added as
 182 if the a option was used. This option has no effect the \fB-U\fR or \fB-G\fR
 183 options.
 184 .RE
 185
 186 .sp
 187 .ne 2
 188 .na
 189 \fB\fB-U\fR \fIuser\fR[,\fIuser\fR]...\fR
 190 .ad
 191 .RS 29n
 192 Specify a replacement list of member users of the project. When used in
 193 conjunction with the \fB-a\fR or \fB-r\fR options, this option specifies a list
 194 of users to be added or removed from the project.
 195 .RE
 196
 197 .SH OPERANDS
 198 .LP
 199 The following operands are supported:
 200 .sp
 201 .ne 2
 202 .na
 203 \fB\fIproject\fR\fR
 204 .ad
 205 .RS 11n
 206 An existing project name to be modified or displayed.
 207 .RE
 208
 209 .sp
 210 .ne 2
 211 .na
 212 \fB\fI(none)\fR\fR
 213 .ad
 214 .RS 11n
 215 If no operand is given, the project file is validated without modifying any
 216 project.
 217 .RE
 218
 219 .SH EXAMPLES
 220 .LP
 221 \fBExample 1\fR Using the \fB-K\fR Option for Addition of an Attribute Value
 222 .sp
 223 .LP
 224 Consider the following \fBproject\fR(4) entry:
 225
 226 .sp
 227 .in +2
 228 .nf
 229 salesaudit:111:Auditing Project::sales,finance: \e
 230   process.max-file-size=(priv,52428800,deny); \e
 231   task.max-lwps=(priv,100,deny)
 232 .fi
 233 .in -2
 234
 235 .sp
 236 .LP
 237 The preceding would appear as one line in \fB/etc/project\fR. For this and the
 238 following examples, the focus is on the attributes field in the \fBproject\fR
 239 entry. That is, the last field, the field following the last semicolon.
 240
 241 .sp
 242 .LP
 243 The attributes field for the project \fBsalesaudit\fR lists the following
 244 resource control:
 245
 246 .sp
 247 .in +2
 248 .nf
 249 task.max-lwps=(priv,1000,signal=KILL)
 250 .fi
 251 .in -2
 252
 253 .sp
 254 .LP
 255 The following \fBprojmod\fR command adds an action clause to the preceding
 256 entry:
 257
 258 .sp
 259 .in +2
 260 .nf
 261 # projmod -a -K "task.max-lwps=(priv,100,deny)" salesaudit
 262 .fi
 263 .in -2
 264
 265 .sp
 266 .LP
 267 \&...with the resulting attributes field in the entry for \fBsalesaudit\fR:
 268
 269 .sp
 270 .in +2
 271 .nf
 272 task.max-lwps=(priv,100,deny),(priv,1000,signal=KILL)
 273 .fi
 274 .in -2
 275
 276 .LP
 277 \fBExample 2\fR Using the \fB-K\fR Option for the Substitution of an Attribute
 278 Value
 279 .sp
 280 .LP
 281 Assume an attributes field in a \fBproject\fR(4) entry for the project
 282 \fBsalesaudit\fR that lists the following resource control:
 283
 284 .sp
 285 .in +2
 286 .nf
 287 task.max-lwps=(priv,100,deny),(priv,1000,signal=KILL)
 288 .fi
 289 .in -2
 290
 291 .sp
 292 .LP
 293 The following \fBprojmod\fR command substitutes the action clause specified in
 294 the command for the action clauses in the preceding entry:
 295
 296 .sp
 297 .in +2
 298 .nf
 299 # projmod -s -K "task.max-lwps=(priv,500,signal=SIGSTOP)" salesaudit
 300 .fi
 301 .in -2
 302
 303 .sp
 304 .LP
 305 \&...with the resulting attributes field in the entry for \fBsalesaudit\fR:
 306
 307 .sp
 308 .in +2
 309 .nf
 310 task.max-lwps=(priv,500,signal=SIGSTOP)
 311 .fi
 312 .in -2
 313
 314 .LP
 315 \fBExample 3\fR Using the \fB-K\fR Option for Removal of an Attribute Value
 316 .sp
 317 .LP
 318 Assume an attributes field in a \fBproject\fR(4) entry for a project
 319 \fBsalesaudit\fR that lists the following resource control:
 320
 321 .sp
 322 .in +2
 323 .nf
 324 task.max-lwps=(priv,100,deny),(priv,1000,signal=KILL)
 325 .fi
 326 .in -2
 327
 328 .sp
 329 .LP
 330 The following \fBprojmod\fR command removes the first action clause from the
 331 preceding entry:
 332
 333 .sp
 334 .in +2
 335 .nf
 336 # projmod -r -K "task.max-lwps=(priv,100,deny)" salesaudit
 337 .fi
 338 .in -2
 339
 340 .sp
 341 .LP
 342 \&...with the resulting attributes field in the entry for \fBsalesaudit\fR:
 343
 344 .sp
 345 .in +2
 346 .nf
 347 task.max-lwps=(priv,1000,signal=KILL)
 348 .fi
 349 .in -2
 350
 351 .LP
 352 \fBExample 4\fR Specifying Multiple Attribute Values
 353 .sp
 354 .LP
 355 Suppose you want to achieve the following resource controls for the project
 356 \fBsalesaudit\fR:
 357
 358 .sp
 359 .in +2
 360 .nf
 361 task.max-lwps=(priv,100,deny)
 362 process.max-file-size=(priv,50MB,deny)
 363 .fi
 364 .in -2
 365
 366 .sp
 367 .LP
 368 The following \fBprojmod\fR command adds these resource controls for
 369 \fBsalesaudit\fR:
 370
 371 .sp
 372 .in +2
 373 .nf
 374 # projmod -a -K "task.max-lwps=(priv,100,deny)" \e
 375 -K "process.max-file-size=(priv,50MB,deny)" salesaudit
 376 .fi
 377 .in -2
 378
 379 .sp
 380 .LP
 381 \&...with the resulting attributes field in the entry for \fBsalesaudit\fR:
 382
 383 .sp
 384 .in +2
 385 .nf
 386 task.max-lwps=(priv,100,deny);process.max-file-size=(priv,52428800,deny)
 387 .fi
 388 .in -2
 389
 390 .sp
 391 .LP
 392 In this example, note the effect of the use of the modifier and scaling factor
 393 for the resource control \fBprocess.max-file-size\fR. The specification in
 394 \fBprojmod\fR:
 395
 396 .sp
 397 .in +2
 398 .nf
 399 "process.max-file-size=(priv,50MB,deny)"
 400 .fi
 401 .in -2
 402
 403 .sp
 404 .LP
 405 \&...becomes, in \fB/etc/project\fR:
 406
 407 .sp
 408 .in +2
 409 .nf
 410 process.max-file-size=(priv,52428800,deny)
 411 .fi
 412 .in -2
 413
 414 .sp
 415 .LP
 416 That is, \fB50MB\fR is expanded to \fB52428800\fR. The modifiers, such as MB,
 417 and scaling factors you can use for resource controls are specified in
 418 \fBresource_controls\fR(5).
 419
 420 .LP
 421 \fBExample 5\fR Binding a Pool to a Project
 422 .sp
 423 .LP
 424 The following command sets the \fBproject.pool\fR attribute for the project
 425 \fBsales\fR.
 426
 427 .sp
 428 .in +2
 429 .nf
 430 # projmod -a -K project.pool=salespool sales
 431 .fi
 432 .in -2
 433
 434 .LP
 435 \fBExample 6\fR Evaluating Input from \fBstdin\fR
 436 .sp
 437 .LP
 438 The following command uses the \fB-f\fR option without a project name operand
 439 to evaluate the contents of an NIS projects map.
 440
 441 .sp
 442 .in +2
 443 .nf
 444 # ypcat project | projmod -f -
 445 .fi
 446 .in -2
 447
 448 .SH EXIT STATUS
 449 .LP
 450 In case of an error, \fBprojmod\fR prints an error message and exits with one
 451 of the following values:
 452 .sp
 453 .LP
 454 The following exit values are returned:
 455 .sp
 456 .ne 2
 457 .na
 458 \fB\fB0\fR\fR
 459 .ad
 460 .RS 6n
 461 Successful completion.
 462 .RE
 463
 464 .sp
 465 .ne 2
 466 .na
 467 \fB\fB2\fR\fR
 468 .ad
 469 .RS 6n
 470 The command syntax was invalid. A usage message for \fBprojmod\fR is displayed.
 471 .RE
 472
 473 .sp
 474 .ne 2
 475 .na
 476 \fB\fB3\fR\fR
 477 .ad
 478 .RS 6n
 479 An invalid argument was provided to an option.
 480 .RE
 481
 482 .sp
 483 .ne 2
 484 .na
 485 \fB\fB4\fR\fR
 486 .ad
 487 .RS 6n
 488 The \fIprojid\fR given with the \fB-p\fR option is already in use.
 489 .RE
 490
 491 .sp
 492 .ne 2
 493 .na
 494 \fB\fB5\fR\fR
 495 .ad
 496 .RS 6n
 497 The project files contain an error. See \fBproject\fR(4).
 498 .RE
 499
 500 .sp
 501 .ne 2
 502 .na
 503 \fB\fB6\fR\fR
 504 .ad
 505 .RS 6n
 506 The project to be modified, group, user, or resource does not exist.
 507 .RE
 508
 509 .sp
 510 .ne 2
 511 .na
 512 \fB\fB9\fR\fR
 513 .ad
 514 .RS 6n
 515 The project is already in use.
 516 .RE
 517
 518 .sp
 519 .ne 2
 520 .na
 521 \fB\fB10\fR\fR
 522 .ad
 523 .RS 6n
 524 Cannot update the \fB/etc/project\fR file.
 525 .RE
 526
 527 .SH FILES
 528 .ne 2
 529 .na
 530 \fB\fB/etc/group\fR\fR
 531 .ad
 532 .RS 16n
 533 System file containing group definitions
 534 .RE
 535
 536 .sp
 537 .ne 2
 538 .na
 539 \fB\fB/etc/project\fR\fR
 540 .ad
 541 .RS 16n
 542 System project file
 543 .RE
 544
 545 .sp
 546 .ne 2
 547 .na
 548 \fB\fB/etc/passwd\fR\fR
 549 .ad
 550 .RS 16n
 551 System password file
 552 .RE
 553
 554 .sp
 555 .ne 2
 556 .na
 557 \fB\fB/etc/shadow\fR\fR
 558 .ad
 559 .RS 16n
 560 System file containing users' encrypted passwords and related information
 561 .RE
 562
 563 .SH ATTRIBUTES
 564 .LP
 565 See \fBattributes\fR(5) for descriptions of the following attributes:
 566 .sp
 567
 568 .sp
 569 .TS
 570 box;
 571 c | c
 572 l | l .
 573 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 574 _
 575 Interface Stability     See below.
 576 .TE
 577
 578 .sp
 579 .LP
 580 Invocation is evolving. Human readable output is unstable.
 581 .SH SEE ALSO
 582 .LP
 583 \fBgroupadd\fR(1M), \fBgroupdel\fR(1M), \fBgroupmod\fR(1M), \fBprojadd\fR(1M),
 584 \fBprojdel\fR(1M), \fBuseradd\fR(1M), \fBuserdel\fR(1M), \fBusermod\fR(1M),
 585 \fBpasswd\fR(4), \fBproject\fR(4), \fBattributes\fR(5),
 586 \fBresource_controls\fR(5)
 587 .SH NOTES
 588 .LP
 589 The \fBprojmod\fR utility modifies project definitions only in the local
 590 \fB/etc/project\fR file. If a network name service
 591 is being used to supplement the local files with additional entries,
 592 \fBprojmod\fR cannot change information supplied by the network name service.
 593 However \fBprojmod\fR verifies the uniqueness of project name and project
 594 \fBID\fR against the external name service.