Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Announcement: Try the Ask AI chatbot for answers to your technical questions about Juniper products and solutions.

close
header-navigation
keyboard_arrow_up
close
keyboard_arrow_left
Contrail Feature Guide
Table of Contents Expand all
list Table of Contents
file_download PDF
{ "lLangCode": "en", "lName": "English", "lCountryCode": "us", "transcode": "en_US" }
English
keyboard_arrow_right

REST APIs for Extending the Contrail Cluster to Physical Routers, and Physical and Logical Interfaces

date_range 16-Oct-23

Introduction: REST APIs for Extending Contrail Cluster

Use the following REST APIs when extending the Contrail cluster to include physical routers, physical interfaces, and logical interfaces.

REST API for Physical Routers

Use the following REST API when extending the Contrail cluster to include physical routers.

content_copy zoom_out_map
{

 u'physical-router': {

    u'physical_router_management_ip': u'<ip-address>',

    u'virtual_router_refs': [],

    u'fq_name': [

      u'default-global-system-config',

      u'test-router'

    ],

    u'name': u'test-router',

    u'physical_router_vendor_name': u'juniper',

    u'parent_type': u'global-system-config',

    u'virtual_network_refs': [],

    'id_perms': {

      u'enable': True,

      u'uuid': None,

      u'creator': None,

      u'created': 0,

      u'user_visible': True,

      u'last_modified': 0,

      u'permissions': {

        u'owner': u'cloud-admin',

        u'owner_access': 7,

        u'other_access': 7,

        u'group': u'cloud-admin-group',

        u'group_access': 7

      },

      u'description': None

    },

    u'bgp_router_refs': [],

    u'physical_router_user_credentials': {

      u'username': u'',

      u'password': u''

    },

    'display_name': u'test-router',

    u'physical_router_dataplane_ip': u'<ip-address>'

     }

}

REST API for Physical Interfaces

Use the following REST API when extending the Contrail cluster to include physical interfaces.

content_copy zoom_out_map
{

 u'physical-interface': {

    u'parent_type': u'physical-router',

    'id_perms': {

      u'enable': True,

      u'uuid': None,

      u'creator': None,

      u'created': 0,

      u'user_visible': True,

      u'last_modified': 0,

      u'permissions': {

        u'owner': u'cloud-admin',

        u'owner_access': 7,

        u'other_access': 7,

        u'group': u'cloud-admin-group',

        u'group_access': 7

      },

      u'description': None

    },

    u'fq_name': [

      u'default-global-system-config',

      u'test-router',

      u'ge-0/0/1'

    ],

    u'name': u'ge-0/0/1',

    'display_name': u'ge-0/0/1'

      }

}

REST API for Logical Interfaces

Use the following REST API when extending the Contrail cluster to include logical interfaces.

content_copy zoom_out_map
{

 u'logical-interface': {

    u'fq_name': [

      u'default-global-system-config',

      u'test-router',

      u'ge-0/0/1',

      u'ge-0/0/1.0'

    ],

    u'parent_uuid': u'6608b8ef-9704-489d-8cbc-fed4fb5677ca',

    u'logical_interface_vlan_tag': 0,

    u'parent_type': u'physical-interface',

    u'virtual_machine_interface_refs': [

     {

u'to': [

              u'default-domain',

              u'demo',

              u'4a2edbb8-b69e-48ce-96e3-7226c57e5241'

]

      }

    ],

    'id_perms': {

          u'enable': True,

          u'uuid': None,

          u'creator': None,

          u'created': 0,

          u'user_visible': True,

          u'last_modified': 0,

          u'permissions': {

            u'owner': u'cloud-admin',

            u'owner_access': 7,

            u'other_access': 7,

            u'group': u'cloud-admin-group',

            u'group_access': 7

      },

      u'description': None

    },

    u'logical_interface_type': u'l2',

    'display_name': u'ge-0/0/1.0',

    u'name': u'ge-0/0/1.0'

      }

}

footer-navigation