System SNMP configuration module v1.0

Resource: snmp_configuration

SNMP configuration

http://{device}/api/npm.snmp/1.0/snmp/config

JSON

{
  "contact": string,
  "description": string,
  "enabled": boolean,
  "location": string,
  "version_configuration": version_configuration
}

{
  "contact": string,
  "description": string,
  "enabled": boolean,
  "location": string,
  "version_configuration": version_configuration
}

Property Name	Type	Description	Notes
snmp_configuration	<object>	SNMP configuration	Required properties: [enabled, location, description, contact, version_configuration];
snmp_configuration.contact	<string>	Identifies the primary contact for the appliance
snmp_configuration.description	<string>	Description of the appliance. This value can include the full name and version identification of the system's hardware type, software operating-system, and networking software
snmp_configuration.enabled	<boolean>	Enable or disable the SNMP service
snmp_configuration.location	<string>	Appliance location
snmp_configuration.version_configuration	<version_configuration>	An SNMP v1, v2 or v3 config

Links

snmp_configuration: get

GET http://{device}/api/npm.snmp/1.0/snmp/config

Response Body

Returns a snmp_configuration data object.

snmp_configuration: set

PUT http://{device}/api/npm.snmp/1.0/snmp/config

Request Body

Provide a snmp_configuration data object.

Response Body

Returns a snmp_configuration data object.

Type: snmp_v1_v2_config

Settings for SNMPv1/v2

JSON

{
  "community_string": string,
  "version": string,
  <prop>: any
}

{
  "community_string": string,
  "version": string,
  <prop>: any
}

Property Name	Type	Description	Notes
snmp_v1_v2_config	<object>	Settings for SNMPv1/v2	Required properties: [version, community_string];
snmp_v1_v2_config.community_string	<string>	SNMP community string
snmp_v1_v2_config.version	<string>	SNMP version	Values: V1, V2C;
snmp_v1_v2_config.<prop>	<any>		Optional;

Type: snmp_v3_config

Settings for SNMPv3

JSON

{
  <prop>: any
}

{
  <prop>: any
}

Property Name	Type	Description	Notes
snmp_v3_config	<object>	Settings for SNMPv3
snmp_v3_config.<prop>	<any>		Optional;
snmp_v3_config.oneOf[0]	<object>	SNMPv3 settings with no privacy or authentication	Required properties: [version, security_model, username];
snmp_v3_config.oneOf[0].security_model	<string>	Denotes the level of security provided	Values: NoAuthNoPriv;
snmp_v3_config.oneOf[0].username	<string>	If not empty, updates SNMPv3 username; always empty on read
snmp_v3_config.oneOf[0].version	<string>	SNMP version	Values: V3;
snmp_v3_config.oneOf[0].<prop>	<any>		Optional;
snmp_v3_config.oneOf[1]	<object>	SNMPv3 settings with authentication but no privacy	Required properties: [version, security_model, auth_protocol, username];
snmp_v3_config.oneOf[1].auth_protocol	<string>	The protocol used for user authentication	Values: MD5, SHA;
snmp_v3_config.oneOf[1]. new_auth_passphrase	<string>	The password used to authenticate the user	Optional;
snmp_v3_config.oneOf[1].security_model	<string>	Denotes the level of security provided	Values: AuthNoPriv;
snmp_v3_config.oneOf[1].username	<string>	SNMPv3 username
snmp_v3_config.oneOf[1].version	<string>	SNMP version	Values: V3;
snmp_v3_config.oneOf[2]	<object>	SNMPv3 settings with authentication and privacy	Required properties: [version, auth_protocol, privacy_protocol, security_model, username];
snmp_v3_config.oneOf[2].auth_protocol	<string>	The protocol used for user authentication	Values: MD5, SHA;
snmp_v3_config.oneOf[2]. new_auth_passphrase	<string>	The password used to authenticate the user	Optional;
snmp_v3_config.oneOf[2]. new_privacy_passphrase	<string>	The password used to secure the data transfered	Optional;
snmp_v3_config.oneOf[2].privacy_protocol	<string>	The protocol used for user authentication	Values: DES, AES;
snmp_v3_config.oneOf[2].security_model	<string>	Denotes the level of security provided	Values: AuthPriv;
snmp_v3_config.oneOf[2].username	<string>	SNMPv3 username
snmp_v3_config.oneOf[2].version	<string>	SNMP version	Values: V3;

Type: version_configuration

An SNMP v1, v2 or v3 config

JSON

{
  <prop>: any
}

{
  <prop>: any
}

Property Name	Type	Description	Notes
version_configuration	<object>	An SNMP v1, v2 or v3 config
version_configuration.<prop>	<any>		Optional;
version_configuration.oneOf[0]	<snmp_v1_v2_config>	Settings for SNMPv1/v2
version_configuration.oneOf[1]	<snmp_v3_config>	Settings for SNMPv3