ves-io-schema-tunnel-API-Create

Examples of creating tunnel

Usecase:

Create tunnel-1

Request using vesctl:

vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

RequestJSON:

{"metadata":{"name":"tunnel-1","namespace":"system"},"spec":{"local_ip":{"intf":{"local_intf":[{"tenant":"acmecorp","namespace":"system","name":"network-interface-1"}]}},"remote_ip":{"endpoints":{"endpoints":{"master-0/node-1":{"ip":{"ipv4":{"addr":"1.1.1.1"}}},"node-2":{"ip":{"ipv4":{"addr":"1.1.1.2"}}}}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}} `

vesctl yaml response:

ResponseJSON:

  "metadata": {
    "name": "tunnel-1",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "b56aa286-0214-4fb6-93b5-73d01612378f",
    "creation_timestamp": "2022-07-28T12:13:51.276200813Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "intf": {
        "local_intf": [
          {
            "kind": "network_interface.Object",
            "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
            "tenant": "acmecorp",
            "namespace": "system",
            "name": "network-interface-1"
          }
        ]
      }
    },
    "remote_ip": {
      "endpoints": {
        "endpoints": {
          "master-0/node-1": {
            "ip": {
              "ipv4": {
                "addr": "1.1.1.1"
              }
            }
          },
          "node-2": {
            "ip": {
              "ipv4": {
                "addr": "1.1.1.2"
              }
            }
          }
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}```
`

Request using curl:

    


curl -X 'POST' -d '{"metadata":{"name":"tunnel-1","namespace":"system"},"spec":{"local_ip":{"intf":{"local_intf":[{"tenant":"acmecorp","namespace":"system","name":"network-interface-1"}]}},"remote_ip":{"endpoints":{"endpoints":{"master-0/node-1":{"ip":{"ipv4":{"addr":"1.1.1.1"}}},"node-2":{"ip":{"ipv4":{"addr":"1.1.1.2"}}}}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build1372770011_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'



curl response:

	


HTTP/1.1 200 OK Content-Type: application/json Date: Thu, 28 Jul 2022 12:13:51 GMT Vary: Accept-Encoding

{ "metadata": { "name": "tunnel-1", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "b56aa286-0214-4fb6-93b5-73d01612378f", "creation_timestamp": "2022-07-28T12:13:51.276200813Z", "deletion_timestamp": null, "modification_timestamp": null, "initializers": null, "finalizers": [ ], "tenant": "acmecorp", "creator_class": "examplesvc", "creator_id": "examplesvc", "object_index": 0, "owner_view": null, "labels": { } }, "spec": { "tunnel_type": "IPSEC_PSK", "local_ip": { "intf": { "local_intf": [ { "kind": "network_interface.Object", "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff", "tenant": "acmecorp", "namespace": "system", "name": "network-interface-1" } ] } }, "remote_ip": { "endpoints": { "endpoints": { "master-0/node-1": { "ip": { "ipv4": { "addr": "1.1.1.1" } } }, "node-2": { "ip": { "ipv4": { "addr": "1.1.1.2" } } } } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" } } } } }



Usecase:
--------
 Create tunnel-2 

Request using vesctl:

    vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

	
RequestJSON:

```{"metadata":{"name":"tunnel-2","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}```
`

vesctl yaml response:

	
ResponseJSON:

```{
  "metadata": {
    "name": "tunnel-2",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "d2bf1be8-fe36-4e24-a413-8f51b6ecd77b",
    "creation_timestamp": "2022-07-28T12:13:51.283577182Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "ip_address": {
        "ip_address": {
          "ipv4": {
            "addr": "192.168.0.10"
          }
        },
        "virtual_network_type": {
          "site_local": {

          }
        }
      }
    },
    "remote_ip": {
      "ip": {
        "ipv4": {
          "addr": "192.168.0.10"
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}```
`

Request using curl:

    


curl -X 'POST' -d '{"metadata":{"name":"tunnel-2","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build1372770011_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'



curl response:

	


HTTP/1.1 200 OK Content-Length: 1291 Content-Type: application/json Date: Thu, 28 Jul 2022 12:13:51 GMT Vary: Accept-Encoding

{ "metadata": { "name": "tunnel-2", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "d2bf1be8-fe36-4e24-a413-8f51b6ecd77b", "creation_timestamp": "2022-07-28T12:13:51.283577182Z", "deletion_timestamp": null, "modification_timestamp": null, "initializers": null, "finalizers": [ ], "tenant": "acmecorp", "creator_class": "examplesvc", "creator_id": "examplesvc", "object_index": 0, "owner_view": null, "labels": { } }, "spec": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "site_local": {

      }
    }
  }
},
"remote_ip": {
  "ip": {
    "ipv4": {
      "addr": "192.168.0.10"
    }
  }
},
"params": {
  "ipsec": {
    "ipsec_psk": {
      "clear_secret_info": {
        "provider": "",
        "url": "string://\u003cbase64\u003e"
      },
      "blindfold_secret_info_internal": null,
      "secret_encoding_type": "EncodingNone"
    }
  }
}

} }



Usecase:
--------
 Create tunnel-3 

Request using vesctl:

    vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

	
RequestJSON:

```{"metadata":{"name":"tunnel-3","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local_inside":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}```
`

vesctl yaml response:

	
ResponseJSON:

```{
  "metadata": {
    "name": "tunnel-3",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "b5f415da-ce56-47cc-b896-e20883d6e414",
    "creation_timestamp": "2022-07-28T12:13:51.287842591Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "ip_address": {
        "ip_address": {
          "ipv4": {
            "addr": "192.168.0.10"
          }
        },
        "virtual_network_type": {
          "site_local_inside": {

          }
        }
      }
    },
    "remote_ip": {
      "ip": {
        "ipv4": {
          "addr": "192.168.0.10"
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}```
`

Request using curl:

    


curl -X 'POST' -d '{"metadata":{"name":"tunnel-3","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local_inside":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build1372770011_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'



curl response:

	


HTTP/1.1 200 OK Content-Length: 1298 Content-Type: application/json Date: Thu, 28 Jul 2022 12:13:51 GMT Vary: Accept-Encoding

{ "metadata": { "name": "tunnel-3", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "b5f415da-ce56-47cc-b896-e20883d6e414", "creation_timestamp": "2022-07-28T12:13:51.287842591Z", "deletion_timestamp": null, "modification_timestamp": null, "initializers": null, "finalizers": [ ], "tenant": "acmecorp", "creator_class": "examplesvc", "creator_id": "examplesvc", "object_index": 0, "owner_view": null, "labels": { } }, "spec": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "site_local_inside": {

      }
    }
  }
},
"remote_ip": {
  "ip": {
    "ipv4": {
      "addr": "192.168.0.10"
    }
  }
},
"params": {
  "ipsec": {
    "ipsec_psk": {
      "clear_secret_info": {
        "provider": "",
        "url": "string://\u003cbase64\u003e"
      },
      "blindfold_secret_info_internal": null,
      "secret_encoding_type": "EncodingNone"
    }
  }
}

} }



