[861] | 1 | # $Id: latmos-accounts.ini.5.pod 3186 2010-09-01 08:10:38Z nanardon $ |
---|
| 2 | |
---|
| 3 | =head1 NAME |
---|
| 4 | |
---|
| 5 | latmos-accounts.ini - Main configuration file for latmos-account. |
---|
| 6 | |
---|
| 7 | =head1 DEFAULT LOCATION |
---|
| 8 | |
---|
| 9 | F</etc/latmos-accounts/latmos-accounts.ini> |
---|
| 10 | |
---|
| 11 | =head1 DESCRIPTION |
---|
| 12 | |
---|
| 13 | This config is an C<ini> like file split into section. Each section describe a |
---|
| 14 | base except sections describe bellow. |
---|
| 15 | |
---|
| 16 | =head1 [_default_] SECTION |
---|
| 17 | |
---|
| 18 | This section contains global configuration variables |
---|
| 19 | |
---|
| 20 | =head2 VARIABLES |
---|
| 21 | |
---|
| 22 | =head3 base |
---|
| 23 | |
---|
| 24 | The top level base to use by default to modify informations. The base must |
---|
| 25 | exists as a section in the configuration |
---|
| 26 | |
---|
| 27 | =head3 sync |
---|
| 28 | |
---|
| 29 | The default synchronisation to run. The synchronisation must exists as a section |
---|
| 30 | in configuration. |
---|
| 31 | |
---|
| 32 | =head3 state_dir |
---|
| 33 | |
---|
| 34 | The directory where data files will be stored |
---|
| 35 | |
---|
| 36 | =head3 smtp |
---|
| 37 | |
---|
| 38 | The SMTP server to use to send mails |
---|
| 39 | |
---|
| 40 | =head3 mailFrom |
---|
| 41 | |
---|
| 42 | The identity to use in FROM field when sending mail |
---|
| 43 | |
---|
| 44 | =head3 expire_summary_to |
---|
| 45 | |
---|
| 46 | When set, this email address will receive a summary about account expiring soon |
---|
| 47 | |
---|
[1958] | 48 | =head3 mailSubject |
---|
| 49 | |
---|
| 50 | This parameter is dedicate to set the company or institute name. It is used to |
---|
| 51 | build the subject of mail send by application. |
---|
| 52 | |
---|
[861] | 53 | =head2 [_defattr_] SECTION |
---|
| 54 | |
---|
| 55 | Contains value assigned at object creation if the value is not specified. |
---|
| 56 | Each variable is in form C<object.attributes>. |
---|
| 57 | |
---|
[1077] | 58 | Some value can be specify for more complex auto completion: |
---|
| 59 | |
---|
[861] | 60 | =head3 user.homebase |
---|
| 61 | |
---|
| 62 | This value is used a base directory for UNIX user home. The login is append to |
---|
| 63 | end of the value (preceded by a C</>). |
---|
| 64 | |
---|
[1077] | 65 | =head3 user.maildomain |
---|
[861] | 66 | |
---|
[1077] | 67 | If exists set the mail attribute in form C<sn.givenName@maildomain>. |
---|
| 68 | |
---|
[861] | 69 | =head2 [_network_] |
---|
| 70 | |
---|
| 71 | This section is used by buildnet tools, to generate network config file (DNS |
---|
| 72 | zone and dhcp). |
---|
| 73 | |
---|
| 74 | =head3 template_dir |
---|
| 75 | |
---|
| 76 | The directory containing template files |
---|
| 77 | |
---|
| 78 | =head3 output_dir |
---|
| 79 | |
---|
| 80 | The directory containing results files |
---|
| 81 | |
---|
| 82 | =head3 pre |
---|
| 83 | |
---|
| 84 | A command to execute before processing all zones |
---|
| 85 | |
---|
| 86 | =head3 post |
---|
| 87 | |
---|
| 88 | A command to run after procession all zones |
---|
| 89 | |
---|
| 90 | =head2 post_zone |
---|
| 91 | |
---|
| 92 | A command which will be run after each zone build |
---|
| 93 | |
---|
| 94 | =head2 maillog |
---|
| 95 | |
---|
| 96 | If set, must contains an email address where error will be sent in batch mode. |
---|
| 97 | |
---|
[1225] | 98 | =head2 checkzone |
---|
| 99 | |
---|
| 100 | If set generated DNS zones will be first written in a temporary files and |
---|
| 101 | checked by C<checkzone> utility. |
---|
| 102 | |
---|
| 103 | If the test fail the zone is not generated and temporary file not removed for |
---|
| 104 | analysis. |
---|
| 105 | |
---|
[1249] | 106 | =head2 named-checkzone |
---|
| 107 | |
---|
| 108 | The binary location of named-checkzone, default is C</usr/sbin/named-checkzone>. |
---|
| 109 | |
---|
[861] | 110 | =head2 BASES SECTIONS |
---|
| 111 | |
---|
| 112 | TODO |
---|
| 113 | |
---|
| 114 | =head2 SYNCHRO SECTIONS |
---|
| 115 | |
---|
| 116 | Each synchronisation definition is identified by a section, the section name is |
---|
| 117 | prefixed by C<sync:>. |
---|
| 118 | |
---|
| 119 | =head3 from |
---|
| 120 | |
---|
| 121 | The base to use as source |
---|
| 122 | |
---|
| 123 | =head3 to |
---|
| 124 | |
---|
| 125 | The bases to synchronize, multiples bases can be specified |
---|
| 126 | |
---|
| 127 | =head3 pre |
---|
| 128 | |
---|
| 129 | A script to run before processing, if it failed, the synchronisation is not |
---|
| 130 | performed |
---|
| 131 | |
---|
| 132 | =head3 post |
---|
| 133 | |
---|
| 134 | A script to run after processing, if it failed, the synchronisation is not |
---|
| 135 | recorded as done. |
---|
| 136 | |
---|
| 137 | =head3 unexported |
---|
| 138 | |
---|
| 139 | When set, unexported object are synchronised, usefull for base supporting this |
---|
| 140 | feature (SQL only at time) |
---|
| 141 | |
---|
[1377] | 142 | =head3 noDelete |
---|
| 143 | |
---|
| 144 | Setting this parameter will make the syncronisation not deleting object in |
---|
| 145 | destination bases. |
---|
| 146 | |
---|
| 147 | Setting the C<noDelete.BASE> where C<BASE> is the name of an synchronized base |
---|
| 148 | will make this synchronisation not deleting any object into this base, |
---|
| 149 | |
---|
| 150 | Setting the C<noDelete.BASE.OTYPE> will make the synchronisation not deleting |
---|
| 151 | object type C<OTYPE> no delete into the base named C<BASE>. |
---|
| 152 | |
---|
| 153 | Example: |
---|
| 154 | |
---|
| 155 | noDelete.MyLdap.user = yes |
---|
| 156 | |
---|
[1354] | 157 | =head3 filtering object propagation |
---|
| 158 | |
---|
| 159 | It is possible to filter the objects you want to propagate into peer base. |
---|
| 160 | |
---|
| 161 | The filter to apply must be set into the parameter named |
---|
| 162 | C<filter.BASENAME.OTYPE>, where C<BASENAME> is the name of the destination |
---|
| 163 | base and C<OTYPE> the object type to filter. |
---|
| 164 | |
---|
| 165 | For example to push into C<ldap> base only user being into group C<unix>: |
---|
| 166 | |
---|
| 167 | filter.ldap.user = memberOf=unix |
---|
| 168 | |
---|
[1377] | 169 | |
---|
[1354] | 170 | =head3 Deleting filtered object |
---|
| 171 | |
---|
| 172 | By default filtered object will not be deleted to the destination base, neither |
---|
| 173 | touched. |
---|
| 174 | |
---|
| 175 | Setting option in form C<deletefiltered.BASENAME.OTYPE> to true will allow |
---|
| 176 | deletion. This option has effects only if filtering objects is enabled. |
---|
| 177 | |
---|
[861] | 178 | =head1 SEE ALSO |
---|
| 179 | |
---|
| 180 | la-allowed-values.ini(5), |
---|
| 181 | la-sync-list.ini(5) |
---|
| 182 | |
---|
| 183 | =head1 AUTHOR |
---|
| 184 | |
---|
| 185 | Olivier Thauvin <olivier.thauvin@latmos.ipsl.fr> |
---|
| 186 | |
---|
| 187 | =head1 COPYRIGHT |
---|
| 188 | |
---|
| 189 | (c) LATMOS - IPSL - CNRS |
---|
| 190 | |
---|