api-ref: document uplink status propagation

Neutron patch: https://review.openstack.org/#/c/571899/ Change-Id: I07bd7fa2b048280a5a441533d780a8ede790a834 Related-Bug: #1722720
2018-12-06 16:36:44 +00:00 · 2018-12-06 16:36:44 +00:00 · 100f842cdf
parent 532b398b90
commit 100f842cdf
13 changed files with 62 additions and 19 deletions
--- a/api-ref/source/v2/parameters.yaml
+++ b/api-ref/source/v2/parameters.yaml
@ -5922,6 +5922,20 @@ updated_at_resource:
  in: body
  required: true
  type: string
+uplink_status_propagation:
+  description: |
+    The uplink status propagation of the port. Valid values are
+    enabled (``true``) and disabled (``false``).
+  in: body
+  required: true
+  type: boolean
+uplink_status_propagation-request:
+  description: |
+    The uplink status propagation of the port. Valid values are
+    enabled (``true``) and disabled (``false``).
+  in: body
+  required: false
+  type: boolean
 url_path:
  description: |
    The HTTP path of the request sent by the monitor
--- a/api-ref/source/v2/ports.inc
+++ b/api-ref/source/v2/ports.inc
@ -71,6 +71,13 @@ IP Substring Filtering
 The ``ip-substring-filtering`` extension adds support for filtering ports by
 using part of an IP address.

+Mac learning extension
+======================
+
+The ``mac_learning_enabled`` extension extends neutron ports providing the
+ability to enable MAC learning on the associated port via the
+```mac_learning_enabled``` attribute.
+
 Port binding extended attributes
 ================================

@ -124,12 +131,13 @@ The ``standard-attr-tag`` adds Tag support for resources with
 standard attributes by adding the ``tags`` attribute
 allowing consumers to associate tags with resources.

-Mac learning extension
-======================
+Uplink status propagation
+=========================

-The ``mac_learning_enabled`` extension extends neutron ports providing the
-ability to enable MAC learning on the associated port via the
-```mac_learning_enabled``` attribute.
+The ``uplink-status-propagation`` extension adds ``uplink_status_propagation``
+attribute to port. If this attribute is set to ``true``, uplink status
+propagation is enabled. If this attribute is not specified, it is default to
+``false`` which indicates uplink status propagation is disabled.

 Show port details
 =================
@ -194,6 +202,7 @@ Response Parameters
   - tags: tags
   - tenant_id: project_id
   - updated_at: updated_at_resource
+   - uplink_status_propagation: uplink_status_propagation
   - mac_learning_enabled: mac_learning_enabled

 Response Example
@ -317,6 +326,7 @@ Response Parameters
   - tags: tags
   - tenant_id: project_id
   - updated_at: updated_at_resource
+   - uplink_status_propagation: uplink_status_propagation
   - mac_learning_enabled: mac_learning_enabled

 Response Example
@ -451,6 +461,7 @@ Response Parameters
   - tags: tags
   - tenant_id: project_id
   - updated_at: updated_at_resource
+   - uplink_status_propagation: uplink_status_propagation
   - mac_learning_enabled: mac_learning_enabled

 Response Example
@ -506,6 +517,7 @@ Request
   - security_groups: port-security_groups-request
   - tags: tags
   - tenant_id: project_id-request
+   - uplink_status_propagation: uplink_status_propagation-request
   - mac_learning_enabled: mac_learning_enabled-request

 Request Example
@ -558,6 +570,7 @@ Response Parameters
   - tags: tags
   - tenant_id: project_id
   - updated_at: updated_at_resource
+   - uplink_status_propagation: uplink_status_propagation
   - mac_learning_enabled: mac_learning_enabled

 Response Example
@ -611,6 +624,7 @@ Request
   - qos_policy_id: qos_policy_id-port-request
   - security_groups: port-security_groups-request
   - tenant_id: project_id-request
+   - uplink_status_propagation: uplink_status_propagation-request
   - mac_learning_enabled: mac_learning_enabled-request

 Request Example
@ -656,6 +670,7 @@ Response Parameters
   - tags: tags
   - tenant_id: project_id
   - updated_at: updated_at_resource
+   - uplink_status_propagation: uplink_status_propagation
   - mac_learning_enabled: mac_learning_enabled

 Response Example
--- a/api-ref/source/v2/samples/ports/port-bind-create-request.json
+++ b/api-ref/source/v2/samples/ports/port-bind-create-request.json
@ -15,6 +15,7 @@
        "device_owner": "baremetal:none",
        "dns_domain": "my-domain.org.",
        "dns_name": "myport",
-        "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae"
+        "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae",
+        "uplink_status_propagation": false
    }
 }
--- a/api-ref/source/v2/samples/ports/port-bind-create-response.json
+++ b/api-ref/source/v2/samples/ports/port-bind-create-response.json
@ -64,6 +64,7 @@
        "resource_request": {
            "required": ["CUSTOM_PHYSNET_PUBLIC", "CUSTOM_VNIC_TYPE_NORMAL"],
            "resources": {"NET_BW_EGR_KILOBIT_PER_SEC": 1000}
-        }
+        },
+        "uplink_status_propagation": false
    }
 }
