Update existing switch port profile configurations

patch

https://de1.api.central.arubanetworks.com/network-config/v1alpha1/sw-port-profiles/{profile-name}

List of port profiles.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profile-name

string

required

length ≤ 9999

Name of the port profile.

Query Params

object-type

string

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

scope-id

string

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

Body Params

profilebody object

dhcpv4-snooping

object

Port-specific DHCPv4-Snooping parameters. This configuration is valid only on a layer2 interface.

dhcpv6-snooping

object

Port-specific DHCPv6-Snooping parameters. This configuration is valid only on a layer2 interface.

ip-source-lockdown

object

IP source lockdown interface. This configuration is valid only on a layer2 interface.

dynamic-arp-inspection

object

Configuration of Dynamic ARP Inspection on interface.
This configuration is valid only on a layer2 interface.

client-limit-max

int32

1 to 4096

Defaults to 128

Configure the maximum number of clients tracked on this port. It is applicable to AOS-CX switch.
This configuration is valid only on a layer2 interface.

connect-to-network-device

boolean

Defaults to false

Marks a port as being connected with a network device. It is applicable to AOS-S switch.
This configuration is valid only on a layer2 interface.

mode

string

enum

Specifies client IP tracking mode on the port of AOS-CX switch.
This configuration is valid only on a layer2 interface.

Show Details

AUTO	Default mode. Track limited set of clients based on LLDP/CDP signature and access/trunk configuration.
DISABLE	Client IP addresses are not tracked on this port.
ENABLE	Track all client IP addresses on this port.

Allowed:

update-interval

int32

60 to 28000

Defaults to 1800

Configure the IP address update interval in seconds. It is applicable to AOS-CX switch.
This configuration is valid only on a layer2 interface.

dpi-enable

boolean

Defaults to false

Enable deep packet inspection (DPI) on an interface level.

enable

boolean

Enable the interface.

energy-efficient

boolean

Defaults to false

Enable auto-negotiation of Energy-Efficient Ethernet (EEE). Supported primarily on 1000BASE-T ports
for 4100i, 5420, 6000, 6100, 6200, 6300 and 6400 platforms.

error-control

string

enum

Defaults to AUTO_FEC

Forward Error Correction (FEC). Add redundant bits to a data stream
enabling the receiver to detect and correct transmission errors.

Show Details

AUTO_FEC	Use the transceiver default.
BASE_R_FEC	Use IEEE BASE-R (Firecode) FEC.
NO_FEC	Do not use any FEC.
RS_FEC	Use IEEE Reed-Solomon FEC.

Allowed:

fault-monitor-profile

string

length between 1 and 64

Fault monitoring profile to be applied.

link-clock-narrow-tolerance

boolean

Defaults to false

Narrow clock tolerance for a port in 100 Mb/sec mode. Note that this feature only applies to Smart Rate ports
and only when linked at 100Mbps. It has no effect at other speeds or on other ports. Supported primarily on
Smartrate ports for 6200 and 6300 platforms

mac-notify-traps

array of strings

length ≤ 2147483647

Show Details

AGED	On the enabled port a MAC is aged out.
LEARNED	On this port a MAC learn occurs.
MOVED	On the enabled port a MAC is moved.
REMOVED	On the enabled port a MAC is removed.

mac-notify-traps

macsec-policy

string

length between 1 and 128

MACsec policy to use on the interface.

mka-policy

string

length between 1 and 128

MKA policy to use on the interface.

mtu

int64

46 to 9198

Defaults to 1500

Maximum Transmission Unit (MTU) of the interface in bytes. The MTU defines the largest packet size
that can be transmitted over the interface without fragmentation.

mvrp

object

MVRP Interface grouping.

pvlan-port-mode

string

enum

Port modes of private VLAN. Cannot configure PVLAN port mode on routed port.
A port with PVLAN port mode secondary/promiscuous cannot trunk all vlans.

Show Details

ISL	Extends the PVLAN domain across multiple switches.
PROMISCUOUS	Configure the port to be a member of the primary VLAN.
SECONDARY	Set the port as a member of a secondary VLAN.

Allowed:

routing

boolean

Enable routing on the interface to make it layer-3 capable.

speed-downshift-enable

boolean

Defaults to false

Enable speed downshift for 1000BASE-T port. This is a non-standard mode for use only when standards-based
auto-negotiation is not able to establish a stable link. Enabling this may cause the port to link at a
lower than expected speed and should not be used on ports that are members of a LAG.

