API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Update existing gateway system profile configurations

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/gw-system/

A Gateway System profile instance encapsulates all device-level operational settings for a gateway.
Each profile is uniquely identified by the profile name.
Use these APIs to create, modify, or delete a Gateway System profile.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

System profile name.

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

profilebody object

aaa-timers
object

Configures timeout intervals for AAA (Authentication, Authorization, and Accounting) operations including server failure detection, user idle sessions, logon attempts, and RADIUS accounting updates.

string
length between 1 and 255

Device contact information, often an email.

boolean

Disables the gateway's automatic DNS redirection for captive portal detection. When enabled, the gateway will not intercept DNS queries from unauthenticated clients to force captive portal discovery. Mutually exclusive with cpdns-ip.

length ≤ 9999

Specifies a custom IP address returned in DNS responses to unauthenticated clients, forcing redirection to the captive portal. This overrides the default behavior of returning the gateway's own IP address. Mutually exclusive with cpdns-disable. Corresponds to the ip cp-redirect-address CLI command.

boolean
Defaults to true

Minimizes idle CPU spinning. It is applicable only on x86 based platforms.
Not supported on Gateway models: 7005, 7008, 7010, 7024, 7030, 7205, 7210, 7220, 7240, 7240XM, 7280.

string
length between 1 and 256

System profile description.

int32
1 to 1440
Defaults to 1

Interval for re-resolving DNS hostnames configured in RADIUS and authentication server profiles. This ensures the gateway maintains current IP addresses for servers specified by FQDN rather than static IP.

firewall
object

Defines device-wide firewall behaviors that apply to all traffic regardless of user role or VLAN. These settings control inter-user traffic isolation, jumbo frame support, and VoIP QoS trust models.

boolean
Defaults to false

Enable the GPS function on the Aruba modem.
Available only on Gateway models with integrated cellular modems: 7005, 7008, 7010, 7024, 7030, 9004LTE, 9004, 9012, 9114, 9106.
Not supported on: 7205, 7280, 7210, 7220, 7240, 7240XM, 9240, VGW.

ipv4-configuration
object

System IPv4 configurations, allows you to set either
the loopback interface or a specific VLAN interface
address. If the system IPv4 is not configured, then
the first configured VLAN interface address is selected
by the device.

boolean

Enables IPv6 certification test mode for compliance validation. This mode adjusts protocol timers and behaviors to match IPv6 conformance test requirements (e.g., IPv6 Ready Logo testing). Should only be enabled in test environments.

ipv6-configuration
object

System IPv6 configurations, allows you to set either
the loopback interface or a specific VLAN interface
address. If the system IPv6 is not configured, then
the first configured VLAN interface address is selected
by the device.

string
length between 1 and 256

Alias for IPv6 device VLAN and address configuration, only applicable when device interface type is VLAN.
It cannot co-exist with direct device-vlan and device-address.

boolean

Master enable for IPv6 protocol support on the gateway. When disabled, the device will drop all IPv6 packets and will not participate in IPv6 routing or forwarding.

ipv6-proxy-ra
object

Configures the gateway to act as an IPv6 router advertisement proxy, forwarding RA messages between network segments. This allows IPv6 clients on downstream VLANs to receive router advertisements from upstream routers without direct Layer 2 connectivity.

string
enum

Enable IPv6 transition-mode.
Supported modes: NAT64.

Show Details
NAT64Network Address Translation from IPv6 to IPv4 (NAT64) as defined in RFC 6146. Enables IPv6-only clients to access IPv4-only services through stateful address translation.
Allowed:
lcd
object

Controls visibility of maintenance operations in the physical LCD menu panel on the front of the gateway.
Available only on Gateway models with LCD displays: 7010, 7030, 7024, 7205, 7210, 7220, 7240, 7240XM, 7280, 9240.
Restricting menu options prevents unauthorized physical access to factory reset, system halt, and image upgrade functions.

string
length between 1 and 255

Free-form text describing the physical location of the device. This value is exposed via SNMP sysLocation OID (1.3.6.1.2.1.1.6). Maximum length is platform-dependent.

logging
object

Controls local log message verbosity by module type, process, and severity level. This affects what diagnostic information is captured in the device's internal log buffers and forwarded to external syslog servers.

int32
0 to 255

References an existing Loopback Interface profile by ID. Used in conjunction with ipv4-configuration and ipv6-configuration to specify the system controller-ip address source.

string
length between 1 and 256

System profile name.

radius
object

Configures the gateway's behavior as a RADIUS client including the NAS-IP-Address sent in RADIUS packets, the source interface for RADIUS communication, and the UDP port for receiving RFC 3576 (Dynamic Authorization) messages from RADIUS servers.

tacacs
object

Configures the gateway's behavior as a TACACS+ client, specifically controlling the source interface used for TACACS+ authentication and authorization requests to TACACS+ servers.

timezone
object

Configures the device's timezone offset from UTC for accurate timestamp representation in logs, SNMP traps, and the LCD display. The combined hour and minute offsets determine the local time zone.

boolean
Defaults to false

Prevents Layer 2 forwarding loops that can occur when traffic is encapsulated between multiple tunnels terminating on the same gateway. When enabled, the gateway tracks tunnel packet origins and drops packets that would create circular forwarding paths between GRE, IPsec, or L2TPv3 tunnels.

string
length between 1 and 144

Security policy applied to VPNC Overlay traffic.

Responses

Updated 11 days ago

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

Updated 11 days ago