Description

This article explains how to detach and attach a tenant site to breakout profile using Postman APIs.
Product: CSO SaaS 6.0 and above 

Symptoms

The CSO is affected with a UI issue, causing the inability to list breakout profiles in the UI. User is unable to add or detach sties to specific breakout profiles.

Solution

Attach a site to a breakout profile:

  1. Get the UUID of the site that needs to be attached. Use the below postman API to get the same.

    Method:GET , Url: https://<CSO IP>/tssm/site   (this will list the sites and their UUIDs)
  2. Get the profile uuid of the cloud breakout profile using the below postman API

    Method:GET , Url: https://<CSO IP>/tssm/cloud-breakout-profile/  (this will list the breakout profiles along with their UUIDs)
  3. Use the below POST method to attach the site to the required cloud breakout profile.

    Note: For the below reference, overlay tunnel used in the site is GRE
    Method: POST , url: https://<CSO IP>/tssm/process-cloud-breakout-profile

Body:

{
  "input": {
    "profile_id": "0cf909f5-b00e-4fd2-bd42-f8e7a972f345",  ---> cloud breakout profile uuid from step 2 
    "attach_site_list": [
      {
        "overlay_info": [
          {
            "tunnel_key": 1,
            "gre_info": {
              "primary_link_info": {
                "internal_ip_prefix": [
                  "172.22.173.193/30",  --- >  primary g/w IP and secondary g/w ip 
                  "172.22.173.197/30"
                ],
                "wan_links": "WAN_1",
                "link_mode": "active"
              },
              "backup_link_info": {
                "internal_ip_prefix": [
                  "",
                  ""
                ],
                "wan_links": "",
                "link_mode": ""
              }
            }
          }
        ],
        "site_uuid": "f0d7c70f-6ad6-4ccd-a669-ff824a738465".  ---> site uuid from step 1
      }
    ]
  }
}

 

Detach a site from a cloud breakout out profile:

  1. Get the UUID of the site that needs to be detached. Use the below Postman API to get the same:

    Method:GET , Url: https://<CSO IP>/tssm/site   (this will list the sites and their UUIDs)
  2. Get the profile UUID of the cloud breakout profile using the below postman API:

    Method:GET , Url: https://<CSO IP>/tssm/cloud-breakout-profile/  (this will list the breakout profiles along with their UUIDs)
  3. Use the below POST method to detach the site from the required cloud breakout profile:

    Method:POST ,url: https://<CSO IP>/tssm/process-cloud-breakout-profile


Body:

{
  "input": {
         "profile_id": "4ad4d1af-ef18-489a-b8cd-91f073dccc71",   --- > from step 2 
         "detach_site_list": ["8b132110-3843-47a4-8894-d9aa2b4d8ccb"]  ---> from step1 
          }
}


Note: Be sure to execute these steps in production environment only after getting confirmation from engineering.

Modification History

2023-05-17: Initial publication