Merge "VPNaaS: Multiple Local Subnet API documentation"
This commit is contained in:
@@ -2,19 +2,13 @@
|
||||
"ipsec_site_connection": {
|
||||
"psk": "secret",
|
||||
"initiator": "bi-directional",
|
||||
"ipsecpolicy_id": "22b8abdc-e822-45b3-90dd-f2c8512acfa5",
|
||||
"ipsecpolicy_id": "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
|
||||
"admin_state_up": true,
|
||||
"peer_cidrs": [
|
||||
"10.2.0.0/24"
|
||||
],
|
||||
"mtu": "1500",
|
||||
"ikepolicy_id": "d3f373dc-0708-4224-b6f8-676adf27dab8",
|
||||
"dpd": {
|
||||
"action": "disabled",
|
||||
"interval": 60,
|
||||
"timeout": 240
|
||||
},
|
||||
"vpnservice_id": "7b347d20-6fa3-4e22-b744-c49ee235ae4f",
|
||||
"peer_ep_group_id": "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
|
||||
"ikepolicy_id": "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
|
||||
"vpnservice_id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
||||
"local_ep_group_id": "3e1815dd-e212-43d0-8f13-b494fa553e68",
|
||||
"peer_address": "172.24.4.233",
|
||||
"peer_id": "172.24.4.233",
|
||||
"name": "vpnconnection1"
|
||||
|
||||
@@ -5,24 +5,24 @@
|
||||
"initiator": "bi-directional",
|
||||
"name": "vpnconnection1",
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "b6887d0b45b54a249b2ce3dee01caa47",
|
||||
"description": "",
|
||||
"tenant_id": "10039663455a446d8ba2cbb058b0f578",
|
||||
"auth_mode": "psk",
|
||||
"peer_cidrs": [
|
||||
"10.2.0.0/24"
|
||||
],
|
||||
"peer_cidrs": [],
|
||||
"mtu": 1500,
|
||||
"ikepolicy_id": "d3f373dc-0708-4224-b6f8-676adf27dab8",
|
||||
"peer_ep_group_id": "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
|
||||
"ikepolicy_id": "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
|
||||
"vpnservice_id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
||||
"dpd": {
|
||||
"action": "disabled",
|
||||
"interval": 60,
|
||||
"timeout": 240
|
||||
"action": "hold",
|
||||
"interval": 30,
|
||||
"timeout": 120
|
||||
},
|
||||
"route_mode": "static",
|
||||
"vpnservice_id": "7b347d20-6fa3-4e22-b744-c49ee235ae4f",
|
||||
"ipsecpolicy_id": "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
|
||||
"local_ep_group_id": "3e1815dd-e212-43d0-8f13-b494fa553e68",
|
||||
"peer_address": "172.24.4.233",
|
||||
"peer_id": "172.24.4.233",
|
||||
"id": "af44dfd7-cf91-4451-be57-cd4fdd96b5dc",
|
||||
"ipsecpolicy_id": "22b8abdc-e822-45b3-90dd-f2c8512acfa5"
|
||||
"id": "851f280f-5639-4ea3-81aa-e298525ab74b",
|
||||
"description": ""
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,30 +1,30 @@
|
||||
{
|
||||
"ipsec_site_connections": [
|
||||
{
|
||||
"status": "PENDING_CREATE",
|
||||
"status": "PENDING CREATE",
|
||||
"psk": "secret",
|
||||
"initiator": "bi-directional",
|
||||
"name": "vpnconnection1",
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "ccb81365fe36411a9011e90491fe1330",
|
||||
"description": "",
|
||||
"tenant_id": "10039663455a446d8ba2cbb058b0f578",
|
||||
"auth_mode": "psk",
|
||||
"peer_cidrs": [
|
||||
"10.1.0.0/24"
|
||||
],
|
||||
"peer_cidrs": [],
|
||||
"mtu": 1500,
|
||||
"ikepolicy_id": "bf5612ac-15fb-460c-9b3d-6453da2fafa2",
|
||||
"peer_ep_group_id": "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
|
||||
"ikepolicy_id": "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
|
||||
"vpnservice_id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
||||
"dpd": {
|
||||
"action": "hold",
|
||||
"interval": 30,
|
||||
"timeout": 120
|
||||
},
|
||||
"route_mode": "static",
|
||||
"vpnservice_id": "c2f3178d-5530-4c4a-89fc-050ecd552636",
|
||||
"ipsecpolicy_id": "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
|
||||
"local_ep_group_id": "3e1815dd-e212-43d0-8f13-b494fa553e68",
|
||||
"peer_address": "172.24.4.226",
|
||||
"peer_id": "172.24.4.226",
|
||||
"id": "cbc152a0-7e93-4f98-9f04-b085a4bf2511",
|
||||
"ipsecpolicy_id": "8ba867b2-67eb-4835-bb61-c226804a1584"
|
||||
"id": "851f280f-5639-4ea3-81aa-e298525ab74b",
|
||||
"description": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,28 +1,28 @@
|
||||
{
|
||||
"ipsec_site_connection": {
|
||||
"status": "PENDING_CREATE",
|
||||
"status": "DOWN",
|
||||
"psk": "secret",
|
||||
"initiator": "bi-directional",
|
||||
"name": "vpnconnection1",
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "ccb81365fe36411a9011e90491fe1330",
|
||||
"description": "",
|
||||
"tenant_id": "10039663455a446d8ba2cbb058b0f578",
|
||||
"auth_mode": "psk",
|
||||
"peer_cidrs": [
|
||||
"10.1.0.0/24"
|
||||
],
|
||||
"peer_cidrs": [],
|
||||
"mtu": 1500,
|
||||
"ikepolicy_id": "bf5612ac-15fb-460c-9b3d-6453da2fafa2",
|
||||
"peer_ep_group_id": "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
|
||||
"ikepolicy_id": "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
|
||||
"vpnservice_id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
||||
"dpd": {
|
||||
"action": "hold",
|
||||
"interval": 30,
|
||||
"timeout": 120
|
||||
},
|
||||
"route_mode": "static",
|
||||
"vpnservice_id": "c2f3178d-5530-4c4a-89fc-050ecd552636",
|
||||
"ipsecpolicy_id": "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
|
||||
"local_ep_group_id": "3e1815dd-e212-43d0-8f13-b494fa553e68",
|
||||
"peer_address": "172.24.4.226",
|
||||
"peer_id": "172.24.4.226",
|
||||
"id": "cbc152a0-7e93-4f98-9f04-b085a4bf2511",
|
||||
"ipsecpolicy_id": "8ba867b2-67eb-4835-bb61-c226804a1584"
|
||||
"id": "851f280f-5639-4ea3-81aa-e298525ab74b",
|
||||
"description": ""
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,24 +5,24 @@
|
||||
"initiator": "bi-directional",
|
||||
"name": "vpnconnection1",
|
||||
"admin_state_up": true,
|
||||
"tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
|
||||
"description": "",
|
||||
"tenant_id": "10039663455a446d8ba2cbb058b0f578",
|
||||
"auth_mode": "psk",
|
||||
"peer_cidrs": [
|
||||
"10.2.0.0/24"
|
||||
],
|
||||
"peer_cidrs": [],
|
||||
"mtu": 2000,
|
||||
"ikepolicy_id": "771f081c-5ec8-4f9a-b041-015dfb7fbbe2",
|
||||
"peer_ep_group_id": "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
|
||||
"ikepolicy_id": "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
|
||||
"vpnservice_id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
||||
"dpd": {
|
||||
"action": "hold",
|
||||
"interval": 30,
|
||||
"timeout": 120
|
||||
},
|
||||
"route_mode": "static",
|
||||
"vpnservice_id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
|
||||
"ipsecpolicy_id": "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
|
||||
"local_ep_group_id": "3e1815dd-e212-43d0-8f13-b494fa553e68",
|
||||
"peer_address": "172.24.4.233",
|
||||
"peer_id": "172.24.4.233",
|
||||
"id": "f7cf7305-f491-45f4-ad9c-8e7240fe3d72",
|
||||
"ipsecpolicy_id": "9958d4fe-3719-4e8c-84e7-9893895b76b4"
|
||||
"id": "851f280f-5639-4ea3-81aa-e298525ab74b",
|
||||
"description": "New description"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"vpnservice": {
|
||||
"subnet_id": "f4fb4528-ed93-467c-a57b-11c7ea9f963e",
|
||||
"router_id": "ec8619be-0ba8-4955-8835-3b49ddb76f89",
|
||||
"subnet_id": null,
|
||||
"router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
|
||||
"name": "myservice",
|
||||
"admin_state_up": true
|
||||
}
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
{
|
||||
"vpnservice": {
|
||||
"router_id": "ec8619be-0ba8-4955-8835-3b49ddb76f89",
|
||||
"router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
|
||||
"status": "PENDING_CREATE",
|
||||
"name": "myservice",
|
||||
"external_v6_ip": "2001:db8::1",
|
||||
"admin_state_up": true,
|
||||
"subnet_id": "f4fb4528-ed93-467c-a57b-11c7ea9f963e",
|
||||
"tenant_id": "ccb81365fe36411a9011e90491fe1330",
|
||||
"id": "9faaf49f-dd89-4e39-a8c6-101839aa49bc",
|
||||
"subnet_id": null,
|
||||
"tenant_id": "10039663455a446d8ba2cbb058b0f578",
|
||||
"external_v4_ip": "172.32.1.11",
|
||||
"id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
||||
"description": ""
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
{
|
||||
"vpnservices": [
|
||||
{
|
||||
"router_id": "ec8619be-0ba8-4955-8835-3b49ddb76f89",
|
||||
"router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
|
||||
"status": "PENDING_CREATE",
|
||||
"name": "myservice",
|
||||
"external_v6_ip": "2001:db8::1",
|
||||
"admin_state_up": true,
|
||||
"subnet_id": "f4fb4528-ed93-467c-a57b-11c7ea9f963e",
|
||||
"tenant_id": "ccb81365fe36411a9011e90491fe1330",
|
||||
"id": "9faaf49f-dd89-4e39-a8c6-101839aa49bc",
|
||||
"subnet_id": null,
|
||||
"tenant_id": "10039663455a446d8ba2cbb058b0f578",
|
||||
"external_v4_ip": "172.32.1.11",
|
||||
"id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
||||
"description": ""
|
||||
}
|
||||
]
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
{
|
||||
"vpnservice": {
|
||||
"router_id": "ec8619be-0ba8-4955-8835-3b49ddb76f89",
|
||||
"router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
|
||||
"status": "PENDING_CREATE",
|
||||
"name": "myservice",
|
||||
"external_v6_ip": "2001:db8::1",
|
||||
"admin_state_up": true,
|
||||
"subnet_id": "f4fb4528-ed93-467c-a57b-11c7ea9f963e",
|
||||
"tenant_id": "ccb81365fe36411a9011e90491fe1330",
|
||||
"id": "9faaf49f-dd89-4e39-a8c6-101839aa49bc",
|
||||
"subnet_id": null,
|
||||
"tenant_id": "10039663455a446d8ba2cbb058b0f578",
|
||||
"external_v4_ip": "172.32.1.11",
|
||||
"id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
||||
"description": ""
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
"status": "ACTIVE",
|
||||
"name": "myvpn",
|
||||
"admin_state_up": true,
|
||||
"subnet_id": "25f8a35c-82d5-4f55-a45b-6965936b33f6",
|
||||
"subnet_id": null,
|
||||
"tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
|
||||
"id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
|
||||
"description": "Updated description"
|
||||
|
||||
@@ -4255,99 +4255,98 @@ router.</para>
|
||||
</param>
|
||||
'>
|
||||
<!ENTITY securityGroupRuleCreateRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="direction" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Ingress or egress: The direction in which the security group
|
||||
rule is applied. For a compute instance, an ingress security
|
||||
group rule is applied to incoming (ingress) traffic for that
|
||||
instance. An egress rule is applied to traffic leaving the
|
||||
instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="ethertype" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Must be IPv4 or IPv6, and addresses represented in CIDR must
|
||||
match the ingress or egress rules.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="security_group_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The security group ID to associate with this security group
|
||||
rule.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="port_range_min" style="plain" type="xsd:int">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The minimum port number in the range that is matched by the
|
||||
security group rule. If the protocol is TCP or UDP, this
|
||||
value must be less than or equal to the
|
||||
<code>port_range_max</code> attribute value. If the protocol
|
||||
is ICMP, this value must be an ICMP type.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="port_range_max" style="plain" type="xsd:int">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The maximum port number in the range that is matched by the
|
||||
security group rule. The <code>port_range_min</code> attribute
|
||||
constrains the <code>port_range_max</code> attribute. If the
|
||||
protocol is ICMP, this value must be an ICMP type.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="protocol" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The protocol that is matched by the security group rule. Valid
|
||||
values are null, tcp, udp, and icmp.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="remote_group_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The remote group ID to be associated with this security group
|
||||
rule. You can specify either the <code>remote_group_id</code>
|
||||
or <code>remote_ip_prefix</code> attribute in the request body.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="remote_ip_prefix" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The remote IP prefix to be associated with this security group
|
||||
rule. You can specify either the <code>remote_group_id</code>
|
||||
or <code>remote_ip_prefix</code> attribute in the request body.
|
||||
This attribute matches the specified IP prefix as the source
|
||||
IP address of the IP packet.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="direction" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Ingress or egress: The direction in which the security group
|
||||
rule is applied. For a compute instance, an ingress security
|
||||
group rule is applied to incoming (ingress) traffic for that
|
||||
instance. An egress rule is applied to traffic leaving the
|
||||
instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="ethertype" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Must be IPv4 or IPv6, and addresses represented in CIDR must
|
||||
match the ingress or egress rules.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="security_group_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The security group ID to associate with this security group
|
||||
rule.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="port_range_min" style="plain" type="xsd:int">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The minimum port number in the range that is matched by the
|
||||
security group rule. If the protocol is TCP or UDP, this
|
||||
value must be less than or equal to the
|
||||
<code>port_range_max</code> attribute value. If the protocol
|
||||
is ICMP, this value must be an ICMP type.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="port_range_max" style="plain" type="xsd:int">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The maximum port number in the range that is matched by the
|
||||
security group rule. The <code>port_range_min</code> attribute
|
||||
constrains the <code>port_range_max</code> attribute. If the
|
||||
protocol is ICMP, this value must be an ICMP type.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="protocol" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The protocol that is matched by the security group rule. Valid
|
||||
values are null, tcp, udp, and icmp.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="remote_group_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The remote group ID to be associated with this security group
|
||||
rule. You can specify either the <code>remote_group_id</code>
|
||||
or <code>remote_ip_prefix</code> attribute in the request body.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="remote_ip_prefix" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The remote IP prefix to be associated with this security group
|
||||
rule. You can specify either the <code>remote_group_id</code>
|
||||
or <code>remote_ip_prefix</code> attribute in the request body.
|
||||
This attribute matches the specified IP prefix as the source
|
||||
IP address of the IP packet.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY svcListResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="vpnservices" style="plain" type="xsd:list">
|
||||
@@ -4360,107 +4359,135 @@ router.</para>
|
||||
<!ENTITY svcCreateVPNServiceObjectParam '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="vpnservice" style="plain" type="xsd:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>VPN service object.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>VPN service object.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY svcResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="router_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>ID of the router into which the VPN service is
|
||||
inserted.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>ID of the router into which the VPN service is
|
||||
inserted.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="status" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Indicates whether IPSec VPN service is
|
||||
currently operational. Possible values
|
||||
are ACTIVE, DOWN, BUILD, ERROR,
|
||||
PENDING_CREATE, PENDING_UPDATE, and
|
||||
PENDING_DELETE.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Indicates whether IPSec VPN service is
|
||||
currently operational. Possible values
|
||||
are ACTIVE, DOWN, BUILD, ERROR,
|
||||
PENDING_CREATE, PENDING_UPDATE, and
|
||||
PENDING_DELETE.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="name" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Human-readable name for the VPN service. Does
|
||||
not have to be unique.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Human-readable name for the VPN service. Does
|
||||
not have to be unique.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="admin_state_up" style="plain" type="xsd:boolean">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
The administrative state of the VPN service, which is up
|
||||
(<code>true</code>) or down (<code>false</code>). If down, the port
|
||||
does not forward packets.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
The administrative state of the VPN service, which is up
|
||||
(<code>true</code>) or down (<code>false</code>). If down, the port
|
||||
does not forward packets.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="external_v4_ip" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Read-only external (public) IPv4 address that is used for the VPN
|
||||
service. The VPN plugin sets this address if an IPv4 interface is
|
||||
available.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="external_v6_ip" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Read-only external (public) IPv6 address that is used for the VPN
|
||||
service. The VPN plugin sets this address if an IPv6 interface is
|
||||
available.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="subnet_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The subnet where the tenant wants the VPN
|
||||
service.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
(Deprecated) The subnet where the tenant wants the VPN
|
||||
service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="tenant_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Owner of the VPN service. Only administrative users can
|
||||
specify a tenant ID other than their
|
||||
own.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Owner of the VPN service. Only administrative users can specify a
|
||||
tenant ID other than their own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The unique ID for the VPN service.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The unique ID for the VPN service.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="description" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Human-readable description for the VPN
|
||||
service.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Human-readable description for the VPN service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>' >
|
||||
<!ENTITY svcCreateRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="tenant_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Owner of the VPN service. Only administrative users can specify a
|
||||
tenant ID other than their own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
Owner of the VPN service. Only administrative users can specify a
|
||||
tenant ID other than their own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="subnet_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The subnet where the tenant wants the VPN
|
||||
<para>(Deprecated) The subnet where the tenant wants the VPN
|
||||
service.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@@ -5276,105 +5303,143 @@ router.</para>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="peer_id" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Peer router identity for authentication. Can
|
||||
be IPv4/IPv6 address, e-mail address, key id,
|
||||
or FQDN. Typically is same as <code>peer_address</code>.</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
Peer router identity for authentication. A valid value is an IPv4
|
||||
address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this
|
||||
value matches the <code>peer_address</code> value.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="peer_cidrs" style="plain" type="xsd:list">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="local_ep_group_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Unique list of valid peer private CIDRs in the form
|
||||
<net_address>/<prefix>.</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
ID for the endpoint group that contains private subnets for the local
|
||||
side of the connection. Must be specified with the
|
||||
<code>peer_ep_group_id</code> parameter unless in backward-compatible
|
||||
mode where <code>peer_cidrs</code> is provided with a
|
||||
<code>subnet_id</code> for the VPN service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="peer_ep_group_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID for the endpoint group that contains private CIDRs in the form
|
||||
<net_address>/<prefix> for the peer side of the connection.
|
||||
Must be specified with the <code>local_ep_group_id</code> parameter
|
||||
unless in backward-compatible mode where <code>peer_cidrs</code> is
|
||||
provided with a <code>subnet_id</code> for the VPN service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="peer_cidrs" style="plain" type="xsd:list">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
(Deprecated) Unique list of valid peer private CIDRs in the form
|
||||
<net_address>/<prefix>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="mtu" style="plain" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Maximum Transmission Unit to address fragmentation.
|
||||
Minimum is 68 for IPv4, and 1280 for IPv6.</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
The Maximum Transmission Unit (MTU) value to address fragmentation.
|
||||
Minimum value is 68 for IPv4, and 1280 for IPv6.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="psk" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The pre-shared key. A valid value is any string.</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
The pre-shared key. A valid value is any string.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="initiator" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Indicates whether this VPN can only respond to connections or both
|
||||
respond to and initiate connections. A valid value is <code
|
||||
>response-only</code> or <code >bi-directional</code>. Default is
|
||||
<code>bi-directional</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
Indicates whether this VPN can only respond to connections or
|
||||
both respond to and initiate connections. A valid value is
|
||||
<code>response-only</code> or <code >bi-directional</code>. Default
|
||||
is <code>bi-directional</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="admin_state_up" style="plain" type="xsd:boolean">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
The administrative state of the IPSec connection, which is up
|
||||
(<code>true</code>) or down (<code>false</code>). If down, the
|
||||
connection does not forward packets.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
The administrative state of the IPSec connection, which is up
|
||||
(<code>true</code>) or down (<code>false</code>). If down, the
|
||||
connection does not forward packets.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="dpd" style="plain" type="xsd:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>A dictionary with dead peer detection (DPD) protocol controls.</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
A dictionary with dead peer detection (DPD) protocol controls.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="action" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The DPD action. A valid value is <code>clear</code>,
|
||||
<code>hold</code>, <code>restart</code>, <code>disabled</code>, or
|
||||
<code>restart-by-peer</code>. Default value is <code>hold</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The DPD action. A valid value is <code>clear</code>,
|
||||
<code>hold</code>, <code>restart</code>, <code>disabled</code>, or
|
||||
<code>restart-by-peer</code>. Default value is <code>hold</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="interval" style="plain" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The DPD interval, in seconds. A valid value is a positive integer.
|
||||
Default is 30.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The DPD interval, in seconds. A valid value is a positive integer.
|
||||
Default is 30.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="timeout" style="plain" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The DPD timeout in seconds. A valid value is a positive integer that
|
||||
is greater than the DPD <code>interval</code> value. Default is 120.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The DPD timeout in seconds. A valid value is a positive integer that
|
||||
is greater than the DPD <code>interval</code> value. Default is 120.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY connListResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@@ -5405,34 +5470,84 @@ router.</para>
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&ipsec_conn_nameRequestParameter;
|
||||
&ipsec_conn_descriptionRequestParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="peer_address" style="plain" type="xsd:string">
|
||||
name="name" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Human-readable name for the IPSec connection. Does not have to be
|
||||
unique.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="description" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Peer gateway public IPv4/IPv6 address or FQDN.</para>
|
||||
<para>Human-readable description for the IPSec connection.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="peer_address" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Peer gateway public IPv4 address, IPv6 address, or FQDN.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="peer_id" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Peer router identity for authentication. Can
|
||||
be IPv4/IPv6 address, e-mail address, key id,
|
||||
or FQDN. Typically is same as <code>peer_address</code>.</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
Peer router identity for authentication. Can be an IPv4 address, IPv6
|
||||
address, e-mail address, key ID, or FQDN. Typically, this value matches
|
||||
the <code>peer_address</code> value.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="local_ep_group_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID for the endpoint group that contains private subnets for the
|
||||
local side of the connection. This value is present with the
|
||||
<code>peer_ep_group_id</code> parameter unless in backward-compatible
|
||||
mode, where <code>peer_cidrs</code> is shown.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="peer_ep_group_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID for the endpoint group that contains private CIDRs in the form
|
||||
<net_address>/<prefix> for the peer side of the connection.
|
||||
This value is present with the <code>local_ep_group_id</code> parameter
|
||||
unless in backward-compatible mode, where <code>peer_cidrs</code> is
|
||||
shown.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="peer_cidrs" style="plain" type="xsd:list">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Unique list of valid peer private CIDRs in the form
|
||||
<net_address>/<prefix>.</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
(Deprecated) Unique list of valid peer private CIDRs in the form
|
||||
<net_address>/<prefix>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="route_mode" style="plain" type="xsd:string">
|
||||
@@ -5538,7 +5653,7 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>A dictionary with Dead Peer Detection protocol controls.</para>
|
||||
<para>A dictionary with Dead Peer Detection (DPD) protocol controls.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@@ -5591,14 +5706,16 @@ router.</para>
|
||||
]</programlisting>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" name="next_hop" style="plain" type="xsd:string">
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" name="next_hop" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The IP address of the next hop.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" name="destination" style="plain" type="xsd:string">
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" name="destination" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
|
||||
@@ -126,9 +126,12 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show VPN service details">
|
||||
<para role="shortdesc">Shows details for a specified VPN service.</para>
|
||||
<para>Shows details for a specified VPN service. If the user is not an
|
||||
administrative user and the VPN service object does not belong to
|
||||
the user's tenant account, a 403 (Forbidden) error is returned.</para>
|
||||
<para>
|
||||
If the user is not an administrative user and the VPN service
|
||||
object does not belong to the tenant account for the user, the
|
||||
operation returns the <code>Forbidden (403)</code> response
|
||||
code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@@ -140,9 +143,11 @@
|
||||
<method name="POST" id="createVPNService">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create VPN service">
|
||||
<para role="shortdesc">Creates a VPN service.</para>
|
||||
<para>Creates a VPN service object. The service is associated with
|
||||
a router and a local (private) subnet. After the service is created, it can
|
||||
contain multiple VPN connections.</para>
|
||||
<para>
|
||||
Creates a VPN service object. The service is associated with a
|
||||
router. After you create the service, it can contain multiple
|
||||
VPN connections.
|
||||
</para>
|
||||
<para>Example:</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@@ -161,8 +166,10 @@
|
||||
<method name="PUT" id="updateVPNService">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update VPN service">
|
||||
<para role="shortdesc">Updates a specified VPN service.</para>
|
||||
<para>This operation updates the attributes of a specified VPN
|
||||
service. To update a service, the service status cannot be a <code>PENDING_*</code> status.</para>
|
||||
<para>
|
||||
Updates the attributes of a specified VPN service. You cannot
|
||||
update a service with a <code>PENDING_*</code> status.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@@ -178,16 +185,20 @@
|
||||
<method name="DELETE" id="deleteVPNService">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove VPN service">
|
||||
<para role="shortdesc">Removes a specified VPN service.</para>
|
||||
<para>This operation removes a specified VPN service. If the service has
|
||||
connections, the request is rejected.</para>
|
||||
<para>
|
||||
If the service has connections, the request is rejected.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>&fault401; &fault404; &fault409conflict;</method>
|
||||
<!--IKEPolicies-->
|
||||
<method name="POST" id="createIKEPolicy">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create IKE policy">
|
||||
<para role="shortdesc">Creates an IKE policy.</para>
|
||||
<para>The IKE policy is used for phases one and two negotiation of the VPN
|
||||
connection. You can specify both the authentication and encryption algorithms for connections.</para>
|
||||
<para>
|
||||
The IKE policy is used for phases one and two negotiation of
|
||||
the VPN connection. You can specify both the authentication
|
||||
and encryption algorithms for connections.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@@ -208,7 +219,6 @@
|
||||
<method name="GET" id="listIKEPolicies">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List IKE policies">
|
||||
<para role="shortdesc">Lists IKE policies.</para>
|
||||
<para>This operation lists all IKE policies.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@@ -220,7 +230,6 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show IKE policies">
|
||||
<para role="shortdesc">Shows details for a specified IKE policy.</para>
|
||||
<para>Shows the details for a specified IKE policy.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@@ -230,7 +239,9 @@
|
||||
</response> &fault401; &fault403; &fault404;</method>
|
||||
<method name="PUT" id="updateIKEPolicy">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update IKE policy">
|
||||
<para role="shortdesc">Updates policy settings in a specified IKE policy.</para>
|
||||
<para role="shortdesc">
|
||||
Updates policy settings in a specified IKE policy.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@@ -246,16 +257,17 @@
|
||||
<method name="DELETE" id="deleteIKEPolicy">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove IKE policy">
|
||||
<para role="shortdesc">Removes a specified IKE policy.</para>
|
||||
<para>Removes the IKE policy specified in the request.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>&fault401; &fault404; &fault409;</method>
|
||||
<!-- IPSec policy -->
|
||||
<method name="POST" id="createIPSecPolicy">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create IPSec policy">
|
||||
<para role="shortdesc">Creates an IPSec policy.</para>
|
||||
<para>The IP security policy specifies the authentication and
|
||||
encryption algorithms and encapsulation mode to use for
|
||||
the established VPN connection.</para>
|
||||
<para role="shortdesc">Creates an IP security (IPSec) policy.</para>
|
||||
<para>
|
||||
The IPsec policy specifies the authentication and encryption
|
||||
algorithms and encapsulation mode to use for the established
|
||||
VPN connection.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@@ -278,8 +290,7 @@
|
||||
</response>&fault400; &fault401;</method>
|
||||
<method name="GET" id="listIPSecPolicies">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List IPSec policies">
|
||||
<para role="shortdesc">Lists IPSec policies.</para>
|
||||
<para>This operation lists all IPSec policies.</para>
|
||||
<para role="shortdesc">Lists all IPSec policies.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@@ -291,7 +302,6 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show IPSec policy">
|
||||
<para role="shortdesc">Shows details for a specified IPSec policy.</para>
|
||||
<para>Shows details for a specified IPSec policy.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@@ -304,7 +314,9 @@
|
||||
</response> &fault401; &fault403; &fault404;</method>
|
||||
<method name="PUT" id="updateIPSecPolicy">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update IPSec policy">
|
||||
<para role="shortdesc">Updates policy settings in a specified IPSec policy.</para>
|
||||
<para role="shortdesc">
|
||||
Updates policy settings in a specified IPSec policy.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@@ -327,7 +339,6 @@
|
||||
<method name="DELETE" id="deleteIPSecPolicy">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove IPSec policy">
|
||||
<para role="shortdesc">Removes a specified IPSec policy.</para>
|
||||
<para>Removes the IPSec policy specified in the request.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>&fault401; &fault404; &fault409;</method>
|
||||
<!-- VPN endpoint group -->
|
||||
@@ -395,8 +406,10 @@
|
||||
<!-- IPSec site-to-site connection -->
|
||||
<method name="POST" id="createIPSecSiteConnection">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create IPSec connection">
|
||||
<para role="shortdesc">Creates an IPSec connection.</para>
|
||||
<para>Creates a site-to-site IPSec connection for a service.</para>
|
||||
<para role="shortdesc">
|
||||
Creates a site-to-site IPSec connection for a specified
|
||||
service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@@ -419,7 +432,7 @@
|
||||
</response>&fault400; &fault401;</method>
|
||||
<method name="GET" id="listIPSecSiteConnections">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List IPSec connections">
|
||||
<para role="shortdesc">Lists IPSec connections.</para>
|
||||
<para role="shortdesc">Lists all IPSec connections.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@@ -466,7 +479,6 @@
|
||||
<method name="DELETE" id="deleteIPSecSiteConnection">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove IPSec connection">
|
||||
<para role="shortdesc">Removes a specified IPSec connection.</para>
|
||||
<para>Removes the IPSec connection specified in the request.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>&fault401; &fault404; &fault409;</method>
|
||||
</application>
|
||||
|
||||
Reference in New Issue
Block a user