Index: /branch/sphinxdoc/src/scheduler.rst =================================================================== --- /branch/sphinxdoc/src/scheduler.rst (revision 4308) +++ /branch/sphinxdoc/src/scheduler.rst (revision 4320) @@ -19,65 +19,60 @@ --------------------- -It should be very straightforward to set up a new scan schedule. -A table follows that explains everything you may see on the -*Scan Scheduler Editor* window. +To set up a new scan schedule you just need to define a name for the schedule, +a schedule profile and a command for it. The other options are optional, but +you may want to use them too. -.. table:: Fields explanation +The following table tells about all the fields you will find in the +*Scan Scheduler Editor*. - +--------------------+---------------------------------------------------+ - | Field | Meaning | - +====================+===================================================+ - | Schema name | Defines an unique name for the Scan Schedule that | - | | is being created, you may name it like | - | | "network scan", "local scan", etc. | - | | Note that if you choose to add this schedule | - | | to the Inventory, the Inventory's name will be | - | | the Schema name. | - +--------------------+---------------------------------------------------+ - | Scan Profile | These profiles are the profiles you created in | - | | UMIT, they define scan options. | - +--------------------+---------------------------------------------------+ - | Command | Command is the scan command that will be used in | - | | this schedule. | - +--------------------+---------------------------------------------------+ - | Scheduling Profile | You need to choose one of the available | - | | Scheduling Profiles. | - | | This defines when the schema command will be | - | | executed. Clicking on "Edit Profiles" will open | - | | the Scheduling Profiles Editor. | - +--------------------+---------------------------------------------------+ - -.. table:: Schema Settings - - +----------------------+-------------------------------------------------+ - | Option | Meaning | - +======================+=================================================+ - | Save outputs to | If you choose to save output, you will need to | - | | specify an output directory. A directory is | - | | required because a schedule is likely to be | - | | executed several times, so the file output is a | - | | combination of directory output, schema name | - | | and number of outputs for that schema. | - +----------------------+-------------------------------------------------+ - | Send output to email | If you choose to send output to a email, you | - | | will need to specify one or more recipients. | - | | Example: me@example.com or | - | | me@example.com,her@example.com. | - | | You also need to choose one of the available | - | | SMTP Schemas, if there is no SMTP Schema | - | | created yet you will need to open "SMTP Setup" | - | | window and create one so you can use it here. | - +----------------------+-------------------------------------------------+ - | Add to the Inventory | If you toggle on this option, the scan output | - | | will be added to the Network Inventory, | - | | according to the previous explanation given on | - | | "Schema Name". | - +----------------------+-------------------------------------------------+ - | Enabled | If you toggle on "Enabled", this schema will | - | | run on the scheduled time if the Scheduler is | - | | running. Otherwise, it will just exist but will | - | | never be executed (you may come back later and | - | | Enable it). | - +----------------------+-------------------------------------------------+ + +----------------------+---------------------------------------------------+ + | Field | Meaning | + +======================+===================================================+ + | Schema name | Defines an unique name for the Scan Schedule that | + | | is being created, you may name it like | + | | "network scan", "local scan", etc. | + | | Note that if you choose to add this schedule | + | | to the Inventory, the Inventory's name will be | + | | the Schema name. | + +----------------------+---------------------------------------------------+ + | Scan Profile | These profiles are the profiles you created in | + | | UMIT, they define scan options. | + +----------------------+---------------------------------------------------+ + | Command | Command is the scan command that will be used in | + | | this schedule. | + +----------------------+---------------------------------------------------+ + | Scheduling Profile | You need to choose one of the available | + | | Scheduling Profiles. | + | | This defines when the schema command will be | + | | executed. Clicking on "Edit Profiles" will open | + | | the Scheduling Profiles Editor. | + +----------------------+---------------------------------------------------+ + | Save outputs to | If you choose to save output, you will need to | + | | specify an output directory. A directory is | + | | required because a schedule is likely to be | + | | executed several times, so the file output is a | + | | combination of directory output, schema name | + | | and number of outputs for that schema. | + +----------------------+---------------------------------------------------+ + | Send output to email | If you choose to send output to a email, you | + | | will need to specify one or more recipients. | + | | Example: me@example.com or | + | | me@example.com,her@example.com. | + | | You also need to choose one of the available | + | | SMTP Schemas, if there is no SMTP Schema | + | | created yet you will need to open "SMTP Setup" | + | | window and create one so you can use it here. | + +----------------------+---------------------------------------------------+ + | Add to the Inventory | If you toggle on this option, the scan output | + | | will be added to the Network Inventory, | + | | according to the previous explanation given on | + | | "Schema Name". | + +----------------------+---------------------------------------------------+ + | Enabled | If you toggle on "Enabled", this schema will | + | | run on the scheduled time if the Scheduler is | + | | running. Otherwise, it will just exist but will | + | | never be executed (you may come back later and | + | | Enable it). | + +----------------------+---------------------------------------------------+ After filling all the required fields, you may click on "Apply".