LISP

Introduction to LISP

Locator ID Separation Protocol (LISP) is a network architecture and protocol that implements the use of two namespaces instead of a single IP address:

  • Endpoint identifiers (EIDs)—Assigned to end hosts
  • Routing locators (RLOCs)—Assigned to devices (primarily routers) that make up the global routing system

Splitting EID and RLOC functions provides several advantages, including improved routing system scalability, and improved multi-homing efficiency and ingress traffic engineering.

Required Configuration of LISP Devices

LISP functionality requires LISP-specific configuration of one or more LISP-related devices, such as the LISP egress tunnel router (ETR), ingress tunnel router (ITR), proxy ETR (PETR), proxy ITR (PITR), map resolver (MR), map server (MS), and LISP alternative logical topology (ALT) device.

Modes

There are different modes in which the device can be configured to support the LISP feature. Different modes support different configurations.

LISP modes:

  • xTr mode

blank.gif LISP Egress Tunnel Router (ETR)

blank.gif LISP Ingress Tunnel Router (ITR)

  • Proxy xTR mode

blank.gif LISP Egress Tunnel Router (ETR)

blank.gif LISP Ingress Tunnel Router (ITR)

  • LISP Map Server/Map Resolver

blank.gif Shared Model

blank.gif Parallel Model

  • VPN mode
  • Mobility mode

blank.gif First Hop Router mode

blank.gif Site Gateway mode

blank.gif xTr mobile

For additional information about the various modes above, and LISP in general, please refer to:
http://www.cisco.com/c/en/us/td/docs/ios-xml/ios/iproute_lisp/configuration/xe-3s/asr1000/irl-xe-3s-asr1000-book/irl-overview.html#GUID-CD1B3F3E-99E2-4383-A558-714700A6427F

Resource Summary for LISP

 

HTTP Method
Resource
URL (BaseURL)
GET
POST
PUT
DELETE

LISP

/api/v1/routing-svc/lisp/

Y

Y

N

N

/api/v1/routing-svc/lisp/<lisp-id>

Y

N

Y

Y

/api/v1/vrf/<vrf-name>/routing-svc/lisp/

Y

Y

N

N

/api/v1/vrf/<vrf-name>/routing-svc/lisp/<lisp-id>

Y

N

Y

Y

/api/v1/routing-svc/lisp/<lisp-id>/site

Y

Y

N

N

/api/v1/routing-svc/lisp/<lisp-id>/site/<site-name>

Y

N

Y

Y

LISP Resource: xTr Mode

History

 

Release
Modification

IOS XE 3.13

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties for xTr Mode

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object Type:" object#lisp"

lisp-id

number

Optional

Unique identifier for the LISP configuration.

Range: 0 to 65520

database-mapping

array

Mandatory

Array of mapping between EIDs and RLOCs with priority and weight for each

instance-id

number

Optional

Specifies the instance ID to be associated with this EID table.

Range: 0 to 16777215

eid-prefix

string

Mandatory

IP address (IPv4 or IPv6) for EID

Format: "IP/subnet-length"

rloc-interface-name

string

Optional

RLOC identifier

Valid ETR interface name (IPv4 or IPv6)

rloc-interface-address

string

Optional

RLOC identifier

Valid ETR interface address (IPv4 or IPv6)

priority

number

Mandatory

Specifies the priority assigned to the RLOC

Range: 0 to 255

weight

number

Mandatory

Specifies the weight assigned to the locator

Range: 0 to 100

At least one of the following properties must be configured:

ipv4-itr, ipv4-etr, ipv4-itr-map-resolver, ipv4-itr-map-server, ipv6-itr, ipv6-etr, ipv6-itr-map-resolver, ipv6-itr-map-server

ipv4-itr

boolean

Optional

Specifies whether the router will operate in ITR mode for IPv4

ipv4-etr

boolean

Optional

Specifies whether the router will operate in ETR mode for IPv4

ipv4-itr-map-resolver

array

Optional

Comma-separated list of IP addresses to be used as map-resolvers for ITR mode.

Can include up to 2 map resolvers per type of IP address.

ipv4-etr-map-server-address

array

Optional

Comma-separated list of IP addresses to be used as map-servers for ETR mode.

Can include up to 2 map servers per type of IP address.

ipv4-etr-map-server-key

array

Optional

Comma-separated list of keys to be used with map-resolvers.

One key allowed per map-resolver configuration.

ipv6-itr

boolean

Optional

Specifies whether the router will operate in ITR mode for IPv6

ipv6-etr

boolean

Optional

Specifies whether the router will operate in ETR mode for IPv6

ipv6-itr-map-resolver

array

Optional

Comma-separated list of IP addresses to be used as map-resolvers for ITR mode.

Can include up to 2 map resolvers per type of IP address.

ipv6-etr-map-server-address

array

Optional

Comma-separated list of IP addresses to be used as map-servers for ETR mode.

Can include up to 2 map-servers per type of IP address.

ipv6-etr-map-server-key

array

Optional

Comma separated list of keys to be used with map-resolvers.