speed-duplex

string

enum

Set ethernet speed and duplex based on port type and inserted transceiver.

Show Details

AUTO	Auto Negotiation for speed and duplex mode.
AUTO_100GB	100 Gb/sec and auto-negotiate link parameters.
AUTO_100MB	100 Mb/sec and auto-negotiate link parameters.
AUTO_10GB	10 Gb/sec and auto-negotiate link parameters.
AUTO_10MB	10 Mb/sec and auto-negotiate link parameters.
AUTO_10MB_100MB	10 Mb/sec or 100 Mb/sec and auto-negotiate link parameters.
AUTO_1GB	1 Gb/sec and auto-negotiate link parameters.
AUTO_1GB_2500MB	1 Gb/sec or 2500 Mb/sec and auto-negotiate link parameters.
AUTO_1GB_2500MB_5GB	1 Gb/sec or 2500 Mb/sec or 5 Gb/sec and auto-negotiate link parameters.
AUTO_200GB	200 Gb/sec and auto-negotiate link parameters.
AUTO_2500MB	2500 Mb/sec and auto-negotiate link parameters.
AUTO_2500MB_5GB	2500 Mb/sec or 5 Gb/sec and auto-negotiate link parameters.
AUTO_25GB	25 Gb/sec and auto-negotiate link parameters.
AUTO_400GB	400 Gb/sec and auto-negotiate link parameters.
AUTO_40GB	40 Gb/sec and auto-negotiate link parameters.
AUTO_50GB	50 Gb/sec and auto-negotiate link parameters.
AUTO_5GB	5 Gb/sec and auto-negotiate link parameters.
FULL_100GB	100 Gbps, full duplex.
FULL_100MB	100 Mbps, full duplex.
FULL_10GB	10 Gbps, full duplex.
FULL_10MB	10 Mbps, full duplex.
FULL_1GB	1 Gbps, full duplex.
FULL_200GB	200 Gbps, full duplex.
FULL_25GB	25 Gbps, full duplex.
FULL_400GB	400 Gbps, full duplex.
FULL_40GB	40 Gbps, full duplex.
FULL_50GB	50 Gbps, full duplex.
HALF_100MB	100 Mbps, half duplex.
HALF_10MB	10 Mbps, half duplex.

speed-override

boolean

Defaults to false

Override default transceiver speed or auto-negotiation.

trusted-vlans

array of strings

length ≤ 2147483647

trusted-vlans

unknown-vlans

string

enum

Configure GVRP unknown VLANs handling mode for ethernet interface.
Learn: Accept join requests for new VLANs and propagate through GVRP.
Block: Process GVRP packets for known VLANs only, ignore new VLANs.
Disable: Ignore all GVRP packets.

Show Details

BLOCK	Only process GVRP packets that concern themselves with known VLANs and ignore new VLANs.
DISABLE	Ignore all GVRP packets.
LEARN	Accept join requests for new VLANs on this port and propagate requests through all other forwarding ports that are participating in GVRP.

Allowed:

vrf-forwarding

string

length ≤ 9999

Add the interface to the VRF instance uniquely identified by its name.
This configuration is valid only on a layer3 interface.

vrrp

object

IPv4 and IPv6 Virtual Router Redundancy Protocol (VRRP) configurations when routing is enabled.

cable-length

1 to 100000

Specifies the cable-length auto-detection mode or the value
in meters used to compute the headroom limit for lossless traffic
arriving on the interface. The default value is 350 meters.

flow-control-mode

string

enum

Flow-control mode for the interface: Link Level Flow Control (LLFC),
Priority Flow Control (PFC), or none. On some platforms, memory pools
must first be configured (using the aruba-qos-pool yang model) before
any interface flow-control configuration will take effect.

Show Details

LINK_LEVEL_FLOW_CONTROL	802.3x link-level flow control.
NONE	Disable flow control.
PRIORITY_FLOW_CONTROL	802.1Qbb priority-based flow control.

Allowed:

llfc-flow-control

object

Configuration for 802.3x link-level flow control (LLFC). On some
platforms, a memory pool must first be created (using the
aruba-qos-pool yang model) that matches the llfc-pool-id value before
any 802.3X link-level Tx or RxTx flow-control configuration will
take effect.

lossless-buffer-based-link-level-flow-control

