Update a logical router

PUT /logical-routers/:id

Update an existing logical router.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

application/json

Body

oneOf

folder
snippet
device

folder stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The folder in which the resource is defined

snippet stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The snippet in which the resource is defined

device stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The device in which the resource is defined

name stringrequired

Possible values: <= 63 characters

Logical router name

vrf object

ecmp object

enable boolean

Enable ECMP routing?

max_path integer

Possible values: >= 2 and <= 4

Default value: 2

Max paths

symmetric_return boolean

Symmetric return?

strict_source_path boolean

Strict source path?

algorithm object

ip_modulo object

ip_hash object

src_only boolean

Use source address only?

use_port boolean

Use source/destination port for hash?

hash_seed integer

Possible values: <= 4294967295

Hash seed

weighted_round_robin object

interface object[]

Interfaces

Array [

name string

Interface name

weight integer

Possible values: >= 1 and <= 255

Weight

]

balanced_round_robin object

interface string[]

Interfaces

admin_dists object

static integer

Possible values: >= 1 and <= 255

Default value: 10

Static routes

ospf_intra integer

Possible values: >= 1 and <= 255

Default value: 110

OSPF intra area routes

ospf_inter integer

Possible values: >= 1 and <= 255

Default value: 110

OSPF inter area routes

ospf_ext integer

Possible values: >= 1 and <= 255

Default value: 110

OSPF external routes

bgp_internal integer

Possible values: >= 1 and <= 255

Default value: 200

BGP AS internal routes

bgp_external integer

Possible values: >= 1 and <= 255

Default value: 20

BGP AS external routes

bgp_local integer

Possible values: >= 1 and <= 255

Default value: 20

BGP local routes

rip integer

Possible values: >= 1 and <= 255

Default value: 120

RIP routes

bgp object

enable boolean

Enable BGP routing?

router_id string

Router ID

local_as number

global_bfd object

profile string

Possible values: [aggressive, default, passive-default, None]

BFD profile

peer_group object[]

Peer groups