One key allowed per map-resolver configuration.

JSON Representation: xTr Mode

{
"kind": "object#lisp",
"lisp-id": {number},
"xtr":
{
"database-mapping": [
{
"eid-prefix": {string},
"rloc-interface-address": {string},
"rloc-interface-name": {string},
"priority": {number},
"weight": {number}
}
],
"instance-id": {number}
"ipv4-itr": {boolean},
"ipv4-etr": {boolean},
"ipv4-itr-map-resolver": [{string}],
"ipv4-etr-map-server": [
{
"address":{string}
"key": {String}
}
],
"ipv6-itr": {boolean},
"ipv6-etr": {boolean},
"ipv6-itr-map-resolver": [{string}],
"ipv6-etr-map-server": [
{
"address":{string}
"key": {String}
}
]
}
}
 

Retrieve All the LISP Configurations

Resource URI

 

Verb
URI

GET

/api/v1/routing-svc/lisp

Example

JSON Request

GET /api/v1/routing-svc/lisp
Accept: application/json
 

JSON Response

200 OK
Content-Type: application/json
{
"kind": "collection#lisp",
"items": [
 
"lisp-id": 0,
"xtr":
{
"database-mapping":
[
{
"eid-prefix": "10.0.0.1/32",
"rloc-interface-name": "GigabitEthernet1",
"priority": 1,
"weight": 1
}
],
"ipv4-itr": true,
"ipv4-etr": true,
"ipv4-itr-map-resolver" : [{"20.0.0.1"}, {"30.0.0.1"}],
"ipv4-etr-map-server:
[
{
"address" : {"1.2.3.4"},
"key-type" : 0,
"key" : "cisco"
}
]
}
}
 

Create a LISP Configuration: xTr Mode

Resource URI

 

Verb
URI

POST

/api/v1/routing-svc/lisp

Example

JSON Request

POST /api/v1/routing-svc/lisp/
Content-Type: application/json
 
{
"lisp-id": 0,
"xtr":
{
"database-mapping": [
{
"eid-prefix": "10.0.0.1/32",
"rloc-interface-address": "10.0.0.10",
"priority": 1,
"weight": 1
}
],
"ipv4-itr": true,
"ipv4-etr": true,
"ipv4-itr-map-resolver": [{"20.0.0.1"}, {"30.0.0.1"}],
"ipv4-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
"ipv6-itr": false,
"ipv6-etr": true,
"ipv6-itr-map-resolver": [{"20.0.0.1"}],
"ipv6-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
}
}
 

JSON Response

201 Created
Location: https://host//api/v1/routing-svc/lisp/0
 

Retrieve a LISP Configuration: xTr Mode

Resource URI

 

Verb
URI

GET

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

GET /api/v1/routing-svc/lisp/0
Accept-Type: application/json
 

JSON Response

200 OK
{
"kind": "object#lisp",
"database-mapping": [
{
"eid-prefix": "10.0.0.1/32",
"rloc-interface-address": "10.0.0.10",
"priority": 1,
"weight": 1
}
],
"ipv4-itr": true,
"ipv4-etr": true,
"ipv4-itr-map-resolver": [{"20.0.0.1"}, {"30.0.0.1"}],
"ipv4-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
],
"ipv6-itr": false,
"ipv6-etr": true,
"ipv6-itr-map-resolver": [{"20.0.0.1"}],
"ipv6-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
}
 

Modify a LISP Configuration: xTr Mode

Resource URI

 

Verb
URI

PUT

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

PUT /api/v1/routing-svc/lisp/0
Content-Type: application/json
 
{
"xtr":
{
"database-mapping": [
{
"eid-prefix": "10.0.0.1/32",
"rloc-interface-address": "10.0.0.10",
"priority": 1,
"weight": 1
}
],
"ipv4-itr": true,
"ipv4-etr": true,
"ipv4-itr-map-resolver": [{"20.0.0.1"}, {"30.0.0.1"}],
"ipv4-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
}
}
 

JSON Response

204 No Content
 

Delete a LISP Configuration: xTr Mode

Resource URI

 

Verb
URI

DELETE

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

DELETE /api/v1/routing-svc/lisp/lisp/0
 

JSON Response

204 No Content
 

LISP Resource: MS/MR Mode

History

 

Release
Modification

IOS XE 3.13

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties for MS/MR Mode

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object Type:" object#lisp"

lisp-id

number

Optional

Unique identifier for the LISP configuration.

Range: 0 to 65520

model

string

Mandatory

Specifies "shared" or "parallel" model

site

array

Mandatory

Array that specifies the site configuration

site-name

string

Mandatory

Specifies the site-name

eid-prefix-ipv4

array of objects

Mandatory

Array specifying the IPv4 EID information

eid-prefix-ipv6

array of objects

Mandatory

Array specifying the IPv6 EID information

address

string

Optional

(sub-property of eid-prefix-ipv4 or eid-prefix-ipv6)

IPv4/IPv6 address for the EID, with subnet length.

Format: "ip/subnet-length"

instance-id

number

Optional

