Skip to content

Uplink

Uplink service implementation.

Bases: ONVIFService

0.0.1 18.12

Uplink service client.

Property Details
First introduced ONVIF 18.12 (December 2018)
Binding name UplinkBinding (ver10/uplink/wsdl/uplink.wsdl)
Operations uplink.wsdl
Spec Uplink

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the uplink service.

Output
  • Capabilities [Capabilities]
    The capabilities for the uplink service is returned in the Capabilities element.
    • MaxUplinks - optional; [int]
      Maximum number of uplink connections that can be configured.
    • Protocols - optional; [StringList]
      Protocols supported by the device. Defined values are 'https' for native h2c-reverse and 'wss' for h2c-reverse over WebSocket as defined by tup:Protocols.
    • AuthorizationModes - optional; [StringList]
      Supported authorization mode [mTLS AccessToken] as defined by tup:AuthorizationModes.
    • StreamingOverUplink - optional; [boolean]
      Signals support for media streaming over uplink. 
GetUplinks()

A device supporting uplinks shall support this command to retrieve the configured uplink configurations.

The Status field shall signal whether a connection is Offline, Connecting or Online.

Output
  • Configuration - optional, unbounded; [Configuration]
    List of configured uplinks.
    • RemoteAddress [anyURI]
      Uniform resource locator by which the remote client can be reached.
    • CertificateID - optional; [string]
      ID of the certificate to be used for client authentication.
    • UserLevel [StringList]
      List of authorization levels and roles that will be used to restrict the commands that will be accepted through the uplink connection.
    • Status - optional; [string]
      Current connection status (see tup:ConnectionStatus for possible values).
    • CertPathValidationPolicyID - optional; [string]
      CertPathValidationPolicyID used to validate the uplink server certificate. If not configured, server certificate validation behavior is undefined and the device may either apply a vendor specific default validation policy or skip validation at all.
    • AuthorizationServer - optional; [ReferenceToken]
      AuthorizationServer token referring to the server that provides access tokens to authorize with the uplink server.
      Maximum length: 64
    • Error - optional; [string]
      Optional user readable error information (readonly). 
SetUplink(Configuration)

A device supporting uplinks shall support this command to add or modify an uplink configuration.

The Status property of the UplinkConfiguration shall be ignored by the device. A device shall use the field RemoteAddress to decide whether to update an existing entry or create a new entry.

Input
  • Configuration [Configuration]
    Configuration to be added or modified.
    • RemoteAddress [anyURI]
      Uniform resource locator by which the remote client can be reached.
    • CertificateID - optional; [string]
      ID of the certificate to be used for client authentication.
    • UserLevel [StringList]
      List of authorization levels and roles that will be used to restrict the commands that will be accepted through the uplink connection.
    • Status - optional; [string]
      Current connection status (see tup:ConnectionStatus for possible values).
    • CertPathValidationPolicyID - optional; [string]
      CertPathValidationPolicyID used to validate the uplink server certificate. If not configured, server certificate validation behavior is undefined and the device may either apply a vendor specific default validation policy or skip validation at all.
    • AuthorizationServer - optional; [ReferenceToken]
      AuthorizationServer token referring to the server that provides access tokens to authorize with the uplink server.
      Maximum length: 64
    • Error - optional; [string]
      Optional user readable error information (readonly). 
DeleteUplink(RemoteAddress)

A device supporting uplinks shall support this command to remove an uplink configuration.

Input
  • RemoteAddress [anyURI]
    Uniform resource locator of the configuration to be deleted.