Create a new logging by unique name

post

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

Defines a single Logging profile, specifying parameters for log message handling, destinations,
and severity filtering. Each entity is identified by name. Use these APIs to create, modify,
or delete an instance.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

name

string

required

length ≤ 9999

Unique name for the Logging profile. Required to
reference this profile in device or system configurations.

Query Params

object-type

string

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

scope-id

string

Scope at which local object needs to be created. 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 created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

accounting-format-native

boolean

Defaults to false

Enable sending audit log messages to the syslog server in Linux format.
If it is not enabled, then it sends in ArubaOS-CX defined log format.

console

object

console-logging related configuration.

destination

string

enum

Debug log destination.

Show Details

BUFFER	Debug log destination buffer.
CONSOLE	Debug log destination console.
FILE	Debug log destination file.
SYSLOG	Debug log destination syslog.

Allowed:

event-trap

boolean

Defaults to true

This command enables/disables the notification of the events to be sent as traps.

facility

string

enum

Defaults to LOCAL7

Syslog facility to be used for remote syslog messages.

Show Details

AUTH	Facility AUTH
CRON	Facility CRON
DAEMON	Facility DAEMON
KERN	Facility KERN
LOCAL0	Facility LOG_LOCAL0
LOCAL1	Facility LOG_LOCAL1
LOCAL2	Facility LOG_LOCAL2
LOCAL3	Facility LOG_LOCAL3
LOCAL4	Facility LOG_LOCAL4
LOCAL5	Facility LOG_LOCAL5
LOCAL6	Facility LOG_LOCAL6
LOCAL7	Facility LOG_LOCAL7
LPR	Facility LPR
MAIL	Facility MAIL
NEWS	Facility NEWS
SYS10	Facility SYS10
SYS11	Facility SYS11
SYS12	Facility SYS12
SYS13	Facility SYS13
SYS14	Facility SYS14
SYS9	Facility SYS9
SYSLOG	Facility SYSLOG
USER	Facility USER
UUCP	Facility UUCP

local-file

object

Local file

notification-threshold

object

Threshold percentage relative to the size of the
log buffer. Once the utilization has reached this threshold, a
log notification will be generated.

severity

string

enum

Minimum severity for logging.
For AP devices, Range: EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFO, DEBUG.
For PVOS devices, Range: MAJOR, INFO, WARNING, DEBUG, ERROR.

Show Details

ALERT	Immediate action needed.
CRITICAL	Critical Condition
DEBUG	Debug Messages
EMERGENCY	System is unusable
ERROR	Error condition in the system
INFO	Informational Messages
MAJOR	Major condition
NOTICE	Normal bug significant condition
WARNING	Warning condition

module

array of objects

length ≤ 2147483647

List of module type, module and sub-module.

module

remote-syslog

array of objects

length ≤ 2147483647

Remote syslog details.

remote-syslog

filter

array of objects

length ≤ 2147483647

Filter name.

filter

command

boolean

Enable local command logging.

description

string

length between 1 and 256

Logging profile description.

name

string

length between 1 and 256

Unique name for the Logging profile. Required to
reference this profile in device or system configurations.

origin-id

string

enum

Origin Id for the syslog message.

Show Details

HOSTNAME	Hostname of the device as the origin-id.
IP_ADDRESS	IP address of the outgoing interface as the origin-id.
NONE	Disable origin-id in the Syslog message.

Allowed:

prefix

string

length between 1 and 48

Add a string to the message content. The string may contain upto 48 US ASCII printable characters except for space.

priority-description

string

length between 1 and 255

A text string associated with the values of facility, severity, and
system-module.

running-config-change

boolean

Notification about changes in running configuration will
be sent to the syslog server(s).

system-module

string

enum

Name of the system-module.

Show Details

