ARI/AMI: Update versions; update UPGRADE/CHANGES notes for 12.1.0 changes
[asterisk/asterisk.git] / UPGRADE.txt
1 ===========================================================
2 ===
3 === Information for upgrading between Asterisk versions
4 ===
5 === These files document all the changes that MUST be taken
6 === into account when upgrading between the Asterisk
7 === versions listed below. These changes may require that
8 === you modify your configuration files, dialplan or (in
9 === some cases) source code if you have your own Asterisk
10 === modules or patches. These files also include advance
11 === notice of any functionality that has been marked as
12 === 'deprecated' and may be removed in a future release,
13 === along with the suggested replacement functionality.
14 ===
15 === UPGRADE-1.2.txt -- Upgrade info for 1.0 to 1.2
16 === UPGRADE-1.4.txt -- Upgrade info for 1.2 to 1.4
17 === UPGRADE-1.6.txt -- Upgrade info for 1.4 to 1.6
18 === UPGRADE-1.8.txt -- Upgrade info for 1.6 to 1.8
19 === UPGRADE-10.txt  -- Upgrade info for 1.8 to 10
20 === UPGRADE-11.txt  -- Upgrade info for 10 to 11
21 === UPGRADE-12.txt  -- Upgrade info for 11 to 12
22 ===========================================================
23
24 From 12 to 13:
25
26 - The per console verbose level feature as previously implemented caused a
27   large performance penalty.  The fix required some minor incompatibilities
28   if the new rasterisk is used to connect to an earlier version.  If the new
29   rasterisk connects to an older Asterisk version then the root console verbose
30   level is always affected by the "core set verbose" command of the remote
31   console even though it may appear to only affect the current console.  If
32   an older version of rasterisk connects to the new version then the
33   "core set verbose" command will have no effect.
34
35 ARI:
36  - The ARI version has been changed from 1.0.0 to 1.1.0. This is to reflect
37    the backwards compatible changes listed below.
38
39  - Added a new ARI resource 'mailboxes' which allows the creation and
40    modification of mailboxes managed by external MWI. Modules res_mwi_external
41    and res_stasis_mailbox must be enabled to use this resource.
42
43  - Added new events for externally initiated transfers. The event
44    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
45    of a bridge in the ARI controlled application to the dialplan; the
46    BridgeAttendedTransfer event is raised when a channel initiates an
47    attended transfer of a bridge in the ARI controlled application to the
48    dialplan.
49
50  - Channel variables may now be specified as a body parameter to the
51    POST /channels operation. The 'variables' key in the JSON is interpreted
52    as a sequence of key/value pairs that will be added to the created channel
53    as channel variables. Other parameters in the JSON body are treated as
54    query parameters of the same name.
55
56 AMI:
57  - The AMI version has been changed from 2.0.0 to 2.1.0. This is to reflect
58    the backwards compatible changes listed below.
59
60  - The DialStatus field in the DialEnd event can now have additional values.
61    This includes ABORT, CONTINUE, and GOTO.
62
63  - The res_mwi_external_ami module can, if loaded, provide additional AMI
64    actions and events that convey MWI state within Asterisk. This includes
65    the MWIGet, MWIUpdate, and MWIDelete actions, as well as the MWIGet and
66    MWIGetComplete events that occur in response to an MWIGet action.
67
68 CDRs:
69  - The "endbeforehexten" setting now defaults to "yes", instead of "no".
70    When set to "no", yhis setting will cause a new CDR to be generated when a
71    channel enters into hangup logic (either the 'h' extension or a hangup
72    handler subroutine). In general, this is not the preferred default: this
73    causes extra CDRs to be generated for a channel in many common dialplans.
74
75 CLI commands:
76  - "core show settings" now lists the current console verbosity in addition
77    to the root console verbosity.
78
79  - "core set verbose" has not been able to support the by module verbose
80    logging levels since verbose logging levels were made per console.  That
81    syntax is now removed and a silence option added in its place.
82
83 Configuration Files:
84  - The 'verbose' setting in logger.conf still takes an optional argument,
85    specifying the verbosity level for each logging destination.  However,
86    the default is now to once again follow the current root console level.
87    As a result, using the AMI Command action with "core set verbose" could
88    again set the root console verbose level and affect the verbose level
89    logged.
90
91  - The manager.conf 'eventfilter' now takes an "extended" regular expression
92    instead of a "basic" one.
93
94 Realtime Configuration:
95  - WARNING: The database migration script that adds the 'extensions' table for
96    realtime had to be modified due to an error when installing for MySQL.  The
97    'extensions' table's 'id' column was changed to be a primary key.  This could
98    potentially cause a migration problem.  If so, it may be necessary to
99    manually alter the affected table/column to bring it back in line with the
100    migration scripts.
101
102  - New columns have been added to realtime tables for 'support_path' on
103    ps_registrations and ps_aors and for 'path' on ps_contacts for the new
104    SIP Path support in chan_pjsip.
105
106  - The following new tables have been added for pjsip realtime: 'ps_systems',
107    'ps_globals', 'ps_tranports', 'ps_registrations'.
108
109  - The following columns were added to the 'ps_aors' realtime table:
110    'maximum_expiration', 'outbound_proxy', and 'support_path'.
111
112  - The following columns were added to the 'ps_contacts' realtime table:
113    'outbound_proxy' and 'path'.
114
115  - New columns have been added to the ps_endpoints realtime table for the
116    'media_address', 'redirect_method' and 'set_var' options.  Also the
117    'mwi_fromuser' column was renamed to 'mwi_from_user'.
118
119  - A new column was added to the 'ps_globals' realtime table for the 'debug'
120    option.
121
122
123 ===========================================================
124 ===========================================================