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

Replace alias by name

put
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/aliases/

List of Aliases.

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

The name of the Alias.

Query Params
string

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

string

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

string

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

Body Params

aliasbody object

default-value
object

Default value for alias.

string
length between 1 and 256

Description of the Alias.

string
length between 1 and 256

The name of the Alias.

string
enum

Alias type.

Show Details
ALIAS_ADMIN_DNAlias for DN, DN for the admin user who has read or search privileges across all of the entries in the LDAP database.
ALIAS_ADMIN_PASSWORDAlias for the admin user Password.
ALIAS_ALLOW_NEW_APSAllows the new access points to join the AP cluster.
ALIAS_AP_ANTENNA_POLAP antenna polarization value.
ALIAS_AP_CHANNEL_2DOT4GHZAP static channel for 2.4GHz radio.
ALIAS_AP_CHANNEL_2ND_5GHZAP static channel for secondary 5GHz radio.
ALIAS_AP_CHANNEL_2ND_6GHZAP static channel for secondary 6GHz radio.
ALIAS_AP_CHANNEL_5GHZAP static channel for 5GHz radio.
ALIAS_AP_CHANNEL_6GHZAP static channel for 6GHz radio.
ALIAS_AP_EFFECTIVE_GAINAP effective antenna gain (dBi).
ALIAS_AP_HEIGHTAlias for AP height in GPS (meters).
ALIAS_AP_INSTALLATION_TYPEAP installation type (indoor or outdoor).
ALIAS_AP_PORT_PROFILE_SWITCHPORTAlias for ap-port-profile switchport.
ALIAS_AP_POWERAP static transmit power (dBm).
ALIAS_AP_RF_ZONEAP RF zone name.
ALIAS_AP_ZONENAMEAP zone name.
ALIAS_AUTH_SERVER_ADDRESSAuthentication server address (IP or FQDN).
ALIAS_BASE_DNAlias for DN name of the node which contains the entire user database to use.
ALIAS_CONDUCTORAlias for conductor.
ALIAS_DNS_RESOLVERList of IPv4 & IPv6 DNS servers used for name resolution.
ALIAS_DOMAIN_NAMEDomain name for AP uplink.
ALIAS_EAP_IDENTITYAP 1X Username.
ALIAS_EAP_IDENTITY_PASSWORDAP 1X Password.
ALIAS_ECHO_SOURCE_ADDRESSEcho source address alias.
ALIAS_ESSIDESSID.
ALIAS_ETH0_MODEAlias for eth0 mode.
ALIAS_ETH1_MODEAlias for eth1 mode.
ALIAS_FEATURE_CONTROLAlias to Enable or Disable feature
ALIAS_GW_PORT_PROFILE_SWITCHPORTalias for gw-port-profile switchport
ALIAS_HOSTHost address.
ALIAS_IDENTITY_PROFILEalias for identity-profile enable
ALIAS_IOT_RADIO_ZONEAlias for IoT radio zone names.
ALIAS_IOT_ZONEAlias for IoT zone names in per-ap-settings.
ALIAS_IPV4_ADDRESSIPv4 Address in format X.X.X.X.
ALIAS_IPV4_ADDRESSESlist of IPv4 addresses
ALIAS_IPV4_ADDRESSES_WITH_VRFIPv4 Addresses in format X.X.X.X with VRF
ALIAS_IPV4_ADDRESS_TYPEIPv4 address, static or dynamic.
ALIAS_IPV4_INTERFACE_VLANIPv4 interface VLAN identifier.
ALIAS_IPV4_PREFIXIPv4 Prefix in format X.X.X.X/M.
ALIAS_IPV4_SYSTEM_VLANIPv4 system VLAN identifier.
ALIAS_IPV6_ADDRESSIPv6 Address in format X:X::X:X.
ALIAS_IPV6_ADDRESSESIPv6 Address leaf list in format X:X::X:X
ALIAS_IPV6_ADDRESS_TYPEIPv6 address, static or dynamic.
ALIAS_IPV6_LINK_LOCAL_ADDRESSIPv6 link local address.
ALIAS_IPV6_PREFIXIPv6 Prefix in format X:X::X:X/M.
ALIAS_IPV6_SYSTEM_VLANIPv6 system VLAN configuration with address.
ALIAS_IP_ADDRESSIPv4 or IPv6 Address.
ALIAS_LACP_MODEAlias for lacp mode.
ALIAS_LOCATIONAP location.
ALIAS_MPSK_LOCAL_PASSPHRASEAlias for MPSK LOCAL passphrase.
ALIAS_NAMED_CONDITIONNamed-Condition for Policy.
ALIAS_NETWORKNetwork prefix.
ALIAS_NETWORK_DESTINATIONNetwork Destination/Net-Group
ALIAS_NETWORK_GROUPNetwork IP prefix group.
ALIAS_NEXT_HOPalias for ipv4 next-hop
ALIAS_NEXT_HOP_V6alias for ipv6 next-hop
ALIAS_NTP_AUTH_GLOBALNTP authentication enable/disable configuration.
ALIAS_NTP_AUTH_LISTNTP authentication list configuration.
ALIAS_NTP_SERVER_LISTNTP server list configuration.
ALIAS_RADIUS_SERVER_MODEAlias for specifying the mode in which the RADIUS server is used.
ALIAS_RSSI_REPORT_TYPEReport wireless client RSSI values for associated and/or unassociated clients..
ALIAS_SECRET_VALUEAuth server secret value configuration.
ALIAS_SERVICE_GROUPService group.
ALIAS_SWARM_MODEAlias for swarm mode.
ALIAS_SW_PORT_PROFILE_SWITCHPORTalias for switchport
ALIAS_TRANSPORT_IOT_ZONEAlias for IoT transport profile zone names.
ALIAS_USB_PORTAlias for usb port.
ALIAS_USB_POWER_OVERRIDEAlias for usb power override.
ALIAS_VC_COUNTRY_CODECountry code for the virtual controller.
ALIAS_VC_DNSIPDnsip for the virtual controller.
ALIAS_VC_IPIP address for the virtual controller.
ALIAS_VC_IPV6IPv6 address for the virtual controller.
ALIAS_VC_NAMEName for the virtual controller.
ALIAS_VC_VLANVlan for the virtual controller.
ALIAS_VLANVLAN Alias
ALIAS_VLAN_ACTIVE_GATEWAYAlias for interface vlan active gateway
ALIAS_VLAN_DESCRIPTIONDescription of the VLAN profile.
ALIAS_VLAN_VOICE_ENABLEAlias to set Vlan type to voice
ALIAS_VRRP_PRIORITYRouter priority level.
ALIAS_WPA_PASSPHRASEalias for wpa-passphrase
Responses

Updated 8 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 8 days ago