Skip to main content

Get a logical router

GET 
/logical-routers/:id

Get an existing logical router.

Request​

Path Parameters

    id uuidrequired

    The UUID of the configuration resource

Responses​

OK

Schema
    oneOf
    folder stringrequired

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

    The folder in which the resource is defined

    id string

    UUID of the resource

    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 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

    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?

  • ]
Loading...