controller.onvif

Onvif door controller

type	object
properties
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
isTemplateGeneratedByOspComposer	If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.
	type	boolean
username	The username to use for the connection to the device. It can be for example sysadmin. Learn more about ONVIF ↗️.
	type	string
passwordProvider	The password to use for the connection to the device. It can be defined as plaintext or via a secret. Learn more about ONVIF ↗️.
	oneOf	PLAINTEXT
		SECRET
hostname	The hostname (ip address or hostname) to connect to the ONVIF device. It can be for example 192.168.1.12. Learn more about ONVIF ↗️.
	type	string
port	The port number on which the ONVIF device’s server is listening. This port is used by the client to establish a connection with the server. It should be a valid port number between 0 and 65535. By default the RTSP port is usually 554, the HTTP/ONVIF port is 80 or 8080, and the HTTPS/ONVIF port is 443. Learn more about ONVIF ↗️.
	type	integer
onvifPath	The path to connect to the ONVIF device. The construction is by default pointing to onvif/device_service. Which means if the host is 192.168.1.1 and the port 80 that the final address will be 192.168.1.1:80/onvif/device_service. Learn more about ONVIF ↗️.
	type	string
sslConfiguration	The SSL configuration to connect to the ONVIF device
	SslConfigurationEntity
moduleId	The ONVIF module module.onvif ↗️ that this door will use to communicate. For example modules.onvif.onvif-1 is the default OnSphere path of the ONVIF module.
	type	string
additionalProperties	False

PLAINTEXT

type	object
properties
type	type	string
	enum	PLAINTEXT
	default	PLAINTEXT
password	The password to use in plaintext. It can be for example thisIs@TestPassword123.
	type	string
additionalProperties	False

SECRET

type	object
properties
type	type	string
	enum	SECRET
	default	SECRET
secretPath	The path of the secret containing the password. This is a path to the secret containing the password.
	type	string
additionalProperties	False

SslConfigurationEntity

type	object
properties
isAllCertificatesCheckDisabled	This option let you accept self-signed certificate.
	type	boolean
disableHostnameCheck	This option let you disable the check of the hostname (accept IP instead of dns for example).
	type	boolean
publicKeyPath	The file path to the ONVIF public key used for client authentication. This key is associated with the provided certificate and is required to establish a secure connection. The private key should be in PEM or DER format. An absolute path is required. Learn more about ONVIF ↗️.
	type	string
privateKeyPath	The file path to the ONVIF private key used for client authentication. This key is associated with the provided certificate and is required to establish a secure connection. The private key should be in PEM or DER format. An absolute path is required. Learn more about ONVIF ↗️.
	type	string
caPath	The file path to the ONVIF certificate used for client authentication. This certificate is used to establish a secure connection with the ONVIF controller and should be a valid X.509 certificate in PEM or DER format. An absolute path is required. Learn more about ONVIF ↗️.
	type	string
additionalProperties	False