304305061d
Was accidentally removed at some point by me Change-Id: I70650c8675817059c472d17c0963c6498aeb383a Author: diane fleming
162 lines
7.4 KiB
XML
162 lines
7.4 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 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>Ports binding extended attributes (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>Ports binding extended attributes</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">
|
|
<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>
|
|
</footnote></th>
|
|
<th>Default value</th>
|
|
<th>Validation constraints</th>
|
|
<th>Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<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.</para>
|
|
<para>In &POST; and &PUT; operations, specify a
|
|
value of <literal>normal</literal> (virtual
|
|
nic), <literal>direct</literal> (pci
|
|
passthrough), or <literal>macvtap</literal>
|
|
(virtual interface with a tap-like software
|
|
interface). These values support SR-IOV PCI
|
|
passthrough networking. The ML2 plug-in
|
|
supports the
|
|
<parameter>vnic_type</parameter>.</para>
|
|
<para>In &GET; operations, the
|
|
<parameter>binding:vnic_type</parameter>
|
|
extended attribute is visible to only port
|
|
owners and administrative users.</para>
|
|
</td>
|
|
</tr>
|
|
<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>
|
|
<para>Visible to only administrative users.</para>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<para><parameter>binding:vif_details</parameter></para></td>
|
|
<td><para>list(dict)</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. A dictionary that enables the
|
|
application to pass information about
|
|
functions that &APIv2; provides. Specify the
|
|
following value: <code>port_filter :
|
|
Boolean</code> to define whether &APIv2;
|
|
provides port filtering features such as
|
|
security group and anti-MAC/IP
|
|
spoofing.</para>
|
|
<para>Visible to only administrative
|
|
users.</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>
|
|
<para>Visible to only administrative users.</para>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><parameter>binding:profile</parameter></para></td>
|
|
<td><para>list(dict)</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>A dictionary that enables the application to
|
|
pass information about functions that the
|
|
Networking API provides. To enable or disable
|
|
port filtering features such as security group
|
|
and anti-MAC/IP spoofing, specify
|
|
<code>port_filter: True</code> or
|
|
<code>port_filter: False</code>.</para>
|
|
<para>Visible to only administrative users.</para>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<wadl:resources
|
|
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/netconn-api/src/os-ports-binding-ext.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|