target.snmp

Snmp Target File

oneOf	V2c
	V3Auth
	V3Cert

V2c

Target snmp V2 with a community base authentication

type	object
properties
type	type	string
	enum	V2c
	default	V2c
address	The address of the device
	type	string
community	The SNMP community used for the connection with the remote device
	type	string
defaultPollingInterval	The time between two request (refresh time) Default value is [{“unit”:”SECONDS”,”value”:10}]
	default	unit	SECONDS
		value	10
	DurationConfigurationEntity
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
maximumOID	The maximum number of OID of one request. Default value is [50]
	type	integer
	default	50
moduleId	The module who own this target and manage his Items
	type	string
port	The port used by the device Default value is [161]
	type	integer
	default	161
protocol	The type of transport layer
	type	string
	enum	UDP, TCP, TLS, DTLS
retry	The number of times the request is retried before raising an error Default value is [3]
	type	integer
	default	3
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
timeout	The time to wait a response to a request before retried (see retry) Default value is [{“unit”:”MILLISECONDS”,”value”:1500}]
	default	unit	MILLISECONDS
		value	1500
	DurationConfigurationEntity
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

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

V3Auth

Target snmp V3 with a priv/auth base authentication

type	object
properties
type	type	string
	enum	V3Auth
	default	V3Auth
address	The address of the device
	type	string
authKeyProvider	The authentication key used for the connection with the remote device
	oneOf	PLAINTEXT
		SECRET
		ENCRYPTED
authProtocol	The authentication protocol used for the connection with the remote device
	type	string
	enum	NONE, MD5, SHA1, SHA224, SHA256, SHA384, SHA512
contextId	The id of the context to use to access a collection of management information
	type	string
contextName	The name of the context to use to access a collection of management information
	type	string
defaultPollingInterval	The time between two request (refresh time) Default value is [{“unit”:”SECONDS”,”value”:10}]
	default	unit	SECONDS
		value	10
	DurationConfigurationEntity
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
maximumOID	The maximum number of OID of one request. Default value is [50]
	type	integer
	default	50
moduleId	The module who own this target and manage his Items
	type	string
port	The port used by the device Default value is [161]
	type	integer
	default	161
privacyKeyProvider	The password used for the connection with the remote device
	oneOf	PLAINTEXT
		SECRET
		ENCRYPTED
privacyProtocol	The cipher method used for the connection with the remote device
	type	string
	enum	NONE, DES, TRIPLE_DES, AES128, AES192, AES256
protocol	The type of transport layer
	type	string
	enum	UDP, TCP, TLS, DTLS
retry	The number of times the request is retried before raising an error Default value is [3]
	type	integer
	default	3
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
timeout	The time to wait a response to a request before retried (see retry) Default value is [{“unit”:”MILLISECONDS”,”value”:1500}]
	default	unit	MILLISECONDS
		value	1500
	DurationConfigurationEntity
username	The username to use to connect with the remote device
	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. see documentation ↗️ see toolbox ↗️
	type	string
additionalProperties	False

V3Cert

Target snmp V3 with a certificate base authentication

type	object
properties
type	type	string
	enum	V3Cert
	default	V3Cert
address	The address of the device
	type	string
clientCertificate	The certificate used for authenticate the client on the remote device 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
contextId	The id of the context to use to access a collection of management information
	type	string
contextName	The name of the context to use to access a collection of management information
	type	string
defaultPollingInterval	The time between two request (refresh time) Default value is [{“unit”:”SECONDS”,”value”:10}]
	default	unit	SECONDS
		value	10
	DurationConfigurationEntity
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
maximumOID	The maximum number of OID of one request. Default value is [50]
	type	integer
	default	50
moduleId	The module who own this target and manage his Items
	type	string
port	The port used by the device Default value is [161]
	type	integer
	default	161
protocol	The type of transport layer
	type	string
	enum	UDP, TCP, TLS, DTLS
retry	The number of times the request is retried before raising an error Default value is [3]
	type	integer
	default	3
serverKey	The certificate used for authenticate the remote device on the local client (OSP)
	type	string
subject	The expected Common Name (CN) of the remote device
	type	string
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
timeout	The time to wait a response to a request before retried (see retry) Default value is [{“unit”:”MILLISECONDS”,”value”:1500}]
	default	unit	MILLISECONDS
		value	1500
	DurationConfigurationEntity
username	The username to use to connect with the remote device
	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

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