target.snmp¶

Snmp Target File¶

oneOf	V2c
	V2c
	V3Auth
	V3Auth
	V3Cert
	V3Cert

V2c¶

Target snmp V2 with a community base authentication

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

DurationConfigurationEntity¶

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

V3Auth¶

Target snmp V3 with a priv/auth base authentication

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

V3Cert¶

Target snmp V3 with a certificate base authentication

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

ClientCertificate¶

type	object
properties
publicKeyPath	The private key for the authentication from the OSP client.
	type	string
privateKeyPath	The public key for the authentication from the OSP client.
	type	string
caPath	The CA (public key) used for the generation of the client certificate
	type	string
additionalProperties	False