7bfa3e776c
Closes-Bug: #1284156 Change-Id: Ie9f0467bb23aad11c650fe1092caf33397586012 author: diane fleming
183 lines
8.0 KiB
XML
183 lines
8.0 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book[
|
|
<!-- Some useful entities borrowed from HTML -->
|
|
<!ENTITY ndash "–">
|
|
<!ENTITY mdash "—">
|
|
<!ENTITY hellip "…">
|
|
<!ENTITY plusmn "±">
|
|
|
|
<!-- Useful for describing APIs -->
|
|
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
|
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
|
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
|
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
|
|
|
<!ENTITY CHECK '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
|
<imageobject role="fo">
|
|
<imagedata fileref="figures/Check_mark_23x20_02.svg"
|
|
format="SVG" scale="60"/>
|
|
</imageobject>
|
|
<imageobject role="html">
|
|
<imagedata fileref="../figures/Check_mark_23x20_02.png"
|
|
format="PNG" />
|
|
</imageobject>
|
|
</inlinemediaobject>'>
|
|
|
|
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
|
<imageobject role="fo">
|
|
<imagedata fileref="figures/Arrow_east.svg"
|
|
format="SVG" scale="60"/>
|
|
</imageobject>
|
|
<imageobject role="html">
|
|
<imagedata fileref="../figures/Arrow_east.png"
|
|
format="PNG" />
|
|
</imageobject>
|
|
</inlinemediaobject>'>
|
|
<!ENTITY APIv2 'Networking API v2.0'>
|
|
]>
|
|
<section xml:id="binding_ext_ports"
|
|
xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
|
<title>The <literal>binding</literal> Extended Attributes for
|
|
Ports</title>
|
|
<para>Use the &APIv2; with the <parameter>binding</parameter>
|
|
extended attributes to get information about, create, and
|
|
update port objects.</para>
|
|
<para>The <parameter>binding</parameter>-prefixed extended
|
|
attributes for ports are:</para>
|
|
<table rules="all" width="95%">
|
|
<caption><parameter>binding</parameter> Extended Attributes
|
|
for Ports</caption>
|
|
<col width="30%"/>
|
|
<col width="10%"/>
|
|
<col width="10%"/>
|
|
<col width="10%"/>
|
|
<col width="10%"/>
|
|
<col width="10%"/>
|
|
<col width="20%"/>
|
|
<thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Required</th>
|
|
<th>CRUD<footnote xml:id="crud_network">
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><emphasis role="bold"
|
|
>C</emphasis>. Use the attribute in
|
|
create operations.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><emphasis role="bold"
|
|
>R</emphasis>. This attribute is
|
|
returned in response to show and
|
|
list operations.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><emphasis role="bold"
|
|
>U</emphasis>. You can update the
|
|
value of this attribute.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><emphasis role="bold"
|
|
>D</emphasis>. You can delete the
|
|
value of this attribute.</para>
|
|
</listitem>
|
|
</itemizedlist></para>
|
|
</footnote></th>
|
|
<th>Default Value</th>
|
|
<th>Validation Constraints</th>
|
|
<th>Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><para><parameter>binding:vif_type</parameter></para></td>
|
|
<td><para>String</para></td>
|
|
<td><para>N/A</para></td>
|
|
<td><para>R</para></td>
|
|
<td><para>None</para></td>
|
|
<td><para>N/A</para></td>
|
|
<td><para>Read-only. The vif type for the specified
|
|
port.</para>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<para><parameter>binding:host_id</parameter></para></td>
|
|
<td><para>uuid-str</para></td>
|
|
<td><para>N/A</para></td>
|
|
<td><para>CRU</para></td>
|
|
<td><para>None</para></td>
|
|
<td><para>N/A</para></td>
|
|
<td><para>The ID of the host where the port is
|
|
allocated. In some cases different
|
|
implementations can run on different
|
|
hosts.</para>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<para><parameter>binding:profile</parameter></para></td>
|
|
<td>list(dict)</td>
|
|
<td>N/A</td>
|
|
<td>CRU</td>
|
|
<td>None</td>
|
|
<td>N/A</td>
|
|
<td><para>A dictionary that enables the application
|
|
running on the specified host to pass and
|
|
receive vif port-specific information to the
|
|
plug-in.</para>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><parameter>binding:vif_details</parameter></para></td>
|
|
<td>list(dict)</td>
|
|
<td>N/A</td>
|
|
<td>R</td>
|
|
<td>None</td>
|
|
<td>None</td>
|
|
<td>
|
|
<para>Read-only. A dictionary that enables the
|
|
application to pass information about
|
|
functions that Networking API v2.0 provides.
|
|
Specify the following value:
|
|
<literal>port_filter : Boolean</literal>
|
|
to define whether Networking API v2.0 provides
|
|
port filtering features, such as security
|
|
group and anti-MAC/IP spoofing.</para>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><parameter>binding:vnic_type</parameter></para></td>
|
|
<td><para>String</para></td>
|
|
<td><para>N/A</para></td>
|
|
<td><para>CRU</para></td>
|
|
<td><para>normal</para></td>
|
|
<td><para>(normal, direct, macvtap)</para></td>
|
|
<td><para>The VNIC type to be bound on the neutron
|
|
port. To support SR-IOV PCI passthrough
|
|
networking, you can request that the neutron
|
|
port be realized as normal (virtual NIC),
|
|
direct (pci passthrough), or macvtap (virtual
|
|
interface with a tap-like software interface).
|
|
The ML2 plug-in supports the
|
|
vnic_type.</para></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/netconn-api/src/os-ports-binding-ext.wadl#Ports">
|
|
<wadl:method href="#listPorts"/>
|
|
<wadl:method href="#createPort"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/netconn-api/src/os-ports-binding-ext.wadl#port_id">
|
|
<wadl:method href="#showPort"/>
|
|
<wadl:method href="#updatePort"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|