Tang Chen 32c627eaf0 Doc: Unify repeatable option comments
There are lots of "this option can be repeated" comments
in the doc, which are not consistent to other similar
docs.

This patch changes them to the following format:

"repeat option to do something"

Change-Id: I54e01053091c428bf87bb36bb95f73a0b80ab6e7
2016-04-12 15:57:17 +08:00

4.0 KiB

port

Network v2

port create

Create new port

port create

os port create
    --network <network>
    [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
    [--device <device-id>]
    [--device-owner <device-owner>]
    [--vnic-type <vnic-type>]
    [--binding-profile <binding-profile>]
    [--host <host-id>]
    [--enable | --disable]
    [--mac-address <mac-address>]
    [--project <project> [--project-domain <project-domain>]]
    <name>

--network <network>

Network this port belongs to (name or ID)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired IP and/or subnet (name or ID) for this port: subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)

--device <device-id>

Port device ID

--device-owner <device-owner>

Device owner of this port

--vnic-type <vnic-type>

VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal). If unspecified during port creation, default value will be 'normal'.

--binding-profile <binding-profile>

Custom data to be passed as binding:profile: <key>=<value> (repeat option to set multiple binding:profile data)

--host <host-id>

Allocate port on host <host-id> (ID only)

--enable

Enable port (default)

--disable

Disable port

--mac-address <mac-address>

MAC address of this port

--project <project>

Owner's project (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

Name of this port

port delete

Delete port(s)

port delete

os port delete
    <port> [<port> ...]




Port(s) to delete (name or ID)

port list

List ports

port list

os port list
    [--router <router>]

--router <router>

List only ports attached to this router (name or ID)

port set

Set port properties

port set

os port set
    [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip]
    [--device <device-id>]
    [--device-owner <device-owner>]
    [--vnic-type <vnic-type>]
    [--binding-profile <binding-profile> | --no-binding-profile]
    [--host <host-id>]
    [--enable | --disable]
    [--name <name>]
    <port>

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired IP and/or subnet (name or ID) for this port: subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)

--no-fixed-ip

Clear existing information of fixed-ips

--device <device-id>

Port device ID

--device-owner <device-owner>

Device owner of this port

--vnic-type <vnic-type>

VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal). If unspecified during port creation, default value will be 'normal'.

--binding-profile <binding-profile>

Custom data to be passed as binding:profile: <key>=<value> (repeat option to set multiple binding:profile data)

--no-binding-profile

Clear existing information of binding:profile

--host <host-id>

Allocate port on host <host-id> (ID only)

--enable

Enable port

--disable

Disable port

--name

Set port name

Port to modify (name or ID)

port show

Display port details

port show

os port show
    <port>




Port to display (name or ID)