[ovs-dev] [PATCH 4/6] Update sbctl man page for physical endpts and binding to logical ports

[Darrell Ball]

Adding ovs dev





On 3/15/16, 4:28 PM, "Darrell Ball" <dlu998 at gmail.com> wrote:

>Signed-off-by: Darrell Ball <dball at vmware.com>
>---
> ovn/utilities/ovn-sbctl.8.in | 48 ++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 48 insertions(+)
>
>diff --git a/ovn/utilities/ovn-sbctl.8.in b/ovn/utilities/ovn-sbctl.8.in
>index e4e4431..67c78ee 100644
>--- a/ovn/utilities/ovn-sbctl.8.in
>+++ b/ovn/utilities/ovn-sbctl.8.in
>@@ -131,6 +131,30 @@ Without \fB\-\-if\-exists\fR, attempting to delete a chassis that does
> not exist is an error.  With \fB\-\-if\-exists\fR, attempting to
> delete a chassis that does not exist has no effect.
> .
>+.SS "Physical Endpoint Commands"
>+These commands manipulate \fBOVN_Southbound\fR physical endpoint.
>+.
>+.IP "[\fB\-\-may\-exist\fR] \fBphys\-endpt\-add \fIphys\-endpt\fR \fIchassis\fR \fIchassis\-port\fR \fIencap\-type\fR \fIingress\-encap\fR \fIegress\-encap\fR"
>+Creates a new physical endpoint named \fIphys\-endpt\fR.  \fIchassis\fR is a
>+chassis name on a physical network edge, such as localnet or gateway.
>+\fIchassis\-port\fR is a chassis port on a physical edge.
>+\fIencap\-type\fR is a type of encap such as vlan, double vlan, mpls or one
>+of several IP tunnel encaps. \fIingress\-encap\fR is the
>+ingress encap value. \fIegress\-encap\fR is the egress encap value.
>+Both encap values may be the same in some cases.
>+Chassis and chassis-port are optional arguments.
>+.IP
>+Without \fB\-\-may\-exist\fR, attempting to create a phys-endpt
>+that exists is an error.  With \fB\-\-may\-exist\fR, this command does
>+nothing if phys-endpt already exists.
>+.
>+.IP "[\fB\-\-if\-exists\fR] \fBphys\-endpt\-del \fIphys\-endpt\fR"
>+Deletes \fIphys\-endpt\fR.
>+.IP
>+Without \fB\-\-if\-exists\fR, attempting to delete a phys-endpt that does
>+not exist is an error.  With \fB\-\-if\-exists\fR, attempting to
>+delete a phys-endpt that does not exist has no effect.
>+.
> .SS "Port binding Commands"
> .
> These commands manipulate \fBOVN_Southbound\fR port bindings.
>@@ -150,6 +174,30 @@ Without \fB\-\-if\-exists\fR, attempting to unbind a logical port
> that is not bound is an error.  With \fB\-\-if\-exists\fR, attempting
> to unbind logical port that is not bound has no effect.
> .
>+.SS "Port binding to physical endpoint Commands"
>+.
>+These commands manipulate \fBOVN_Southbound\fR port binding to physical endpoints.
>+.
>+.IP "[\fB\-\-may\-exist\fR] \fBlport\-bind\-phys\-endpt \fIlogical\-port\fR \fIphys\-endpt\fR"
>+Binds the logical port named \fIlogical\-port\fR to \fIphys\-endpts\fR, which
>+is a common separated list of physical endpoints. Localnet logical ports
>+can be bound to zero, one or more than one physical endpoint. If no
>+physical endpoint is bound for localnet, the encap is empty. A single
>+name for a localnet port implies a single encap; multiple names allow
>+different encaps. Gateway logical ports should be bound to one physical
>+endpoint for the gateway to function properly.
>+.IP
>+Without \fB\-\-may\-exist\fR, attempting to bind a logical port that
>+has already been bound is an error.  With \fB\-\-may\-exist\fR, this
>+command does nothing if \fIlogical\-port\fR has already been bound.
>+.
>+.IP "[\fB\-\-if\-exists\fR] \fBlport\-unbind\-phys\-endpt\fR \fIlogical\-port\fR"
>+Resets the binding of \fIlogical\-port\fR to \fINULL\fR.
>+.IP
>+Without \fB\-\-if\-exists\fR, attempting to unbind a logical port
>+that is not bound is an error.  With \fB\-\-if\-exists\fR, attempting
>+to unbind logical port that is not bound has no effect.
>+.
> .SS "Logical Flow Commands"
> .
> .IP "\fBlflow\-list\fR [\fIlogical\-datapath\fR]"
>-- 
>1.9.1
>