(sub-property of eid-prefix-ipv4 or eid-prefix-ipv6)

Instance ID to be used with the IPv4/IPv6 EID

accept-more-specifics

boolean

Optional

(sub-property of eid-prefix-ipv4 or eid-prefix-ipv6)

Specifies that any EID prefix that is more specific than the EID prefix configured is accepted and tracked

authentication-key-type

number

Optional

Authentication key type

Default: 0

authentication-key

string

Optional

Authentication key

ipv4-map-resolver

boolean

Optional

Specifies whether it is necessary to enable IPv4 map-resolver (MR) on the router

ipv4-map-server

boolean

Optional

Specifies whether it is necessary to enable IPv4 map-server (MS) on the router

ipv6-map-resolver

boolean

Optional

Specifies whether it is necessary to enable IPv6 map-resolver (MR) on the router

ipv6-map-server

boolean

Optional

Specifies whether it is necessary to enable IPv6 map-server (MS) on the router

JSON Representation: MS/MR Mode

{
"kind": "object#lisp",
"name": lisp-id": {number},
"ms-mr":
{
"model": {string},
"msmr":
{
"site":
[
{
"site-name": {string},
"eid-prefix-ipv4": [
{
"address": {string},
"instance-id": {number},
"accept-more-specifics": {boolean}
}
]
"eid-prefix-ipv6": [
{
"address": {string},
"ipv4-subnet-length": {number},
"ipv6-subnet-length": "instance-id": {number},
"accept-more-specifics": {boolean}
}
]
"authentication-key-type": {number}
"authentication-key": {string}
}
],
"ipv4-map-resolver": {boolean},
"ipv4-map-server": {boolean},
"ipv6-map-resolver": {boolean},
"ipv6-map-server": {boolean},
}
}
 

Create a LISP Configuration: MS/MR Mode

Resource URI

 

Verb
URI

POST

/api/v1/routing-svc/lisp

Example

JSON Request

POST /api/v1/routing-svc/lisp/
Content-Type: application/json
 
{
"lisp-id": 0,
"msmr":
{
"model": "shared",
"site": [
{
"site-name": "abc",
"eid-prefix-ipv4": [
{
"address": "172.16.1.0/24",
}
],
"eid-prefix-ipv6": [
{
"address": "2001:db8:a::/48",
}
],
"authentication-key": "cisco"
}
],
"ipv4-map-resolver": true,
"ipv4-map-server": true,
"ipv6-map-resolver": true,
"ipv6-map-server": true,
}
}
 

JSON Response

201 Created
Location: https://host/api/v1/routing-svc/lisp/lisp0
 

Retrieve a LISP Configuration: MS/MR Mode

Resource URI

 

Verb
URI

GET

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

GET /api/v1/routing-svc/lisp/0
Accept-Type: application/json
 

JSON Response

200 OK
{
"kind": "object#lisp",
"ms-mr":
{
"model": "shared",
"site": [
{
"site-name": "abc",
"eid-prefix-ipv4": [
{
"address": "172.16.1.0/24
}
],
"eid-prefix-ipv6": [
{
"address": "2001:db8:a::/48
}
],
"authentication-key": "cisco"
}
],
"ipv4-map-resolver": true,
"ipv4-map-server": true,
"ipv6-map-resolver": true,
"ipv6-map-server": true,
}
}
 

Modify a LISP Configuration: MS/MR Mode

Resource URI

 

Verb
URI

PUT

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

PUT /api/v1/routing-svc/lisp/0
Content-Type: application/json
{
"msmr":
{
"model": "parallel",
"site": [
{
"site-name": "abc",
"eid-prefix-ipv4": [
{
"address": "172.16.1.0/24",
"instance-id": 101
}
"eid-prefix-ipv6": [
{
"address": "2001:db8:a::/48",
"instance-id": 102
}
"authentication-key": "cisco123"
}
],
"ipv4-map-resolver": true,
"ipv4-map-server": true,
"ipv6-map-resolver": true,
"ipv6-map-server": true,
}
}
 

JSON Response

204 No Content
 

Delete a LISP Configuration: MS/MR Mode

Resource URI

 

Verb
URI

DELETE

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

DELETE /api/v1/routing-svc/lisp/0
 

JSON Response

204 No Content
 

Create a LISP Configuration: MS/MR Mode, VRF-Aware

Resource URI

 

Verb
URI

POST

/api/v1/vrf/<VRF-name>/routing-svc/lisp

Example

JSON Request

POST /api/v1/vrf/BLUE/routing-svc/lisp
Content-Type: application/json
 
{
"lisp-id": 0,
"msmr":
{
"model": "shared",
"site": [
{
"site-name": "abc",
"eid-prefix-ipv4": [
{
"address": "172.16.1.0/24",
}
],
"eid-prefix-ipv6": [
{
"address": "2001:db8:a::/48",
}
],
"authentication-key": "cisco"
}
],
"ipv4-map-resolver": true,
"ipv4-map-server": true,
"ipv6-map-resolver": true,
"ipv6-map-server": true,
}
}

JSON Response

201 Created
Location: https://host/api/v1/routing-svc/lisp/0
 

Retrieve a LISP Configuration: MS/MR Mode, VRF-Aware

Resource URI

 

Verb
URI

GET

/api/v1/vrf/<VRF-name>/routing-svc/lisp

Example

JSON Request

GET /api/v1/vrf/BLUE/routing-svc/lisp/0
Accept-Type: application/json
 

JSON Response

200 OK
{
"kind": "object#lisp",
"ms-mr":
{
"model": "shared",
"site": [
{
"site-name": "abc",
"eid-prefix-ipv4": [
{
"address": "172.16.1.0/24",
}
],
"eid-prefix-ipv6": [
{
"address": "2001:db8:a::/48",
}
],
"authentication-key": "cisco"
}
],
"ipv4-map-resolver": true,
"ipv4-map-server": true,
"ipv6-map-resolver": true,
"ipv6-map-server": true,
}
}
 

Modify a LISP Configuration: MS/MR Mode, VRF-Aware

Resource URI

 

Verb
URI

PUT

/api/v1/vrf/<VRF-name>/routing-svc/lisp/<name>

Example

JSON Request

PUT /api/v1/vrf/BLUE/routing-svc/lisp/0
Content-Type: application/json
 
{
"msmr":
{
"model": "shared",
"site": [
{
"site-name": "abc",
"eid-prefix-ipv4": [
{
"address": "172.16.1.0/24",
}
],
"eid-prefix-ipv6": [
{
"address": "2001:db8:a::/48",
}
],
"authentication-key": "cisco"
}
],
"ipv4-map-resolver": true,
"ipv4-map-server": true,
"ipv6-map-resolver": true,
"ipv6-map-server": true,
}
}
 

JSON Response

204 No Content
 

Delete a LISP Configuration: MS/MR Mode, VRF-Aware

Resource URI

 

Verb
URI

DELETE

/api/v1/vrf/<VRF-name>/lisp/<name>

Example

JSON Request

DELETE /api/v1/vrf/BLUE/routing-svc/lisp/0
 

JSON Response

204 No Content
 

LISP Resource—Mobility Mode: First Hop Router/Site Gateway/ xTr-Mobile Mode

History

 

Release
Modification

IOS XE 3.13

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties for FHR/Site Gateway/ xTr - Mobile Mode

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object Type:" object#lisp"

lisp-id

number

Optional

Unique identifier for the LISP configuration.

Range: 0 to 65520

locator-set-name

array

Mandatory

Array that specifies the locator set information

ip-address

string

Mandatory

Address that the FHR uses to communicate with the site gateway xTr

priority

number

Mandatory

Specifies the priority assigned to the RLOC

Range: 0 to 255

weight

number

Mandatory

Specifies the weight assigned to the locator

Range: 0 to 255

eid-table-instance-id

number

Mandatory

Specifies the instance ID to be associated with this EID table

Range: 0 to 16777215

eid-table-database-mapping

array

Optional

Configures an IPv4 EID-to-RLOC mapping relationship and an associated traffic policy for LISP

eid-prefix

string

Optional

(subproperty of eid-table-database-mapping)

IPv4 or IPv6 EID prefix and length to be advertised by the router

locator-set

string

Optional

(subproperty of eid-table-database-mapping)

Specifies the IPv4 routing locator (RLOC) associated with the EID prefix

dynamic-eid-name

string

Optional

Name of a LISP dynamic-EID

dynamic-eid-notify-auth-key

string

Optional

Enables sending of dynamic endpoint identifier (EID) presence notifications to a gateway xTR with the specified IPv4 address along with the authentication key used with the gateway xTR

dynamic-eid-notify-group

string

Optional

Specifies the IPv4 multicast group address used for sending and receiving site-based map-notify multicast messages

dynamic-eid-database-mapping

array

Optional

Configures an IPv4 mapping relationship and an associated traffic policy for LISP VM-mobility dynamic EID policy

ipv4-itr

boolean

Optional

Specifies whether the router needs to operate in ITR mode for IPv4

ipv4-etr

boolean

Optional

Specifies whether the router needs to operate in ETR mode for IPv4

ipv4-itr-map-resolver

array

Optional

Comma-separated list of IP addresses to be used as map-resolvers.

Can include up to 2 map resolvers per type of IP address.

ipv4-etr-map-server-address

array

Optional

Comma-separated list of IP addresses to be used as map-servers.

Can include up to 2 map-servers per type of IP address.

ipv4-etr-map-server-key

array

Optional

Comma-separated list of keys to be used with map-resolvers.

One key allowed per MS configuration.

ipv4-use-petr

string

Optional

PETR address to use

ipv6-itr

boolean

Optional

Specifies whether the router needs to operate in ITR mode for IPv6

ipv6-etr

boolean

Optional

Specifies whether the router needs to operate in ETR mode for IPv6

ipv6-itr-map-resolver

array

Optional

Comma-separated list of IP addresses to be used as map-resolvers.

Can include up to 2 MRs per type of IP address.

ipv6-etr-map-server-address

array

Optional

Comma-separated list of IP addresses to be used as map-servers.

Can include up to 2 map-servers per type of IP address.

ipv6-etr-map-server-key

array

Optional

Comma-separated list of keys to be used with map-resolvers.

One key allowed per MS configuration.

ipv4-use-petr

string

Optional

PETR address to use

JSON Representation

{
"kind": "object#lisp",
"lisp-id": {number},
"mobility":
{
"locator-set": [
{
"name": {string},
"address": [
{
"ip-address": {string},
"priority": {number},
"weight": {number}
}
]
}
],
"eid-table-instance-id": {number},
"eid-table-database-mapping": [
{
"eid-prefix": {string},
"locator-set": {string}
}
],
"dynamic-eid-name": {string},
"dynamic-eid-notify-auth-key": {string},
"dynamic-eid-database-mapping": [
{
"eid-prefix": {string},
"locator-set": {string}
}
],
"ipv4-itr": {boolean},
"ipv4-etr": {boolean},
"ipv4-itr-map-resolver": [{string}],
"ipv4-etr-map-server": [
{
"address":{string}
"key": {String}
}
],
"ipv6-itr": {boolean},
"ipv6-etr": {boolean},
"ipv6-itr-map-resolver": [{string}],
"ipv6-etr-map-server": [
{
"address":{string}
"key": {String}
}
]
"ipv4-use-petr": {string},
"ipv6-use-petr": {string}
}
}
 

Create a LISP Configuration: FHR/Site Gateway/ xTr-Mobile Mode

Resource URI

 

Verb
URI

POST

/api/v1/routing-svc/lisp

Example

JSON Request

POST /api/v1/routing-svc/lisp/
Content-Type: application/json
 
{
"lisp-id": 0,
"mobility":
{
"locator-set": [
{
"ABC": [
"ip-address": "192.168.6.6",
"priority": 1,
"weight": 100
]
},
{
"DC1": [
"ip-address: "172.25.210.1"
"priority": 1
"weight": 100
]
}
],
"eid-table-instance-id": 101,
"dynamic-eid-name": "LISP1",
"dynamic-eid-notify-authentication-key": "cisco",
"dynamic-eid-map-notify-group": "239.0.0.1",
"dynamic-eid-database-mapping": [
{
"eid-prefix": "10.0.0.5/32",
"locator-set": "DC1"
}
],
"ipv4-itr": True,
"ipv4-etr": True,
"ipv4-itr-map-resolver": [{"10.0.0.1"}]
}
}
 

JSON Response

201 Created
Location: https://host/api/v1/routing-svc/lisp/0
 

Retrieve a LISP Configuration: FHR/Site Gateway/ xTr-Mobile Mode

Resource URI

 

Verb
URI

GET

/api/v1/routing-svc/lisp/{name}

Example

JSON Request

GET /api/v1/routing-svc/lisp/0
Accept-Type: application/json
 

JSON Response

200 OK
{
"kind": "object#lisp",
"mobility":
{
"locator-set": [
{
"ABC": [
"ip-address": "192.168.6.6",
"priority": 1,
"weight": 100
]
},
{
"DC1": [
"ip-address: "172.25.210.1"
"priority": 1
"weight": 100
]
}
],
"eid-table-instance-id": 101,
"dynamic-eid-name": "VMs"
"dynamic-eid-notify-auth-key": "cisco",
"dynamic-eid-database-mapping": [
{
"eid-prefix": "10.0.0.5/32",
"locator-set": "DC1"
}
]
"ipv4-itr": True,
"ipv4-etr": True,
"ipv4-itr-map-resolver": [{"10.0.0.1"}]
}
}
 

Modify a LISP Configuration: FHR/Site Gateway/ xTr-Mobile Mode

Resource URI

 

Verb
URI

PUT

/api/v1/routing-svc/lisp/{name}

Example

JSON Request

PUT /api/v1/routing-svc/lisp/0
Content-Type: application/json
{
"mobility":
{
"locator-set": [
{
"ABC": [
"ip-address": "192.168.6.6",
"priority": 1,
"weight": 100
]
},
{
"DC1": [
"ip-address: "172.25.210.1"
"priority": 1
"weight": 100
]
}
],
"eid-table-instance-id": 101,
"dynamic-eid-name": "VMs"
"dynamic-eid-notify-auth-key": "cisco",
"dynamic-eid-database-mapping": [
{
"eid-prefix": "10.0.0.5/32",
"locator-set": "DC1"
}
]
}
}
 

JSON Response

204 No Content
 

Delete a LISP Configuration: FHR/Site Gateway/ xTr-Mobile Mode

Resource URI

 

Verb
URI

DELETE

/api/v1/routing-svc/lisp/{name}

Example

JSON Request

DELETE /api/v1/routing-svc/lisp/0
 

JSON Response

204 No Content
 

LISP Resource: PxTr Mode

History

 

Release
Modification

IOS XE 3.13

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties for PxTr Mode

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object Type:" object#lisp"

lisp-id

number

Optional

Unique identifier for the LISP configuration.

Range: 0 to 65520

At least one of the following properties must be configured for PxTr mode:

ipv4 proxy-itr, ipv4-proxy-etr, ipv4-alt-vrf, ipv4-map-cache-limit, ipv6 proxy-itr, ipv6-proxy-etr, ipv6-alt-vrf, ipv6-map-cache-limit

ipv4-proxy-etr

boolean

Optional

Specifies whether it is necessary to configure the router as IPv4 PETR

ipv6-proxy-etr

boolean

Optional

Specifies whether it is necessary to configure it as IPv6 PETR

ipv4-proxy-itr

boolean

Optional

Specifies whether it is necessary to configure the router as IPv4 PITR

ipv6-proxy-itr

boolean

Optional

Specifies whether it is necessary to configure the router as ipv6 PITR

ipv4-proxy-itr-address-ipv4

string

Optional

IPv4 address to configure the router as IPv4 PITR

ipv4-proxy-itr-address-ipv6

string

Optional

IPv6 address to configure the router as IPv4 PITR

ipv4-alt-vrf

string

Optional

Specifies the VRF for the IPv4 LISP ALT

To configure which VRF instance supporting the IPv4 address-family LISP should use when sending map requests for an IPv4 endpoint identifier-to-routing locator mapping directly over the ALT

ipv4-map-cache-limit

number

Optional

Specifies the number of entries

Default: 1000

ipv6-proxy-itr-address

array

Optional

Comma-separated list of IP addresses to configure the router as IPv6 PITR

ipv6-proxy-itr-address-ipv6

string

Optional

IPv6 address to configure the router as IPv6 PITR

ipv6-alt-vrf

string

Optional

Specifies the VRF for the IPv6 LISP ALT

ipv6-map-cache-limit

number

Optional

Specifies the number of entries

Default: 10000

JSON Representation: PxTr Mode

{
"kind": "object#lisp",
"lisp-id": {number},
"pxtr":
{
"ipv4-proxy-etr": {boolean},
"ipv6-proxy-etr": {boolean},
"ipv4-proxy-itr": {boolean},
"ipv6-proxy-itr": {boolean},
"ipv4-proxy-itr-address-ipv4": [{string}],
"ipv4-proxy-itr-address-ipv6": [{string}],
"ipv4-alt-vrf": {string},
"ipv4-map-cache-limit": {number},
"ipv6-proxy-itr-address": [{string}],
"ipv4-proxy-itr-address-ipv6": [{string}],
"ipv6-alt-vrf": {string},
"ipv6-map-cache-limit": {number},
}
}
 

Create a LISP Configuration: PxTr Mode

Resource URI

 

Verb
URI

POST

/api/v1/routing-svc/lisp/

Example

JSON Request

POST /api/v1/routing-svc/lisp
Content-Type: application/json
{
"lisp-id": 0,
"pxtr":
{
"ipv4-proxy-etr": true,
"ipv6-proxy-etr": true,
"ipv4-proxy-itr": true,
"ipv6-proxy-itr": true,
"ipv4-proxy-itr-address-ipv4": {"10.0.0.2"},
"ipv4-map-cache-limit": 10000,
"ipv6-proxy-itr-address-ipv4": {"10.0.0.2"},
"ipv6-map-cache-limit": 20000
}
}
 

JSON Response

201 Created
Location: https://host/api/v1/routing-svc/lisp/0
 

Retrieve a LISP Configuration: PxTr Mode

Resource URI

 

Verb
URI

GET

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

GET /api/v1/routing-svc/lisp/0
Accept-Type: application/json
 

JSON Response

200 OK
{
"kind": "object#lisp",
"pxtr":
{
"ipv4-proxy-itr": true,
"ipv6-proxy-itr": true,
"ipv4-proxy-itr-address-ipv4": {"10.0.0.1"},
"ipv4-map-cache-limit": 10000,
"ipv6-proxy-itr-address-ipv4": {"10.0.0.1"},
"ipv6-map-cache-limit": 20000
}
}
 

Modify a LISP Configuration: PxTr Mode

Resource URI

 

Verb
URI

PUT

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

PUT /api/v1/routing-svc/lisp/0
Content-Type: application/json
 
pxtr:
{
"ipv4-proxy-itr": true,
"ipv6-proxy-itr": true,
"ipv4-proxy-itr-address": {"10.0.0.1"},
"ipv4-map-cache-limit": 2000,
"ipv6-proxy-itr-address": {"10.0.0.1"},
"ipv6-map-cache-limit": 1000
}
 

JSON Response

204 No Content
 

Delete a LISP Configuration: PxTr Mode

Resource URI

 

Verb
URI

DELETE

/api/v1/routing-svc/lisp/<name>

Example

JSON Request

DELETE /api/v1/routing-svc/lisp/0
 

JSON Response

204 No Content
 

Create a LISP Configuration: PxTr Mode, VRF-Aware

Resource URI

 

Verb
URI

POST

/api/v1/routing-svc/lisp/

Example

JSON Request

POST /api/v1/vrf/BLUE/routing-svc/lisp
Content-Type: application/json
{
"name": "0",
"pxtr":
{
"name": 0,
"ipv4-proxy-etr": true,
"ipv6-proxy-etr": true,
"ipv4-proxy-itr": true,
"ipv6-proxy-itr": true,
"ipv4-alt-vrf": "BLUE"
"ipv4-proxy-itr-address-ipv4": {"10.0.0.2"},
"ipv4-map-cache-limit": 10000,
"ipv6-proxy-itr-address-ipv4": {"10.0.0.2"},
"ipv6-map-cache-limit": 20000
}
}
 

JSON Response

201 Created
Location: https://host/api/v1/routing-svc/lisp/0
 

Retrieve All LISP Configurations: PxTr Mode, VRF-Aware

Resource URI

 

Verb
URI

GET

/api/v1/vrf/<vrf-name>/routing-svc/lisp

Example

JSON Request

GET /api/v1/vrf/BLUE/routing-svc/lisp
Accept-Type: application/json
 

JSON Response

200 OK
{
"kind": "object#lisp",
"name": "0",
"pxtr":
{
"ipv4-proxy-itr": true,
"ipv6-proxy-itr": true,
"ipv4-proxy-itr-address-ipv4": {"10.0.0.1"},
"ipv4-alt-vrf": "BLUE"
"ipv4-map-cache-limit": 10000,
"ipv6-proxy-itr-address-ipv4": {"10.0.0.1"},
"ipv6-map-cache-limit": 20000
}
}
 
 

Retrieve LISP Configuration: PxTr Mode, VRF-Aware

Resource URI

 

Verb
URI

GET

/api/v1/vrf/<vrf-name>/routing-svc/lisp/{name}

Example

JSON Request

GET /api/v1/vrf/BLUE/routing-svc/lisp/0
Accept-Type: application/json
 

JSON Response

200 OK
{
"kind": "object#lisp",
"pxtr":
{
"ipv4-proxy-itr": true,
"ipv6-proxy-itr": true,
"ipv4-proxy-itr-address-ipv4": {"10.0.0.1"},
"ipv4-alt-vrf": "BLUE"
"ipv4-map-cache-limit": 10000,
"ipv6-proxy-itr-address-ipv4": {"10.0.0.1"},
"ipv6-map-cache-limit": 20000
}
}
 

Modify a LISP Configuration: PxTr Mode, VRF-Aware

Resource URI

 

Verb
URI

PUT

/api/v1/vrf/<vrf-name>/routing-svc/lisp/{name}

Example

JSON Request

PUT /api/v1/vrf/BLUE/routing-svc/lisp/0
Content-Type: application/json
 
pxtr:
{
"ipv4-proxy-itr": true,
"ipv6-proxy-itr": true,
"ipv4-proxy-itr-address": {"10.0.0.1"},
"ipv4-map-cache-limit": 2000,
"ipv4-alt-vrf": "BLUE"
"ipv6-proxy-itr-address": {"10.0.0.1"},
"ipv6-map-cache-limit": 1000
}
 

JSON Response

204 No Content
 

Delete a LISP Configuration: PxTr Mode, VRF-Aware

Resource URI

 

Verb
URI

DELETE

/api/v1/vrf/<vrf-name>/routing-svc/lisp/{name}

Example

JSON Request

DELETE /api/v1/vrf/BLUE/routing-svc/lisp/0
 

JSON Response

204 No Content
 

LISP Resource: VPN Parallel Mode

VPN parallel mode shares the same properties and JSON representation as in xTr mode. When creating or retrieving the LISP resource, the VRF instance is included in the URL.

History

 

Release
Modification

IOS XE 3.13

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties for VPN Parallel Mode

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object Type:" object#lisp"

lisp-id

number

Optional

Unique identifier for the LISP configuration.

Range: 0 to 65520

database-mapping

array

Mandatory

Array of mapping between EIDs and RLOCs with priority and weight for each

instance-id

number

Optional

Specifies the instance ID to be associated with this EID table.

Range: 0 to 16777215

eid-prefix

string

Mandatory

IP address (IPv4 or IPv6) for EID

Format: "IP/subnet-length"

rloc-interface-name

string

Optional

RLOC identifier

Valid ETR interface name (IPv4 or IPv6)

rloc-interface-address

string

Optional

RLOC identifier

Valid ETR interface address (IPv4 or IPv6)

priority

number

Mandatory

Specifies the priority assigned to the RLOC

Range: 0 to 255

weight

number

Mandatory

Specifies the weight assigned to the locator

Range: 0 to 100

At least one of the following properties must be configured:

ipv4-itr, ipv4-etr, ipv4-itr-map-resolver, ipv4-itr-map-server, ipv6-itr, ipv6-etr, ipv6-itr-map-resolver, ipv6-itr-map-server

ipv4-itr

boolean

Optional

Specifies whether the router will operate in ITR mode for IPv4

ipv4-etr

boolean

Optional

Specifies whether the router will operate in ETR mode for IPv4

ipv4-itr-map-resolver

array

Optional

Comma-separated list of IP addresses to be used as map-resolvers for ITR mode.

Can include up to 2 map resolvers per type of IP address.

ipv4-etr-map-server-address

array

Optional

Comma-separated list of IP addresses to be used as map-servers for ETR mode.

Can include up to 2 map servers per type of IP address.

ipv4-etr-map-server-key

array

Optional

Comma-separated list of keys to be used with map-resolvers.

One key allowed per map-resolver configuration.

ipv6-itr

boolean

Optional

Specifies whether the router will operate in ITR mode for IPv6

ipv6-etr

boolean

Optional

Specifies whether the router will operate in ETR mode for IPv6

ipv6-itr-map-resolver

array

Optional

Comma-separated list of IP addresses to be used as map-resolvers for ITR mode.

Can include up to 2 map resolvers per type of IP address.

ipv6-etr-map-server-address

array

Optional

Comma-separated list of IP addresses to be used as map-servers for ETR mode.

Can include up to 2 map-servers per type of IP address.

ipv6-etr-map-server-key

array

Optional

Comma separated list of keys to be used with map-resolvers.

One key allowed per map-resolver configuration.

JSON Representation: VPN Parallel Mode

{
"kind": "object#lisp",
"lisp-id": {number},
"xtr":
{
"database-mapping": [
{
"eid-prefix": {string},
"rloc-interface-address": {string},
"rloc-interface-name": {string},
"priority": {number},
"weight": {number}
}
],
"instance-id": {number}
"ipv4-itr": {boolean},
"ipv4-etr": {boolean},
"ipv4-itr-map-resolver": [{string}],
"ipv4-etr-map-server": [
{
"address":{string}
"key": {String}
}
],
"ipv6-itr": {boolean},
"ipv6-etr": {boolean},
"ipv6-itr-map-resolver": [{string}],
"ipv6-etr-map-server": [
{
"address":{string}
"key": {String}
}
]
}
}
 

Create a LISP Configuration: VPN Parallel Mode

Resource URI

 

Verb
URI

POST

/api/v1/vrf/{vrf-name}/routing-svc/lisp

Example

JSON Request

POST /api/v1/vrf/BLUE/routing-svc/lisp
Content-Type: application/json
{
"lisp-id": 0,
"xtr":
{
"database-mapping": [
{
"eid-prefix": "10.0.0.1/30",
"rloc-interface-address": "10.0.0.10",
"priority": 1,
"weight": 1
}
],
"instance-id": 101,
"ipv4-itr": true,
"ipv4-etr": true,
"ipv4-itr-map-resolver": [{"20.0.0.1"}, {"30.0.0.1"}],
"ipv4-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
"ipv6-itr": false,
"ipv6-etr": true,
"ipv6-itr-map-resolver": [{"20.0.0.1"}],
"ipv6-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
}
}
 

JSON Response

201 Created
Location: https://host/api/v1/routing-svc/lisp/0
 

Retrieve a LISP Configuration: VPN Parallel Mode

Resource URI

 

Verb
URI

GET

/api/v1/vrf/{vrf-name}/routing-svc/lisp/{name}

Example

JSON Request

GET /api/v1/vrf/BLUE/routing-svc/lisp/0
Accept-Type: application/json
 

JSON Response

200 OK
{
"kind": "object#lisp",
"xtr":
{
"database-mapping": [
{
"eid-prefix": "10.0.0.1/30",
"rloc-interface-address": "10.0.0.10",
"priority": 1,
"weight": 1
}
],
"instance-id": 101,
"ipv4-itr": true,
"ipv4-etr": true,
"ipv4-itr-map-resolver": [{"20.0.0.1"}, {"30.0.0.1"}],
"ipv4-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
"ipv6-itr": false,
"ipv6-etr": true,
"ipv6-itr-map-resolver": [{"20.0.0.1"}],
"ipv6-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
}
}
 

Modify a LISP Configuration: VPN Parallel Mode

Resource URI

 

Verb
URI

PUT

/api/v1/vrf/{vrf-name}/routing-svc/lisp/{name}

Example

JSON Request

PUT /api/v1/vrf/BLUE/lisp/0
Content-Type: application/json
{
"xtr":
{
"database-mapping": [
{
"eid-prefix": "10.0.0.1/30",
"rloc-interface-address": "10.0.0.10",
"priority": 1,
"weight": 1
}
],
"instance-id": 100,
"ipv4-itr": true,
"ipv4-etr": true,
"ipv4-itr-map-resolver": [{"20.0.0.1"}, {"30.0.0.1"}],
"ipv4-etr-map-server:[
{
"address": {"1.2.3.4"},
"key-type": 0,
"key": "cisco"
}
]
}
}
 

JSON Response

204 No Content
 

Delete a LISP Configuration: VPN Parallel Mode

Resource URI

 

Verb
URI

DELETE

/api/v1/vrf/{vrf-name}/routing-svc/lisp/{name}

Example

JSON Request

DELETE /api/v1/vrf/BLUE/lisp/0
 

JSON Response

204 No Content