ACCT	Event log for system-module acct
ACL	Event log for system-module acl
ACTIVATE	Event log for system-module activate
ADDRMGR	Event log for system-module addrmgr
ALL_PASS	Event log for system-module all-pass
AMP_SERVER	Event log for system-module amp-server
ARPT	Event log for system-module arpt
ARP_PROTECT	Event log for system-module arp-protect
AUTH	Event log for system-module auth
AUTHORDER	Event log for system-module authorder
AUTORUN	Event log for system-module autorun
BFD	Event log for system-module bfd
BGP	Event log for system-module bgp
BPDU	Event log for system-module bpdu
BRIDGE	Event log for system-module bridge
BYOD_REDIRECT	Event log for system-module byod-redirect
CADOWNLOAD	Event log for system-module cadownload
CAPTIVE_PORTAL	Event log for system-module captive-portal
CDP	Event log for system-module cdp
CENTRAL	Event log for system-module central
CFGRESTORE	Event log for system-module cfgrestore
CHASSIS	Event log for system-module chassis
CONNFILT	Event log for system-module connfilt
CONSOLE	Event log for system-module console
COS	Event log for system-module cos
CRYPTO	Event log for system-module crypto
DCA	Event log for system-module DCA
DCBX	Event log for system-module dcbx
DEV_ONBOARD	Event log for system-module dev-onboard
DFP	Event log for system-module dfp
DHCP	Event log for system-module dhcp
DHCPR	Event log for system-module dhcpr
DHCPV6C	Event log for system-module dhcpv6c
DHCPV6R	Event log for system-module dhcpv6r
DHCP_SERVER	Event log for system-module dhcp-server
DHCP_SNOOP	Event log for system-module dhcp-snoop
DIPLD	Event log for system-module dipld
DIPLDV6	Event log for system-module dipldv6
DLDP	Event log for system-module dldp
DMA	Event log for system-module dma
DOWNLOAD	Event log for system-module download
DSNOOPV6	Event log for system-module dsnoopv6
DT	Event log for system-module dt
ESATPROXY	Event log for system-module esatproxy
ESTC	Event log for system-module estc
FAULT	Event log for system-module fault
FFI	Event log for system-module FFI
FIPS	Event log for system-module fips
GARP	Event log for system-module garp
GVRP	Event log for system-module gvrp
HPECM	Event log for system-module hpecm
HPESP	Event log for system-module hpesp
HPESP_CM	Event log for system-module hpesp-cm
HPESP_IP	Event log for system-module hpesp-ip
HPSM	Event log for system-module hpsm
HTTP	Event log for system-module http
HTTPPROXY	Event log for system-module httpproxy
IDM	Event log for system-module idm
IEEE802_1X	Event log for system-module 802.1x
IGMP	Event log for system-module igmp
INST_MON	Event log for system-module inst-mon
INSYSPROG	Event log for system-module insysprog
IP	Event log for system-module ip
IPADDRMGR	Event log for system-module ipaddrmgr
IPLOCK	Event log for system-module iplock
IPSLA	Event log for system-module ipsla
IPX	Event log for system-module ipx
JOB	Event log for system-module job
KMS	Event log for system-module kms
LACP	Event log for system-module lacp
LDBAL	Event log for system-module ldbal
LICENSING	Event log for system-module licensing
LLDP	Event log for system-module lldp
LLDPMAD	Event log for system-module lldpmad
LOOP_PROTECT	Event log for system-module loop-protect
MACLOCK	Event log for system-module maclock
MACSEC	Event log for system-module macsec
MDNS	Event log for system-module mdns
MGR	Event log for system-module mgr
MLD	Event log for system-module mld
MOBILITY	Event log for system-module mobility
MSATPROXY	Event log for system-module msatproxy
MTM	Event log for system-module mtm
MVRP	Event log for system-module mvrp
NDSNOOP	Event log for system-module ndsnoop
NETINET	Event log for system-module netinet
NTP	Event log for system-module ntp
OOBM	Event log for system-module oobm
OPENFLOW	Event log for system-module openflow
OSPF	Event log for system-module ospf
OSPF3	Event log for system-module ospf3
PAGP	Event log for system-module pagp
PIM	Event log for system-module pim
POLICY	Event log for system-module policy
PORTS	Event log for system-module ports
PROFILE_MANAGER	Event log for system-module profile-manager
PSDETECT	Event log for system-module psdetect
QINQ	Event log for system-module Q-in-Q
RADIUS	Event log for system-module radius
RATELIM	Event log for system-module ratelim
RA_GUARD	Event log for system-module ra-guard
RFS	Event log for system-module rfs
RIP	Event log for system-module rip
RIPNG	Event log for system-module ripng
SECUREMODE	Event log for system-module securemode
SFLOW	Event log for system-module sflow
SFTP	Event log for system-module sftp
SI_TUNNEL	Event log for system-module si-tunnel
SLP	Event log for system-module slp
SMART_LINK	Event log for system-module smart-link
SNMP	Event log for system-module snmp
SNTP	Event log for system-module sntp
SRCIP	Event log for system-module srcip
SSH	Event log for system-module ssh
SSL	Event log for system-module ssl
STACK	Event log for system-module stack
STACKING	Event log for system-module stacking
STP	Event log for system-module stp
SYSTEM	Event log for system-module system
TACACS	Event log for system-module tacacs
TCP	Event log for system-module tcp
TELNET	Event log for system-module telnet
TESTMODE	Event log for system-module testmode
TFTP	Event log for system-module tftp
TIMEP	Event log for system-module timep
TLS	Event log for system-module tls
TRMODE	Event log for system-module trmode
TR_069	Event log for system-module tr-069
TUNNELED_NODE	Event log for system-module tunneled-node
UDLD	Event log for system-module udld
UDPF	Event log for system-module udpf
UFD	Event log for system-module ufd
UPDATE	Event log for system-module update
USB	Event log for system-module usb
USERTNODE	Event log for system-module usertnode
VLAN	Event log for system-module vlan
VLANMAD	Event log for system-module vlanmad
VRRP	Event log for system-module vrrp
VSF	Event log for system-module vsf
VXLAN_TUNNEL	Event log for system-module vxlan-tunnel
WEBMACAUTH	Event log for system-module webmacauth
WSM	Event log for system-module wsm
XMODEM	Event log for system-module xmodem
XRRP	Event log for system-module xrrp
ZTPIPSEC	Event log for system-module ztpipsec

transmission-interval

int64

0 to 4294967295

Egress rate limit for sending notifications.

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