networking
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.
Addresses indexed by interface name.
The set of addresses assigned to the port configuration.
An address tied to an address lot.
The address and prefix length of this address.
The address lot this address is drawn from.
Optional VLAN ID for this address
BGP peers indexed by interface name.
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.
The address of the host to peer with.
Define export policy for a peer.
Define policy relating to the import and export of prefixes from a BGP peer.
Define import policy for a peer.
Define policy relating to the import and export of prefixes from a BGP peer.
The global BGP configuration used for establishing a session with this peer.
Include the provided communities in updates sent to the peer.
How long to to wait between TCP connection retries (seconds).
How long to delay sending an open request after establishing a TCP session (seconds).
Enforce that the first AS in paths received from this peer is the peer's AS.
How long to hold peer connections between keepalives (seconds).
How long to hold a peer in idle before attempting a new session (seconds).
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.
How often to send keepalive requests (seconds).
Apply a local preference to routes received from this peer.
Use the given key for TCP-MD5 authentication with the peer.
Require messages from a peer have a minimum IP time to live field.
Apply the provided multi-exit discriminator (MED) updates sent to the peer.
Require that a peer has a specified ASN.
Associate a VLAN ID with a peer.
Interfaces indexed by link name.
What kind of switch interface this configuration represents.
Indicates the kind for a switch interface.
Whether or not IPv6 is enabled.
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.
Whether or not to set autonegotiation
The forward error correction mode of the link.
The forward error correction mode of a link.
The link-layer discovery protocol (LLDP) configuration for the link.
The LLDP configuration associated with a port.
The LLDP chassis identifier TLV.
Whether or not LLDP is enabled.
The LLDP link description TLV.
The LLDP link name TLV.
The LLDP management IP TLV.
The LLDP system description TLV.
The LLDP system name TLV.
Maximum transmission unit for the link.
The speed of the link.
The speed of a link.
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.
Physical switch port configuration.
Link geometry for the switch port.
The link geometry associated with a switch port.
Routes indexed by interface name.
The set of routes assigned to a switch port.
A route to a destination network through a gateway address.
The route destination.
The route gateway.
Local preference for route. Higher preference indictes precedence within and across protocols.
VLAN id the gateway is reachable over.
Responses
Layer 3 IP address settings.
An IP address configuration for a port settings object.
The IP address and prefix.
The id of the address lot block this address is drawn from.
The interface name this address belongs to.
The port settings object this address configuration belongs to.
An optional VLAN ID
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.
The address of the host to peer with.
Define export policy for a peer.
Define policy relating to the import and export of prefixes from a BGP peer.
Define import policy for a peer.
Define policy relating to the import and export of prefixes from a BGP peer.
The global BGP configuration used for establishing a session with this peer.
Include the provided communities in updates sent to the peer.
How long to to wait between TCP connection retries (seconds).
How long to delay sending an open request after establishing a TCP session (seconds).
Enforce that the first AS in paths received from this peer is the peer's AS.
How long to hold peer connections between keepalives (seconds).
How long to hold a peer in idle before attempting a new session (seconds).
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.
How often to send keepalive requests (seconds).
Apply a local preference to routes received from this peer.
Use the given key for TCP-MD5 authentication with the peer.
Require messages from a peer have a minimum IP time to live field.
Apply the provided multi-exit discriminator (MED) updates sent to the peer.
Require that a peer has a specified ASN.
Associate a VLAN ID with a peer.
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.
The id of a port settings group being referenced by a port settings object.
The id of a port settings object referencing a port settings group.
Layer 3 interface settings.
A switch port interface configuration for a port settings object.
A unique identifier for this switch interface.
The name of this switch interface.
The switch interface kind.
Describes the kind of an switch interface.
The port settings object this switch interface configuration belongs to.
Whether or not IPv6 is enabled on this interface.
Link-layer discovery protocol (LLDP) settings.
A link layer discovery protocol (LLDP) service configuration.
The LLDP chassis identifier TLV.
Whether or not the LLDP service is enabled.
The id of this LLDP service instance.
The LLDP link description TLV.
The LLDP link name TLV.
The LLDP management IP TLV.
The LLDP system description TLV.
The LLDP system name TLV.
Layer 2 link settings.
A link configuration for a port settings object.
Whether or not the link has autonegotiation enabled.
The forward error correction mode of the link.
The forward error correction mode of a link.
The name of this link.
The link-layer discovery protocol service configuration id for this link.
The maximum transmission unit for this link.
The port settings this link configuration belongs to.
The configured speed of the link.
The speed of a link.
Layer 1 physical port settings.
A physical port configuration for a port settings object.
The physical link geometry of the port.
The link geometry associated with a switch port.
The id of the port settings object this configuration belongs to.
IP route settings.
A route configuration for a port settings object.
The route's destination network.
The route's gateway address.
The interface name this route configuration is assigned to.
Local preference indicating priority within and across protocols.
The port settings object this route configuration belongs to.
The VLAN identifier for the route. Use this if the gateway is reachable over an 802.1Q tagged L2 segment.
The primary switch port settings handle.
A switch port settings identity whose id may be used to view additional details.
human-readable free-form text about a resource
unique, immutable, system-controlled identifier for each resource
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.
timestamp when this resource was created
timestamp when this resource was last modified
Vlan interface settings.
A switch port VLAN interface configuration for a port settings object.
The switch interface configuration this VLAN interface configuration belongs to.
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.