controller.onvif

Onvif door controller

type

object

properties

  • 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

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • 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

  • 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

  • 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

ENCRYPTED

  • 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

  • sslConfiguration

The SSL configuration to connect to the ONVIF device

SslConfigurationEntity

  • 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

  • username

The username to use for the connection to the device.

It can be for example sysadmin.

Learn more about ONVIF ↗️.

type

string

  • 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

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

ENCRYPTED

type

object

properties

  • type

type

string

enum

ENCRYPTED

default

ENCRYPTED

  • encryptedPassword

The password encrypted Base64(IV+AES256(password, input)) the password must be a shared secret available for the osp-configuration-dispatcher

see documentation ↗️ see toolbox ↗️

type

string

  • secretPath

The full path to the secret exposed by the orchestrator; this password is used to encrypt the encryptedPassword.

type

string

additionalProperties

False

SslConfigurationEntity

type

object

properties

  • clientCertificate

Learn more about ONVIF ↗️.

Default value is [{“caPath”:”ca.crt”,”privateKeyPath”:”module.key”,”providerType”:”SECRETS”,”publicKeyPath”:”module.crt”}]

default

caPath

ca.crt

privateKeyPath

module.key

providerType

SECRETS

publicKeyPath

module.crt

ClientCertificate

  • disableHostnameCheck

This option let you disable the check of the hostname (accept IP instead of dns for example).

type

boolean

  • isAllCertificatesCheckDisabled

This option let you accept self-signed certificate.

type

boolean

additionalProperties

False

ClientCertificate

type

object

properties

  • caPath

The CA (public key) used for the generation of the client certificate

type

string

  • privateKeyPath

The private key used for authentication by the OSP client is located at a path relative to either the secret directory or the base configuration file (which is /, not /root/).

type

string

  • providerType

The following value are * SECRET : provided by the docker orchestrator (must be in /run/secrets folder) * CONFIG : the certificate is provided by the configuration

In the example below the configuration of the key publicKeyPath is equals to the destination /test.crt

{
  "resources": [
    {
      "source": "</root/opc-certs/test.crt",
      "destination": "/test.crt"
    }
  ]
}

type

string

enum

SECRETS, CONFIG

  • publicKeyPath

The public key used for authentication by the OSP client is located at a path relative to either the secret directory or the base configuration file (which is /, not /root/).

type

string

additionalProperties

False