Update existing SNMP profile configurations

patch

https://de1.api.central.arubanetworks.com/network-config/v1alpha1/snmp/{name}

SNMP profile to configure SNMP parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

name

string

required

length ≤ 9999

SNMP profile name.

Query Params

object-type

string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

scope-id

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

device-function

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

group

array of objects

length ≤ 2147483647

SNMPv3 User to Group entry.

group

ieee8021mib

string

enum

SNMP access restrictions for the ieee8021mib MIB

Show Details

ALLOW	Allow the unsecured access to this MIB.
BLOCK	Block the unsecured access to this MIB.

Allowed:

macsecmib

string

enum

SNMP access restrictions for the hpicfMACsec MIB

Show Details

ALLOW	Allow the unsecured access to this MIB.
BLOCK	Block the unsecured access to this MIB.

Allowed:

notify-group

array of objects

length ≤ 2147483647

List of SNMPv3 notify groups.

notify-group

param

array of objects

length ≤ 2147483647

List of SNMPv3 params.

param

switchauthmib

string

enum

SNMP access restrictions for the switchauthmib MIB

Show Details

EXCLUDE	MIB subtree excluded in SNMP view.
INCLUDE	MIB subtree included in SNMP view.

Allowed:

target

array of objects

length ≤ 2147483647

List of SNMPv3 targets.

target

v3-community

array of objects

length ≤ 2147483647

List of SNMPv3 community.

v3-community

agent-port

int32

0 to 65535

Defaults to 161

The SNMP server agent port

auth-privacy-security-level

boolean

SNMPv3 Security Level.

auth-security-level

boolean

SNMPv3 Security Level.

community

array of objects

length ≤ 2147483647

List of SNMP communities.

community

context

array of objects

length ≤ 2147483647

List of SNMP contexts.

context

description

string

length between 1 and 256

SNMP profile description.

enable-snmpv3-only

boolean

Enables only the SNMPv3 mode of operation and disallows SNMP v1 and v2c.

inform-queue-length

int32

100 to 350

Defaults to 250

To set inform queue length. By default inform queue length set to 250.

listen

string

enum

SNMP server listen mode.

Show Details

BOTH	Enable SNMP Server on both OOBM and Data planes.
DATA	Enable SNMP Server on Data Plane only.
MANAGEMENT_INTERFACE	Enable SNMP Server on Management Interface only.

Allowed:

loopback-interface

int32

0 to 255

Loopback interface.

name

string

length between 1 and 256

SNMP profile name.

notification-receiver

array of objects

length ≤ 2147483647

List of SNMP Notification receivers (traps or informs).

notification-receiver

remote-user

array of objects

length ≤ 2147483647

List of users on a remote SNMP engine who receives the inform notifications.

remote-user

response-source

length ≤ 9999

Source IP address of the SNMP response PDU.

restricted-access

boolean

Defaults to false

Enable SNMPv1 and SNMPv2c access properties.

snmp-response-source

array of objects

length ≤ 2147483647

Source IP/interface for SNMP responses

snmp-response-source

snmp-source-controller-ip

boolean

Defaults to false

On enabling this parameter source address of SNMP responses will be set to Controller IP.

snmp-trap-source

array of objects

length ≤ 2147483647

Source IP/interface for SNMP traps

snmp-trap-source

stats-enable

boolean

Defaults to false

Enable SNMP stats.

trap-enable

boolean

Defaults to true

To enable SNMP traps in system. By default traps are enabled.

trap-interface

int32

0 to 255

Loopback interface.

trap-source

length ≤ 9999

Source address of SNMP notification responses.
Only ip-address type is supported for gateways

unique-req-id-enable

boolean

Enable SNMP unique request-id check.

user

array of objects

length ≤ 2147483647

List of SNMPv3 users.

user

v1-enable

boolean

Defaults to true

SNMPv1 version.

v2c-enable

boolean

Defaults to true

SNMPv2c Version.

v3-enable

boolean

Defaults to false

SNMPv3 version.

view

array of objects

length ≤ 2147483647

List of SNMP MIB views.

view

vrf

array of strings

length ≤ 2147483647

vrf

vrrp-id

int32

0 to 255

VRRP instance ID. This enables to use VRRP IP address
as source address in SNMP traps.
Only VRRP-ID or IP address as SNMP trap-source can be configured and not both.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Operation

400Bad Request

401Unauthorized Access

403Forbidden

404Not Found

406Not Acceptable

408Request Timeout

412Precondition Failed

429Rate limit exceeded

500Internal Server Error