api-object-access

SNMP Configuration

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

JSON Table

Attribute Data Type Description
policyCreatedAtLocId application/json ID of the location where policy is created. The value is of the type Location ID JSON.
policyType String A read-only field for internal use.
snmpIntegrationEnabled boolean A true or false value indicating whether to enable the integration with
SNMP servers or not. When SNMP integration is enabled , the system sends
SNMP traps to the configured SNMP servers.
snmpSettings application/json
snmpSettings/versionOneTwoSettings
snmpSettings/versionOneTwoSettings/enableGets
snmpSettings/versionOneTwoSettings/communityString String
snmpSettings/versionThreeSettings application/json
snmpSettings/versionThreeSettings/enableGets
snmpSettings/versionThreeSettings/userName String Name of the SNMPv3 user.
snmpSettings/versionThreeSettings/authenticationPassword String The password used to generate the key for authentication.
snmpSettings/versionThreeSettings/privacyPassword String The password used to generate the key for encryption.
snmpSettings/versionThreeSettings/authenticationProtocol enum
snmpSettings/versionThreeSettings/privacyProtocol enum
snmpSettings/versionThreeSettings/engineId String The Engine ID is only used by SNMPv3 entities to uniquely identify them.
snmpSettings/getEnabled boolean A true or false value indicating whether to allow SNMP managers to query
server-operatng parameters enlisted in IF-MIB, MIB-|| and Host Resources
MIB or not. If set to false it blocks queries related to all MIBs.
snmpSettings/trapEnabled boolean A true or false value indicating whether to allow SNMP traps to be sent
to configured SNMP server.
snmpMib application/json
snmpMib/snmpMibII application/json
snmpMib/snmpMibII/systemName String
snmpMib/snmpMibII/systemContact String
snmpMib/snmpMibII/systemLocation String
snmpMib/hostResourcesMibEnabled boolean
snmpMib/interfaceMibEnabled boolean
snmpMib/vendorEnabled boolean A true or false value indicating whether to enable the external SNMP
Trap receivers to receive traps or not.
snmpMib/mibIIEnabled boolean
snmpServerlist
snmpServerlist/enableTraps boolean A true or false value indicating whether the SNMP server is enabled
to receive SNMP traps or not.
snmpServerlist/trapPort int Specifies the port number on the receiving system to which the SNMP
trap is sent.
snmpServerlist/protocolVersion enum Specifies the SNMP protocol version for the SNMP agent.
snmpServerlist/userName String SNMP version three user name.
snmpServerlist/authenticationPassword String SNMP version three authentication password.
snmpServerlist/privacyPassword String SNMP version three privacy password.
snmpServerlist/authenticationType enum SNMP version three authentication protocol.
snmpServerlist/privacyProtocol enum SNMP version three privacy protocol.
snmpServerlist/destIpAddress

Copy Sample JSON
Sample JSON 
Response body:
{
    "policyCreatedAtLocId": {
        "type": "locallocationid",
        "id": 0
    },
    "policyType": "SNMP_POLICY",
    "snmpIntegrationEnabled": true,
    "snmpSettings": {
        "versionOneTwoSettings": {
            "enableGets": false,
            "communityString": "public"
        },
        "versionThreeSettings": {
            "enableGets": false,
            "userName": "admin",
            "authenticationPassword": "password",
            "privacyPassword": "password",
            "authenticationProtocol": "MD5",
            "privacyProtocol": "DES",
            "engineId": "0x80001F8804776966692D73656375726974792D736572766572"
        },
        "getEnabled": false,
        "trapEnabled": false
    },
    "snmpMib": {
        "snmpMibII": {
            "systemName": "Wifi Security Server",
            "systemContact": "",
            "systemLocation": ""
        },
        "hostResourcesMibEnabled": true,
        "interfaceMibEnabled": true,
        "vendorEnabled": true,
        "mibIIEnabled": true
    },
    "snmpServerlist": [
        {
            "enableTraps": true,
            "trapPort": 162,
            "protocolVersion": "V3",
            "userName": "admin",
            "authenticationPassword": "password",
            "privacyPassword": "password",
            "authenticationType": "MD5",
            "privacyProtocol": "DES",
            "destIpAddress": "10.1.1.1"
        }
    ]
}
API Calls
Get

/V5/configuration/global/snmp

Put

/V5/configuration/global/snmp

Get SNMP Configuration Details

Description The API is used to retrieve the configured SNMP settings.
Syntax
GET <BASE_URL>/V5/configuration/global/snmp?isdefault=<value>&nodeid=<value>

Here,

  • isDefault

    When we pass this parameter as true then system default configuration for that location is return else whatever user has defined is returned. It takes a boolean value. The default value is false.

  • nodeid

    A system-generated unique ID for the child server in a cluster environment. The value for this parameter will be same as that of the childId attribute in the Location JSON. It takes an integer value.
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/configuration/global/snmp?isdefault=true&nodeid=0
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the details of the SNMP configuration. The response is in the application/json format.

Save SNMP  Configuration Details

Description The API is used to save or update SNMP configurations.
Syntax
PUT  <Base_URL>/V5/configuration/global/snmp?nodeid=0

Here,

  • nodeid

    A system-generated unique ID for the child server in a cluster environment. The value for this parameter will be same as that of the childId attribute in the Location JSON. It takes an integer value.
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/configuration/global/snmp?nodeid=0
Request Body This API call requires the details of the SNMP configurations to be updated, which is passed as parameters in the request body. The parameters are passed in the application/json format.

A sample request body is as follows:

{
	"policyCreatedAtLocId": {
		"type": "locallocationid",
		"id": 0
	},
	"policyType": "SNMP_POLICY",
	"snmpIntegrationEnabled": true,
	"snmpSettings": {
		"versionOneTwoSettings": {
			"enableGets": true,
			"communityString": "public"
		},
		"versionThreeSettings": {
			"enableGets": true,
			"userName": "admin",
			"authenticationPassword": "password",
			"privacyPassword": "password",
			"authenticationProtocol": "MD5",
			"privacyProtocol": "DES",
			"engineId": "0x80001F8804776966692D73656375726974792D736572766572"
		},
		"getEnabled": true,
		"trapEnabled": true
	},
	"snmpMib": {
		"snmpMibII": {
			"systemName": "Wifi Security Server",
			"systemContact": "",
			"systemLocation": ""
		},
		"hostResourcesMibEnabled": true,
		"interfaceMibEnabled": true,
		"vendorEnabled": true,
		"mibIIEnabled": true
	},
	"snmpServerlist": []
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the details of the updated SNMP configuration. The response is in the application/json format.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Post APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Delete APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.