ONVIF™ – 1 – ONVIF Core Spec. – Ver. 18.12
ONVIF™
Core Specification
Version 18.12
December, 2018
ONVIF™ – 2 – ONVIF Core Spec. – Ver. 18.12
2008-2018 by ONVIF: Open Network Video Interface Forum Inc.. All rights reserved.
Recipients of this document may copy, distribute, publish, or display this document so long as this
copyright notice, license and disclaimer are retained with all copies of the document. No license is
granted to modify this document.
THIS DOCUMENT IS PROVIDED "AS IS," AND THE CORPORATION AND ITS MEMBERS AND
THEIR AFFILIATES, MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THIS
DOCUMENT ARE SUITABLE FOR ANY PURPOSE; OR THAT THE IMPLEMENTATION OF SUCH
CONTENTS WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER
RIGHTS.
IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE
FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
DAMAGES, ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS
DOCUMENT, WHETHER OR NOT (1) THE CORPORATION, MEMBERS OR THEIR AFFILIATES
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR (2) SUCH DAMAGES
WERE REASONABLY FORESEEABLE, AND ARISING OUT OF OR RELATING TO ANY USE OR
DISTRIBUTION OF THIS DOCUMENT. THE FOREGOING DISCLAIMER AND LIMITATION ON
LIABILITY DO NOT APPLY TO, INVALIDATE, OR LIMIT REPRESENTATIONS AND WARRANTIES
MADE BY THE MEMBERS AND THEIR RESPECTIVE AFFILIATES TO THE CORPORATION AND
OTHER MEMBERS IN CERTAIN WRITTEN POLICIES OF THE CORPORATION.
ONVIF™ – 3 – ONVIF Core Spec. – Ver. 18.12
CONTENTS
1 Scope 9
2 Normative references 10
3 Terms and Definitions 11
3.1 Definitions...................................................................................................................... 11
3.2 Abbreviations ................................................................................................................ 11
4 Overview 13
4.1 Web Services ................................................................................................................ 13
4.2 IP configuration ............................................................................................................. 14
4.3 Device discovery ........................................................................................................... 14
4.4 Profiles .......................................................................................................................... 14
4.5 Device management ..................................................................................................... 14
4.5.1 Capabilities ............................................................................................................... 15
4.5.2 Network ..................................................................................................................... 15
4.5.3 System ...................................................................................................................... 16
4.5.4 Retrieval of System Information................................................................................ 16
4.5.5 Firmware Upgrade .................................................................................................... 16
4.5.6 System Restore ........................................................................................................ 16
4.5.7 Security ..................................................................................................................... 17
4.5.8 Storage configuration ................................................................................................ 17
4.6 Event handling .............................................................................................................. 17
4.7 Geo Location ................................................................................................................. 17
5 Web Services framework 19
5.1 Services overview ......................................................................................................... 19
5.1.1 General ..................................................................................................................... 19
5.1.2 Services requirements .............................................................................................. 20
5.2 WSDL overview ............................................................................................................. 20
5.3 Namespaces ................................................................................................................. 21
5.4 Types ............................................................................................................................. 22
5.5 Messages ...................................................................................................................... 22
5.6 Operations ..................................................................................................................... 23
5.6.1 General ..................................................................................................................... 23
5.6.2 One-way operation type ............................................................................................ 24
5.6.3 Request-response operation type............................................................................. 24
5.7 Port Types ..................................................................................................................... 25
5.8 Binding .......................................................................................................................... 25
5.9 Ports .............................................................................................................................. 26
5.10 Services......................................................................................................................... 26
5.11 Error handling ................................................................................................................ 26
5.11.1 Protocol errors ...................................................................................................... 26
5.11.2 SOAP errors ......................................................................................................... 26
5.12 Security ......................................................................................................................... 30
5.12.1 Authentication ....................................................................................................... 30
5.12.2 User-based access control ................................................................................... 31
5.12.3 Username token profile ........................................................................................ 33
ONVIF™ – 4 – ONVIF Core Spec. – Ver. 18.12
5.13
String representation ..................................................................................................... 33
5.13.1 Character Set ....................................................................................................... 33
5.13.2 Allowed characters in strings ................................................................................ 33
6 IP configuration 34
7 Device discovery 35
7.1 General .......................................................................................................................... 35
7.2 Modes of operation ....................................................................................................... 35
7.3 Discovery definitions ..................................................................................................... 35
7.3.1 Endpoint reference ................................................................................................... 35
7.3.2 Hello .......................................................................................................................... 35
7.3.3 Probe and Probe Match ............................................................................................ 38
7.3.4 Resolve and Resolve Match ..................................................................................... 38
7.3.5 Bye ............................................................................................................................ 38
7.3.6 SOAP Fault Messages ............................................................................................. 38
8 Device management 39
8.1 Capabilities .................................................................................................................... 39
8.1.1 Get WSDL URL......................................................................................................... 39
8.1.2 Capability exchange ................................................................................................. 39
8.2 Network ......................................................................................................................... 44
8.2.1 Get hostname ........................................................................................................... 44
8.2.2 Set hostname ............................................................................................................ 45
8.2.3 Set hostname from DHCP ........................................................................................ 45
8.2.4 Get DNS settings ...................................................................................................... 46
8.2.5 Set DNS settings ...................................................................................................... 46
8.2.6 Get NTP settings ...................................................................................................... 47
8.2.7 Set NTP settings ....................................................................................................... 47
8.2.8 Get dynamic DNS settings ........................................................................................ 48
8.2.9 Set dynamic DNS settings ........................................................................................ 50
8.2.10 Get network interface configuration ...................................................................... 50
8.2.11 Set network interface configuration ...................................................................... 51
8.2.12 Get network protocols .......................................................................................... 52
8.2.13 Set network protocols ........................................................................................... 53
8.2.14 Get default gateway.............................................................................................. 53
8.2.15 Set default gateway .............................................................................................. 54
8.2.16 Get zero configuration .......................................................................................... 54
8.2.17 Set zero configuration .......................................................................................... 55
8.2.18 Get IP address filter .............................................................................................. 55
8.2.19 Set IP address filter .............................................................................................. 56
8.2.20 Add an IP filter address ........................................................................................ 56
8.2.21 Remove an IP filter address ................................................................................. 57
8.2.22 IEEE 802.11 configuration .................................................................................... 58
8.3 System .......................................................................................................................... 62
8.3.1 Device Information .................................................................................................... 62
8.3.2 Get System URIs ...................................................................................................... 62
8.3.3 Backup ...................................................................................................................... 63
8.3.4 Restore ..................................................................................................................... 63
8.3.5 Start system restore .................................................................................................. 64
8.3.6 Get system date and time ......................................................................................... 65
8.3.7 Set system date and time ......................................................................................... 66
8.3.8 Factory default .......................................................................................................... 66
8.3.9 Firmware upgrade ..................................................................................................... 67
8.3.10 Start firmware upgrade ......................................................................................... 68
8.3.11 Get system logs .................................................................................................... 69
8.3.12 Get support information ........................................................................................ 69
8.3.13 Reboot .................................................................................................................. 70
8.3.14 Get scope parameters .......................................................................................... 70
ONVIF™ – 5 – ONVIF Core Spec. – Ver. 18.12
8.3.15
Set scope parameters .......................................................................................... 71
8.3.16 Add scope parameters ......................................................................................... 71
8.3.17 Remove scope parameters .................................................................................. 72
8.3.18 Get discovery mode.............................................................................................. 72
8.3.19 Set discovery mode .............................................................................................. 73
8.3.20 Get geo location information ................................................................................ 73
8.3.21 Set geo location information ................................................................................. 75
8.3.22 Remove geo location information ........................................................................ 75
8.4 Security ......................................................................................................................... 76
8.4.1 Get access policy ...................................................................................................... 76
8.4.2 Set access policy ...................................................................................................... 77
8.4.3 Get users .................................................................................................................. 77
8.4.4 Create users ............................................................................................................. 77
8.4.5 Delete users .............................................................................................................. 78
8.4.6 Set users settings ..................................................................................................... 79
8.4.7 Get remote user ........................................................................................................ 80
8.4.8 Set remote user ........................................................................................................ 80
8.4.9 Get endpoint reference ............................................................................................. 81
8.5 Input/Output (I/O) .......................................................................................................... 81
8.5.1 Get relay outputs ...................................................................................................... 81
8.5.2 Set relay output settings ........................................................................................... 81
8.5.3 Trigger relay output ................................................................................................... 82
8.6 Auxiliary operation ......................................................................................................... 83
8.7 Storage Configuration ................................................................................................... 85
8.7.1 GetStorageConfigurations ........................................................................................ 85
8.7.2 CreateStorageConfiguration ..................................................................................... 85
8.7.3 GetStorageConfiguration .......................................................................................... 86
8.7.4 SetStorageConfiguration .......................................................................................... 86
8.7.5 DeleteStorageConfiguration ..................................................................................... 87
8.8 MonitoringEvents .......................................................................................................... 88
8.8.1 Processor Usage ...................................................................................................... 88
8.8.2 Link Status ................................................................................................................ 88
8.8.3 Upload Status ........................................................................................................... 88
8.8.4 Operating Time ......................................................................................................... 88
8.8.5 Environmental Conditions ......................................................................................... 90
8.8.6 Battery capacity ........................................................................................................ 91
8.8.7 Asynchronous Operation Status ............................................................................... 91
8.8.8 Device Management ................................................................................................. 91
8.8.9 Liquid level ................................................................................................................ 91
8.8.10 Mechanial failure .................................................................................................. 92
8.8.11 Geo Location ........................................................................................................ 93
8.9 Service specific fault codes ........................................................................................... 94
9 Event handling 100
9.1 Real-time Pull-Point Notification Interface .................................................................. 100
9.1.1 Create pull point subscription ................................................................................. 102
9.1.2 Pull messages......................................................................................................... 102
9.1.3 Renew ..................................................................................................................... 103
9.1.4 Unsubscribe ............................................................................................................ 104
9.1.5 Seek ........................................................................................................................ 105
9.1.6 Pull Point Lifecycle .................................................................................................. 105
9.1.7 Persistent notification storage ................................................................................. 106
9.2 Notification Streaming Interface .................................................................................. 106
9.3 Basic Notification Interface.......................................................................................... 106
9.3.1 Introduction ............................................................................................................. 106
9.3.2 Requirements.......................................................................................................... 107