Array [

name string

Peer group name

enable boolean

Enable peer group?

type object

ibgp object

ebgp object

address_family object

ipv4 string

IPv4 address family

filtering_profile object

ipv4 string

IPv4 filtering profile

peer object[]

BGP peers

Array [

name string

Peer name

enable boolean

Enable BGP peer?

peer_as integer

Possible values: >= 1 and <= 65535

Peer AS

inherit boolean

Inherit addressing?

local_address object

interface string

Local interface

ip string

Local IP address

peer_address object

ip string

Peer IP address

connection_options object

authentication string

Default value: inherit

Authentication profile

timers string

Default value: inherit

Timer profile

multihop string

Default value: inherit

Multi-hop

dampening string

Default value: inherit

Dampening profile

enable_sender_side_loop_detection boolean

Enable sender side loop detection?

bfd object

profile string

Possible values: [aggressive, Inherit-lh-global-setting, default, None, passive-default]

BFD profile

]

install_route boolean

Install route?

fast_external_failover boolean

Fast failover?

enforce_first_as boolean

Enforce first AS?

ecmp_multi_as boolean

ECMP multiple AS support?

graceful_shutdown boolean

Graceful shutdown?

default_local_preference integer

Possible values: <= 4294967295

Default local preference

graceful_restart object

enable boolean

Enable graceful restart?

stale_route_time integer

Possible values: >= 1 and <= 3600

Stale route time (seconds)

max_peer_restart_time integer

Possible values: >= 1 and <= 3600

Maximum peer restart time (seconds)

local_restart_time integer

Possible values: >= 1 and <= 3600

Local restart time (seconds)

med object

always_compare_med boolean

Always compare MED?

deterministic_med_comparison boolean

Deterministic MED comparison?

always_advertise_network_route boolean

Always advertise network route?

advertise_network object

ipv4 object

network object[]

IPv4 networks

Array [

name string

IPv4 network

unicast boolean

Unicast?

multicast boolean

Multicast?

backdoor boolean

Backdoor?

]

redistribution_profile object

ipv4 object

unicast string

Redistribution profile name

aggregate_routes object[]

Array [

name string

Aggregate route name

description string

Description

enable boolean

Enable aggregate route?

summary_only boolean

Summary only?

as_set boolean

AS set?

same_med boolean

Same MED?

type object

ipv4 object

summary_prefix string

Summary prefix

suppress_map string

Suppress map

attribute_map string

Attribute map

]

ospf object

enable boolean

Enable OSPF routing?

router_id string

Router ID

global_bfd object

profile string

Possible values: [aggressive, passive-default, default, None]

BFD profile

area object[]

OSPF areas

Array [

name string

Area ID

authentication string

Authentication profile

type object

oneOf

normal
stub
nssa

normal objectrequired

abr object

import_list string

Import list

export_list string

Export list

inbound_filter_list string

Inbound filter list

outbound_filter_list string

Outbound filter list

nssa objectrequired

no_summary boolean

No summary?

default_information_originate object

metric integer

Possible values: >= 1 and <= 16677214

Default value: 10

Metric

metric_type string

Possible values: [type-1, type-2]

abr object

import_list string

Import list

export_list string

Export list

inbound_filter_list string

Inbound filter list

outbound_filter_list string

Outbound filter list

nssa_ext_range object[]

Address range for external summary routes

Array [

name string

IPv4 prefix

advertise boolean

Advertise?

]

range object[]

Ranges

Array [

name string

IPv4 address/netmask

substitute string

Substitute

advertise boolean

Advertise?

]

interface object[]

Interfaces

Array [

name string

Interface name

enable boolean

Enable?

mtu_ignore boolean

MTU ignore?

passive boolean

Passive?

priority integer

Possible values: >= 1 and <= 255

Default value: 1

Priority

timing string

Timer profile

authentication string

Authentication profile

bfd object

profile string

Possible values: [aggressive]

metric integer

Possible values: >= 1 and <= 65535

Default value: 10

Cost

link_type object

broadcast object

p2p object

p2mp object

neighbor object[]

Array [

name string

Neighbor IPv4 address

priority integer

Possible values: >= 1 and <= 255

Default value: 1

Priority

]

graceful_restart object

enable boolean

Enable graceful restart?

helper_enable boolean

Enable helper mode?

strict_LSA_checking boolean

Enable strict LSA checking?

grace_period integer

Possible values: >= 5 and <= 1800

Default value: 120

Grace period (seconds)

max_neighbor_restart_time integer

Possible values: >= 5 and <= 1800

Default value: 140

Maximum neighbor restart time (seconds)

rfc1583 boolean

RFC1583 compatibility?

spf_timer string

Possible values: [default]

Global general timer

global_if_timer string

Possible values: [aggressive, default]

Global interface timer

routing_table object

ip object

static_route object[]

IPv4 static routes

Array [

name string

Static route name

destination string

Description

interface string

Interface

nexthop object

discard object

ip_address string

IPv4 address

admin_dist integer

Possible values: >= 10 and <= 240

Administrative distance

metric integer

Possible values: >= 1 and <= 65535

bfd object

profile string

Possible values: [aggressive, default, passive-default, None]

BFD profile

path_monitor object

enable boolean

Enable path monitoring?

]

Responses

Bad Request

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Missing Body

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Body",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Invalid Object

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Object",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Unauthorized

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Forbidden

application/json

Schema
Example (from schema)
auth_unauthorized

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Not Found

application/json

Schema
Example (from schema)
object_not_present

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Conflict

application/json

Schema
Example (from schema)
object_not_unique
name_not_unique
reference_not_zero

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Object Not Unique

{
  "_errors": [
    {
      "code": "E016",
      "message": "Object Not Unique",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Name Not Unique

{
  "_errors": [
    {
      "code": "E006",
      "message": "Name Not Unique",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Reference Not Zero

{
  "_errors": [
    {
      "code": "E009",
      "message": "Reference Not Zero",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

General Errors

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Update a logical router

/logical-routers/:id

Request​

Path Parameters

Body

Responses​

Request

Responses