networking_switch_port_settings_create

Create switch port settings
post/v1/system/networking/switch-port-settings

Request Body

Parameters for creating switch port settings. Switch port settings are the central data structure for setting up external networking. Switch port settings include link, interface, route, address and dynamic network protocol configuration.

Object
addresses

Addresses indexed by interface name.

Key
String
Value
object
Object
addresses

The set of addresses assigned to the port configuration.

An address tied to an address lot.

Object
address

The address and prefix length of this address.

address_lot

The address lot this address is drawn from.

vlan_id

Optional VLAN ID for this address

bgp_peers

BGP peers indexed by interface name.

Key
String
Value
object
Object
peers

A BGP peer configuration for an interface. Includes the set of announcements that will be advertised to the peer identified by addr. The bgp_config parameter is a reference to global BGP parameters. The interface_name indicates what interface the peer should be contacted on.

Object
addr

The address of the host to peer with.

allowed_export

Define export policy for a peer.

Define policy relating to the import and export of prefixes from a BGP peer.

allowed_import

Define import policy for a peer.

Define policy relating to the import and export of prefixes from a BGP peer.

bgp_config

The global BGP configuration used for establishing a session with this peer.

communities

Include the provided communities in updates sent to the peer.

connect_retry

How long to to wait between TCP connection retries (seconds).

delay_open

How long to delay sending an open request after establishing a TCP session (seconds).

enforce_first_as

Enforce that the first AS in paths received from this peer is the peer's AS.

hold_time

How long to hold peer connections between keepalives (seconds).

idle_hold_time

How long to hold a peer in idle before attempting a new session (seconds).

interface_name

The name of interface to peer on. This is relative to the port configuration this BGP peer configuration is a part of. For example this value could be phy0 to refer to a primary physical interface. Or it could be vlan47 to refer to a VLAN interface.

keepalive

How often to send keepalive requests (seconds).

local_pref

Apply a local preference to routes received from this peer.

md5_auth_key

Use the given key for TCP-MD5 authentication with the peer.

min_ttl

Require messages from a peer have a minimum IP time to live field.

multi_exit_discriminator

Apply the provided multi-exit discriminator (MED) updates sent to the peer.

remote_asn

Require that a peer has a specified ASN.

vlan_id

Associate a VLAN ID with a peer.

description
groups

interfaces

Interfaces indexed by link name.

Key
String
Value
object
Object
kind

What kind of switch interface this configuration represents.

Indicates the kind for a switch interface.

v6_enabled

Whether or not IPv6 is enabled.

links

Links indexed by phy name. On ports that are not broken out, this is always phy0. On a 2x breakout the options are phy0 and phy1, on 4x phy0-phy3, etc.

Key
String
Value
object
Object
autoneg

Whether or not to set autonegotiation

fec

The forward error correction mode of the link.

The forward error correction mode of a link.

lldp

The link-layer discovery protocol (LLDP) configuration for the link.

The LLDP configuration associated with a port. LLDP may be either enabled or disabled, if enabled, an LLDP configuration must be provided by name or id.

Object
enabled

Whether or not LLDP is enabled.

lldp_config

A reference to the LLDP configuration used. Must not be None when enabled is true.

mtu

Maximum transmission unit for the link.

speed

The speed of the link.

The speed of a link.

name

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

port_config

Physical switch port configuration.

Object
geometry

Link geometry for the switch port.

The link geometry associated with a switch port.

routes

Routes indexed by interface name.

Key
String
Value
object
Object
routes

The set of routes assigned to a switch port.

A route to a destination network through a gateway address.

Object
dst

The route destination.

gw

The route gateway.

vid

VLAN id the gateway is reachable over.

Responses

Object
addresses

Layer 3 IP address settings.

An IP address configuration for a port settings object.

Object
address

The IP address and prefix.

address_lot_block_id

The id of the address lot block this address is drawn from.

interface_name

The interface name this address belongs to.

port_settings_id

The port settings object this address configuration belongs to.

vlan_id

An optional VLAN ID

bgp_peers

BGP peer settings.

A BGP peer configuration for an interface. Includes the set of announcements that will be advertised to the peer identified by addr. The bgp_config parameter is a reference to global BGP parameters. The interface_name indicates what interface the peer should be contacted on.

