1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 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 120 121 122 123 124 125 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
|
<html>
<body>
<h2><a href="cvm.html">CVM</a></h2>
<h1>CVM Fact Definitions</h1>
<h2>Types</h2>
<p>Facts may have one of two types:<ul>
<li><tt>string</tt>: An arbitrary length series of ASCII characters not
containing <tt>NUL</tt>.
<li><tt>integer</tt>: A series of ASCII digits interpreted as an
unsigned decimal value.</tt>
</ul></p>
<h2>Numbers</h2>
<p>All predefined facts numbers will have values less than 128. All
other fact numbers (from 128 to 255) are reserved for local or
experimental use. Facts marked as "required" must be present at least
once in the result. Facts marked as "multiple" may be present more
than once; all other facts are optional and must be present at most
once. Facts may be reported in any order, and that order carries no
significance.</p>
<p><table border=1>
<tr>
<th>#</th>
<th>Name</th>
<th>Type</th>
<th>Required/<br>Optional/<br>Multiple</th>
<th>Description</th>
</tr>
<tr>
<td><tt>1</tt></td>
<td><tt>CVM_FACT_USERNAME</tt></td>
<td>string</td>
<td>Required</td>
<td>The login user name.</td>
</tr>
<tr>
<td><tt>2</tt></td>
<td><tt>CVM_FACT_USERID</tt></td>
<td><tt>integer</tt></td>
<td>Required</td>
<td>The user numerical ID.</td>
</tr>
<tr>
<td><tt>3</tt></td>
<td><tt>CVM_FACT_GROUPID</tt></td>
<td><tt>integer</tt></td>
<td>Required</td>
<td>The group numerical ID.</td>
</tr>
<tr>
<td><tt>4</tt></td>
<td><tt>CVM_FACT_REALNAME</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The user's real name.</td>
</tr>
<tr>
<td><tt>5</tt></td>
<td><tt>CVM_FACT_DIRECTORY</tt></td>
<td><tt>string</tt></td>
<td>Required</td>
<td>The "home" directory.</td>
</tr>
<tr>
<td><tt>6</tt></td>
<td><tt>CVM_FACT_SHELL</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The login shell.</td>
</tr>
<tr>
<td><tt>7</tt></td>
<td><tt>CVM_FACT_GROUPNAME</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The login group name, as reported by the system tables.</td>
</tr>
<tr>
<td><tt>8</tt></td>
<td><tt>CVM_FACT_SUPP_GROUPID</tt></td>
<td><tt>integer</tt></td>
<td>Optional<br>Multiple</td>
<td>Supplemental group ID list, must contain the primary group ID.</td>
</tr>
<tr>
<td><tt>9</tt></td>
<td><tt>CVM_FACT_SYS_USERNAME</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The system user name. For virtual login systems, this may differ
from fact #1. Where present, this should be the user name associated
with the user ID as reported by the system tables (ie
<tt>getpwuid</tt>).</td>
</tr>
<tr>
<td><tt>10</tt></td>
<td><tt>CVM_FACT_SYS_DIRECTORY</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The base "home" directory. For virtual login systems, this may
differ from fact #5. Where present, this should be the directory
associated with the user ID as reported by the system tables (ie
<tt>getpwuid</tt>).</td>
</tr>
<tr>
<td><tt>11</tt></td>
<td><tt>CVM_FACT_OFFICE_LOCATION</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The office location from the GECOS field.</td>
</tr>
<tr>
<td><tt>12</tt></td>
<td><tt>CVM_FACT_WORK_PHONE</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The work phone number from the GECOS field.</td>
</tr>
<tr>
<td><tt>13</tt></td>
<td><tt>CVM_FACT_HOME_PHONE</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The home phone number from the GECOS field.</td>
</tr>
<tr>
<td><tt>14</tt></td>
<td><tt>CVM_FACT_DOMAIN</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The domain name associated with the validated credentials.</td>
</tr>
<tr>
<td><tt>15</tt></td>
<td><tt>CVM_FACT_MAILBOX</tt></td>
<td><tt>string</tt></td>
<td>Optional</td>
<td>The path to the mailbox file or directory. If this path is not
prefixed with a slash ('/'), it must be interpreted as relative to the
home directory.</td>
</tr>
</table></p>
</body>
</html>
|