Show
Ignore:
Timestamp:
03/07/09 23:00:27 (4 years ago)
Author:
gpolo
Message:

Rewording and some reformatting.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • branch/sphinxdoc/src/scheduler.rst

    r4308 r4320  
    1919--------------------- 
    2020 
    21 It should be very straightforward to set up a new scan schedule. 
    22 A table follows that explains everything you may see on the 
    23 *Scan Scheduler Editor* window. 
     21To set up a new scan schedule you just need to define a name for the schedule, 
     22a schedule profile and a command for it. The other options are optional, but 
     23you may want to use them too. 
    2424 
    25 .. table::  Fields explanation 
     25The following table tells about all the fields you will find in the 
     26*Scan Scheduler Editor*. 
    2627 
    27    +--------------------+---------------------------------------------------+ 
    28    | Field              | Meaning                                           | 
    29    +====================+===================================================+ 
    30    | Schema name        | Defines an unique name for the Scan Schedule that | 
    31    |                    | is being created, you may name it like            | 
    32    |                    | "network scan", "local scan", etc.                | 
    33    |                    | Note that if you choose to add this schedule      | 
    34    |                    | to the Inventory, the Inventory's name will be    | 
    35    |                    | the Schema name.                                  | 
    36    +--------------------+---------------------------------------------------+ 
    37    | Scan Profile       | These profiles are the profiles you created in    | 
    38    |                    | UMIT, they define scan options.                   | 
    39    +--------------------+---------------------------------------------------+ 
    40    | Command            | Command is the scan command that will be used in  | 
    41    |                    | this schedule.                                    | 
    42    +--------------------+---------------------------------------------------+ 
    43    | Scheduling Profile | You need to choose one of the available           | 
    44    |                    | Scheduling Profiles.                              | 
    45    |                    | This defines when the schema command will be      | 
    46    |                    | executed. Clicking on "Edit Profiles" will open   | 
    47    |                    | the Scheduling Profiles Editor.                   | 
    48    +--------------------+---------------------------------------------------+ 
    49  
    50 .. table:: Schema Settings 
    51  
    52    +----------------------+-------------------------------------------------+ 
    53    | Option               | Meaning                                         | 
    54    +======================+=================================================+ 
    55    | Save outputs to      | If you choose to save output, you will need to  | 
    56    |                      | specify an output directory. A directory is     | 
    57    |                      | required because a schedule is likely to be     | 
    58    |                      | executed several times, so the file output is a | 
    59    |                      | combination of directory output, schema name    | 
    60    |                      | and number of outputs for that schema.          | 
    61    +----------------------+-------------------------------------------------+ 
    62    | Send output to email | If you choose to send output to a email, you    | 
    63    |                      | will need to specify one or more recipients.    | 
    64    |                      | Example: me@example.com or                      | 
    65    |                      | me@example.com,her@example.com.                 | 
    66    |                      | You also need to choose one of the available    | 
    67    |                      | SMTP Schemas, if there is no SMTP Schema        | 
    68    |                      | created yet you will need to open "SMTP Setup"  | 
    69    |                      | window and create one so you can use it here.   | 
    70    +----------------------+-------------------------------------------------+ 
    71    | Add to the Inventory | If you toggle on this option, the scan output   | 
    72    |                      | will be added to the Network Inventory,         | 
    73    |                      | according to the previous explanation given on  | 
    74    |                      | "Schema Name".                                  | 
    75    +----------------------+-------------------------------------------------+ 
    76    | Enabled              | If you toggle on "Enabled", this schema will    | 
    77    |                      | run on the scheduled time if the Scheduler is   | 
    78    |                      | running. Otherwise, it will just exist but will | 
    79    |                      | never be executed (you may come back later and  | 
    80    |                      | Enable it).                                     | 
    81    +----------------------+-------------------------------------------------+ 
     28   +----------------------+---------------------------------------------------+ 
     29   | Field                | Meaning                                           | 
     30   +======================+===================================================+ 
     31   | Schema name          | Defines an unique name for the Scan Schedule that | 
     32   |                      | is being created, you may name it like            | 
     33   |                      | "network scan", "local scan", etc.                | 
     34   |                      | Note that if you choose to add this schedule      | 
     35   |                      | to the Inventory, the Inventory's name will be    | 
     36   |                      | the Schema name.                                  | 
     37   +----------------------+---------------------------------------------------+ 
     38   | Scan Profile         | These profiles are the profiles you created in    | 
     39   |                      | UMIT, they define scan options.                   | 
     40   +----------------------+---------------------------------------------------+ 
     41   | Command              | Command is the scan command that will be used in  | 
     42   |                      | this schedule.                                    | 
     43   +----------------------+---------------------------------------------------+ 
     44   | Scheduling Profile   | You need to choose one of the available           | 
     45   |                      | Scheduling Profiles.                              | 
     46   |                      | This defines when the schema command will be      | 
     47   |                      | executed. Clicking on "Edit Profiles" will open   | 
     48   |                      | the Scheduling Profiles Editor.                   | 
     49   +----------------------+---------------------------------------------------+ 
     50   | Save outputs to      | If you choose to save output, you will need to    | 
     51   |                      | specify an output directory. A directory is       | 
     52   |                      | required because a schedule is likely to be       | 
     53   |                      | executed several times, so the file output is a   | 
     54   |                      | combination of directory output, schema name      | 
     55   |                      | and number of outputs for that schema.            | 
     56   +----------------------+---------------------------------------------------+ 
     57   | Send output to email | If you choose to send output to a email, you      | 
     58   |                      | will need to specify one or more recipients.      | 
     59   |                      | Example: me@example.com or                        | 
     60   |                      | me@example.com,her@example.com.                   | 
     61   |                      | You also need to choose one of the available      | 
     62   |                      | SMTP Schemas, if there is no SMTP Schema          | 
     63   |                      | created yet you will need to open "SMTP Setup"    | 
     64   |                      | window and create one so you can use it here.     | 
     65   +----------------------+---------------------------------------------------+ 
     66   | Add to the Inventory | If you toggle on this option, the scan output     | 
     67   |                      | will be added to the Network Inventory,           | 
     68   |                      | according to the previous explanation given on    | 
     69   |                      | "Schema Name".                                    | 
     70   +----------------------+---------------------------------------------------+ 
     71   | Enabled              | If you toggle on "Enabled", this schema will      | 
     72   |                      | run on the scheduled time if the Scheduler is     | 
     73   |                      | running. Otherwise, it will just exist but will   | 
     74   |                      | never be executed (you may come back later and    | 
     75   |                      | Enable it).                                       | 
     76   +----------------------+---------------------------------------------------+ 
    8277 
    8378After filling all the required fields, you may click on "Apply".