API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Update existing configuration for Aruba System Information

System information provides key details about the Aruba device, including hardware model,
software version, serial number, and operational status. This information is essential for
inventory management, support, and troubleshooting. Use this API to retrieve system information
for Aruba devices.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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

string

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

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

system-infobody object

string
length between 1 and 128

The hostname assigned to the device for identification in network management systems and CLI prompts. Must be unique per device. All device types support alphanumeric characters (0-9, a-z, A-Z) and dash (-). For CX switches, maximum length is 32 characters; other device types support up to 128 characters with no additional restrictions for APs. Cannot be configured when hostname-alias is set.

string
length between 1 and 256

References an existing alias named 'sys_host_name' from the Aruba Alias module for device-specific hostname assignment. This parameter allows variable substitution across devices when the hostname parameter is not directly configured. Valid only when hostname is not set.

string
length between 6 and 38

The SNMPv3 engine identifier uniquely identifying this device to SNMP management systems. Must be unique across all communicating SNMPv3 devices in the network to prevent authentication conflicts. For CX switches, must be in colon-separated hexadecimal notation with 8-38 characters total. For Gateway devices, must be 10-24 hexadecimal digits without separators. Supported on Gateway, CX, and PVOS devices.

string
length between 6 and 38

User-defined SNMPv3 engine identifier for the system. Must be unique across all communicating SNMPv3 devices. Supported on PVOS switches only.

string
length between 1 and 64

A descriptive text about the device and/or device collection for display in SNMP system information. Used by network management tools for device categorization and identification. Supported on CX switches only. Corresponds to the 'snmp-server system-description' CLI command.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json