Object
addr

The address of the host to peer with.

allowed_export

Define export policy for a peer.

Define policy relating to the import and export of prefixes from a BGP peer.

allowed_import

Define import policy for a peer.

Define policy relating to the import and export of prefixes from a BGP peer.

bgp_config

The global BGP configuration used for establishing a session with this peer.

communities

Include the provided communities in updates sent to the peer.

connect_retry

How long to to wait between TCP connection retries (seconds).

delay_open

How long to delay sending an open request after establishing a TCP session (seconds).

enforce_first_as

Enforce that the first AS in paths received from this peer is the peer's AS.

hold_time

How long to hold peer connections between keepalives (seconds).

idle_hold_time

How long to hold a peer in idle before attempting a new session (seconds).

interface_name

The name of interface to peer on. This is relative to the port configuration this BGP peer configuration is a part of. For example this value could be phy0 to refer to a primary physical interface. Or it could be vlan47 to refer to a VLAN interface.

keepalive

How often to send keepalive requests (seconds).

local_pref

Apply a local preference to routes received from this peer.

md5_auth_key

Use the given key for TCP-MD5 authentication with the peer.

min_ttl

Require messages from a peer have a minimum IP time to live field.

multi_exit_discriminator

Apply the provided multi-exit discriminator (MED) updates sent to the peer.

remote_asn

Require that a peer has a specified ASN.

vlan_id

Associate a VLAN ID with a peer.

groups

Switch port settings included from other switch port settings groups.

This structure maps a port settings object to a port settings groups. Port settings objects may inherit settings from groups. This mapping defines the relationship between settings objects and the groups they reference.

Object
port_settings_group_id

The id of a port settings group being referenced by a port settings object.

port_settings_id

The id of a port settings object referencing a port settings group.

interfaces

Layer 3 interface settings.

A switch port interface configuration for a port settings object.

Object
id

A unique identifier for this switch interface.

interface_name

The name of this switch interface.

kind

The switch interface kind.

Describes the kind of an switch interface.

port_settings_id

The port settings object this switch interface configuration belongs to.

v6_enabled

Whether or not IPv6 is enabled on this interface.

link_lldp

Link-layer discovery protocol (LLDP) settings.

A link layer discovery protocol (LLDP) service configuration.

Object
enabled

Whether or not the LLDP service is enabled.

id

The id of this LLDP service instance.

lldp_config_id

The link-layer discovery protocol configuration for this service.

links

Layer 2 link settings.

A link configuration for a port settings object.

Object
autoneg

Whether or not the link has autonegotiation enabled.

fec

The forward error correction mode of the link.

The forward error correction mode of a link.

link_name

The name of this link.

lldp_service_config_id

The link-layer discovery protocol service configuration id for this link.

mtu

The maximum transmission unit for this link.

port_settings_id

The port settings this link configuration belongs to.

speed

The configured speed of the link.

The speed of a link.

port

Layer 1 physical port settings.

A physical port configuration for a port settings object.

Object
geometry

The physical link geometry of the port.

The link geometry associated with a switch port.

port_settings_id

The id of the port settings object this configuration belongs to.

routes

IP route settings.

A route configuration for a port settings object.

Object
dst

The route's destination network.

gw

The route's gateway address.

interface_name

The interface name this route configuration is assigned to.

port_settings_id

The port settings object this route configuration belongs to.

vlan_id

The VLAN identifier for the route. Use this if the gateway is reachable over an 802.1Q tagged L2 segment.

settings

The primary switch port settings handle.

A switch port settings identity whose id may be used to view additional details.

Object
description

human-readable free-form text about a resource

id

unique, immutable, system-controlled identifier for each resource

name

unique, mutable, user-controlled identifier for each resource

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

time_created

timestamp when this resource was created

time_modified

timestamp when this resource was last modified

vlan_interfaces

Vlan interface settings.

A switch port VLAN interface configuration for a port settings object.

Object
interface_config_id

The switch interface configuration this VLAN interface configuration belongs to.

vlan_id

The virtual network id for this interface that is used for producing and consuming 802.1Q Ethernet tags. This field has a maximum value of 4095 as 802.1Q tags are twelve bits.