python-openstackclient/doc/source/command-objects/port.rst
Richard Theis 5cc62d90b0 Support JSON data for port binding profile
Update the "--binding-profile" option on the "port create" and
"port set" commands to support both <key>=<value> and JSON input
for the port custom binding profile data. The JSON input is
sometimes needed to maintain the value type (e.g. integer) for
more advanced data.

The port custom binding profile data is unique across neutron
so a custom argparse.Action class was created instead of
writting a generic class in osc-lib.

Change-Id: I82ac6d4f95afdc866f5282fc00d390f850f54d21
Implements: blueprint neutron-client
2016-06-20 15:42:56 -05:00

4.2 KiB

port

A port is a connection point for attaching a single device, such as the NIC of a server, to a network. The port also describes the associated network configuration, such as the MAC and IP addresses to be used on that 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, default: normal)

--binding-profile <binding-profile>

Custom data to be passed as binding:profile. Data may be passed as <key>=<value> or JSON. (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 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, default: normal)

--binding-profile <binding-profile>

Custom data to be passed as binding:profile. Data may be passed as <key>=<value> or JSON. (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)