Usecase:
--------
 Create tunnel-4 

Request using vesctl:

    vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

	
RequestJSON:

```{"metadata":{"name":"tunnel-4","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"public":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}```
`

vesctl yaml response:

	
ResponseJSON:

```{
  "metadata": {
    "name": "tunnel-4",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "64afa54c-8798-411b-9ffa-daf827763516",
    "creation_timestamp": "2022-07-28T12:13:51.292558773Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "ip_address": {
        "ip_address": {
          "ipv4": {
            "addr": "192.168.0.10"
          }
        },
        "virtual_network_type": {
          "public": {

          }
        }
      }
    },
    "remote_ip": {
      "ip": {
        "ipv4": {
          "addr": "192.168.0.10"
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}```
`

Request using curl:

    


curl -X 'POST' -d '{"metadata":{"name":"tunnel-4","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"public":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build1372770011_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'



curl response:

	


HTTP/1.1 200 OK Content-Length: 1287 Content-Type: application/json Date: Thu, 28 Jul 2022 12:13:51 GMT Vary: Accept-Encoding

{ "metadata": { "name": "tunnel-4", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "64afa54c-8798-411b-9ffa-daf827763516", "creation_timestamp": "2022-07-28T12:13:51.292558773Z", "deletion_timestamp": null, "modification_timestamp": null, "initializers": null, "finalizers": [ ], "tenant": "acmecorp", "creator_class": "examplesvc", "creator_id": "examplesvc", "object_index": 0, "owner_view": null, "labels": { } }, "spec": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "public": {

      }
    }
  }
},
"remote_ip": {
  "ip": {
    "ipv4": {
      "addr": "192.168.0.10"
    }
  }
},
"params": {
  "ipsec": {
    "ipsec_psk": {
      "clear_secret_info": {
        "provider": "",
        "url": "string://\u003cbase64\u003e"
      },
      "blindfold_secret_info_internal": null,
      "secret_encoding_type": "EncodingNone"
    }
  }
}

} }



Usecase:
--------
 Create tunnel-5 

Request using vesctl:

    vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

	
RequestJSON:

```{"metadata":{"name":"tunnel-5","namespace":"system"},"spec":{"local_ip":{"ip_address":{"auto":{},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}```
`

vesctl yaml response:

	
ResponseJSON:

```{
  "metadata": {
    "name": "tunnel-5",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "b0f1ca13-f06c-4b1e-90f8-cf3a426c8a29",
    "creation_timestamp": "2022-07-28T12:13:51.297791715Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "ip_address": {
        "auto": {

        },
        "virtual_network_type": {
          "site_local": {

          }
        }
      }
    },
    "remote_ip": {
      "ip": {
        "ipv4": {
          "addr": "192.168.0.10"
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}```
`

Request using curl:

    


curl -X 'POST' -d '{"metadata":{"name":"tunnel-5","namespace":"system"},"spec":{"local_ip":{"ip_address":{"auto":{},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build1372770011_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'



curl response:

	


HTTP/1.1 200 OK Content-Length: 1219 Content-Type: application/json Date: Thu, 28 Jul 2022 12:13:51 GMT Vary: Accept-Encoding

{ "metadata": { "name": "tunnel-5", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "b0f1ca13-f06c-4b1e-90f8-cf3a426c8a29", "creation_timestamp": "2022-07-28T12:13:51.297791715Z", "deletion_timestamp": null, "modification_timestamp": null, "initializers": null, "finalizers": [ ], "tenant": "acmecorp", "creator_class": "examplesvc", "creator_id": "examplesvc", "object_index": 0, "owner_view": null, "labels": { } }, "spec": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "auto": {

    },
    "virtual_network_type": {
      "site_local": {

      }
    }
  }
},
"remote_ip": {
  "ip": {
    "ipv4": {
      "addr": "192.168.0.10"
    }
  }
},
"params": {
  "ipsec": {
    "ipsec_psk": {
      "clear_secret_info": {
        "provider": "",
        "url": "string://\u003cbase64\u003e"
      },
      "blindfold_secret_info_internal": null,
      "secret_encoding_type": "EncodingNone"
    }
  }
}

} }