Richard Theis 6b76860c45 Doc: Fix network command documentation issues
Fix the following network command documentation issues:
  - Fix format of subnet pool positional arguments
  - Update port set options to match help
  - Fix network command documentation for Network v2
    versus Compute v2 options and commands
  - Fix subnet command documentation errors and formatting
    problems in help text

Change-Id: I808c2a70ca62eafc9e42d6873539cdd142ffe50c
Related-Bug: #1558677
2016-04-08 08:00:17 -05:00

3.9 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> (this option can be repeated)

--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> (this option can be repeated)

--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> (this option can be repeated)

--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> (this option can be repeated)

--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)