object

Common QoS buffer configurations.

lossless-buffer-based-priority-flow-control

object

Buffer threshold configuration for 802.1Qbb priority flow control,
including XOFF and XON limits, headroom, and other parameters.

pfc-watchdog

boolean

Defaults to false

Enables the priority flow control watchdog. The watchdog detects when
flow-controlled egress queues are paused for an excessive duration, and
takes action when the globally-configured trigger time has elapsed with
the queue remaining paused.

priority-flow-control

object

Configuration for 802.1Qbb priority flow control.

excessive-broadcasts

object

Grouping threshold related leaves as single group.

excessive-multicasts

object

Grouping threshold related leaves as single group.

link-flap

object

fault-monitor-action config

policy

object

Grouping for access-list configurations.

policy-vlan-config

object

Container for Policy vlan references.

switchport

object

Switchport configuration. This configuration is valid only on a layer2 interface.

vlan-translate

array of objects

length ≤ 2147483647

VLAN translations.

vlan-translate

object

IP configuration. This configuration is valid only on a layer3 interface.

ipv4

object

IPv4 configuration. This configuration is valid only on a layer3 interface.

ipv6

object

IPv6 configurations. This configuration is valid only on a layer3 interface.

lacp

object

LACP interface configuration.

mpls

boolean

Defaults to false

Enable Multiprotocol Label Switching (MPLS) on the interface.
This configuration is valid only on a layer3 interface.

mpls-ldp

boolean

Defaults to false

Enable Label Distribution Protocol (LDP) on the interface.
This configuration is valid only on a layer3 interface.

hello-holdtime

int32

15 to 65535

Defines the time for which a neighbor adjacency will
be kept by the router while it waits for a new link
Hello message. This configuration is valid only on a layer3 interface.

session-holdtime

int32

15 to 65535

Defines the interval for holding the session on
each link LDP adjacency. This configuration is valid only on a layer3 interface.

cdp

object

CDP configuration.

ip-directed-broadcast-enable

boolean

Defaults to false

Enable IP Directed Broadcast on the interface. This configuration is valid only on a layer3 interface.

sflow

object

sFlow configuration.

qinq

object

QinQ interface level configuration.This feature
is not supported.

vsx

object

VSX configuration.

qos

object

Rate-limit a specific traffic-type on this port.

igmp

object

Grouping for common MGMD Configurations on interface

mld

object

Grouping for common MGMD Configurations on interface

ipfix-flow-monitor-in

object

Configuration to apply flow monitor(s) to an interface. The flow monitors will monitor traffic in the ingress direction

igmp-snooping-eth

object

MGMD Snooping Common Configurations

mld-snooping-eth

object

MGMD Snooping Common Configurations

loop-protect

object

Top-level container for advanced loop protect configuration. This is split in two
grouping as CX and PVOS devices have some of these in global context.

stp

object

Interface level spanning-tree configuration. This configuration is valid only on a layer2 interface.

ipv4-relay

object

DHCPv4 Relay Configurations

boundary-acl

string

length between 1 and 144

Multicast Boundary ACL to filter all multicast data
and control packets

pim-dense

object

PIM-DM protocol common configuration.

pim-sparse

object

PIM-SM protocol common configuration.

pim6-dense

object

PIM-DM protocol common configuration.

pim6-sparse

object

PIM-SM protocol common configuration.

pim-bidir

object

PIM-Bidir protocol.

aaa-profile

string

length between 1 and 256

Name of the profile containing AAA configurations.

description

string

length between 1 and 128

Description for the port profile.

dfp-profile

string

length between 1 and 128

Name of the profile containing Device Fingerprinting configurations.

forbid-vlans

array of int32s

length ≤ 2147483647

forbid-vlans

ip-source-lockdown-profile

string

length between 1 and 256

Deprecated. Use inline field: ip-source-lockdown. Not visible/editable in UI if set using this external referenced profile.

isolated-vlans

array of int32s

length ≤ 2147483647

isolated-vlans

lag

object

PTP interface configuration parameters.

lldp

object

LLDP configuration.

nd-snooping-profile

string

length between 1 and 256

Name of the profile containing ND snooping configurations.

poe

object

Configure PoE parameters

port-security-policy

string

length between 1 and 128

Name of the policy containing port-security configurations.

profile-name

string

length between 1 and 64

Name of the port profile.

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