--- a/api-ref/source/v2/samples/ports/port-bind-show-response.json
+++ b/api-ref/source/v2/samples/ports/port-bind-show-response.json
@ -53,6 +53,7 @@
        "resource_request": {
            "required": ["CUSTOM_PHYSNET_PUBLIC", "CUSTOM_VNIC_TYPE_NORMAL"],
            "resources": {"NET_BW_EGR_KILOBIT_PER_SEC": 1000}
-        }
+        },
+        "uplink_status_propagation": false
    }
 }
--- a/api-ref/source/v2/samples/ports/port-bind-update-response.json
+++ b/api-ref/source/v2/samples/ports/port-bind-update-response.json
@ -51,6 +51,7 @@
        "resource_request": {
            "required": ["CUSTOM_PHYSNET_PUBLIC", "CUSTOM_VNIC_TYPE_NORMAL"],
            "resources": {"NET_BW_EGR_KILOBIT_PER_SEC": 1000}
-        }
+        },
+        "uplink_status_propagation": false
    }
 }
--- a/api-ref/source/v2/samples/ports/port-create-request.json
+++ b/api-ref/source/v2/samples/ports/port-create-request.json
@ -12,6 +12,7 @@
                "ip_address": "12.12.11.12",
                "mac_address": "fa:14:2a:b3:cb:f0"
            }
-        ]
+        ],
+        "uplink_status_propagation": false
    }
 }
--- a/api-ref/source/v2/samples/ports/port-create-response.json
+++ b/api-ref/source/v2/samples/ports/port-create-response.json
@ -47,6 +47,7 @@
        "tags": ["tag1,tag2"],
        "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa",
        "updated_at": "2016-03-08T20:19:41",
-        "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae"
+        "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae",
+        "uplink_status_propagation": false
    }
 }
--- a/api-ref/source/v2/samples/ports/port-show-response.json
+++ b/api-ref/source/v2/samples/ports/port-show-response.json
@ -40,6 +40,7 @@
        "tags": ["tag1,tag2"],
        "tenant_id": "7e02058126cc4950b75f9970368ba177",
        "updated_at": "2016-03-08T20:19:41",
-        "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae"
+        "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae",
+        "uplink_status_propagation": false
    }
 }
--- a/api-ref/source/v2/samples/ports/port-update-response.json
+++ b/api-ref/source/v2/samples/ports/port-update-response.json
@ -47,6 +47,7 @@
        "tenant_id": "522eda8d23124b25bf03fe44f1986b74",
        "updated_at": "2016-03-08T20:19:41",
        "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae",
-        "port_security_enabled": false
+        "port_security_enabled": false,
+        "uplink_status_propagation": false
    }
 }
--- a/api-ref/source/v2/samples/ports/ports-bind-list-response.json
+++ b/api-ref/source/v2/samples/ports/ports-bind-list-response.json
@ -48,7 +48,8 @@
                "resources": {"NET_BW_EGR_KILOBIT_PER_SEC": 1000}
            },
            "tags": ["tag1,tag2"],
-            "tenant_id": ""
+            "tenant_id": "",
+            "uplink_status_propagation": false
        },
        {
            "admin_state_up": true,
@ -94,7 +95,8 @@
            "updated_at": "2016-03-08T20:19:41",
            "qos_policy_id": null,
            "tags": ["tag1,tag2"],
-            "tenant_id": "d397de8a63f341818f198abb0966f6f3"
+            "tenant_id": "d397de8a63f341818f198abb0966f6f3",
+            "uplink_status_propagation": false
        }
    ]
 }
--- a/api-ref/source/v2/samples/ports/ports-bulk-create-response.json
+++ b/api-ref/source/v2/samples/ports/ports-bulk-create-response.json
@ -38,7 +38,8 @@
            "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa",
            "updated_at": "2016-03-08T20:19:41",
            "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae",
-            "port_security_enabled": false
+            "port_security_enabled": false,
+            "uplink_status_propagation": false
        },
        {
            "admin_state_up": false,
@ -79,7 +80,8 @@
            "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa",
            "updated_at": "2016-03-08T20:19:41",
            "qos_policy_id": null,
-            "port_security_enabled": false
+            "port_security_enabled": false,
+            "uplink_status_propagation": false
        }
    ]
 }
--- a/api-ref/source/v2/samples/ports/ports-list-response.json
+++ b/api-ref/source/v2/samples/ports/ports-list-response.json
@ -41,7 +41,8 @@
            "tenant_id": "",
            "updated_at": "2016-03-08T20:19:41",
            "qos_policy_id": "29d5e02e-d5ab-4929-bee4-4a9fc12e22ae",
-            "port_security_enabled": false
+            "port_security_enabled": false,
+            "uplink_status_propagation": false
        },
        {
            "admin_state_up": true,
@ -84,7 +85,8 @@
            "tenant_id": "d397de8a63f341818f198abb0966f6f3",
            "updated_at": "2016-03-08T20:19:41",
            "qos_policy_id": null,
-            "port_security_enabled": false
+            "port_security_enabled": false,
+            "uplink_status_propagation": false
        }
    ]
 }