diff options
Diffstat (limited to 'doc/source/command-objects')
27 files changed, 548 insertions, 85 deletions
diff --git a/doc/source/command-objects/consistency-group-snapshot.rst b/doc/source/command-objects/consistency-group-snapshot.rst index 3d455038..29d50656 100644 --- a/doc/source/command-objects/consistency-group-snapshot.rst +++ b/doc/source/command-objects/consistency-group-snapshot.rst @@ -27,7 +27,7 @@ Create new consistency group snapshot. Description of this consistency group snapshot .. _consistency_group_snapshot_create-snapshot-name: -.. option:: <snapshot-name> +.. describe:: <snapshot-name> Name of new consistency group snapshot (default to None) diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst index 232cf8e4..57082c6d 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -62,7 +62,7 @@ Create new consistency group. (not available if creating consistency group from source) .. _consistency_group_create-name: -.. option:: <name> +.. describe:: <name> Name of new consistency group (default to None) diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index c4310472..e68955ad 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -51,7 +51,7 @@ List containers [--prefix <prefix>] [--marker <marker>] [--end-marker <end-marker>] - [--limit <limit>] + [--limit <num-containers>] [--long] [--all] @@ -67,7 +67,7 @@ List containers End anchor for paging -.. option:: --limit <limit> +.. option:: --limit <num-containers> Limit the number of containers returned diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst index b98055a1..02a75bea 100644 --- a/doc/source/command-objects/endpoint.rst +++ b/doc/source/command-objects/endpoint.rst @@ -11,7 +11,7 @@ Create new endpoint *Identity version 2 only* -.. program:: endpoint create +.. program:: endpoint create (v2) .. code:: bash openstack endpoint create @@ -44,7 +44,7 @@ Create new endpoint *Identity version 3 only* -.. program:: endpoint create +.. program:: endpoint create (v3) .. code:: bash openstack endpoint create diff --git a/doc/source/command-objects/extension.rst b/doc/source/command-objects/extension.rst index b7ba5c0a..36cf418b 100644 --- a/doc/source/command-objects/extension.rst +++ b/doc/source/command-objects/extension.rst @@ -39,3 +39,20 @@ List API extensions .. option:: --long List additional fields in output + +extension show +-------------- + +Show API extension + +.. program:: extension show +.. code:: bash + + openstack extension show + <extension> + +.. _extension_show: +.. describe:: <extension> + + Extension to display. Currently, only network extensions are supported. + (Name or Alias) diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index a9f8262e..6feb4498 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -108,8 +108,8 @@ List flavors openstack flavor list [--public | --private | --all] [--long] - [--marker <marker>] - [--limit <limit>] + [--marker <flavor-id>] + [--limit <num-flavors>] .. option:: --public @@ -127,11 +127,11 @@ List flavors List additional fields in output -.. option:: --marker <marker> +.. option:: --marker <flavor-id> The last flavor ID of the previous page -.. option:: --limit <limit> +.. option:: --limit <num-flavors> Maximum number of flavors to display diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst index 5a38bc1b..f2f101d3 100644 --- a/doc/source/command-objects/floating-ip.rst +++ b/doc/source/command-objects/floating-ip.rst @@ -15,8 +15,8 @@ Create floating IP openstack floating ip create [--subnet <subnet>] [--port <port>] - [--floating-ip-address <floating-ip-address>] - [--fixed-ip-address <fixed-ip-address>] + [--floating-ip-address <ip-address>] + [--fixed-ip-address <ip-address>] [--description <description>] [--project <project> [--project-domain <project-domain>]] <network> @@ -31,12 +31,12 @@ Create floating IP Port to be associated with the floating IP (name or ID) *Network version 2 only* -.. option:: --floating-ip-address <floating-ip-address> +.. option:: --floating-ip-address <ip-address> Floating IP address *Network version 2 only* -.. option:: --fixed-ip-address <fixed-ip-address> +.. option:: --fixed-ip-address <ip-address> Fixed IP address mapped to the floating IP *Network version 2 only* @@ -88,7 +88,7 @@ List floating IP(s) openstack floating ip list [--network <network>] [--port <port>] - [--fixed-ip-address <fixed-ip-address>] + [--fixed-ip-address <ip-address>] [--long] [--status <status>] [--project <project> [--project-domain <project-domain>]] @@ -106,7 +106,7 @@ List floating IP(s) *Network version 2 only* -.. option:: --fixed-ip-address <fixed-ip-address> +.. option:: --fixed-ip-address <ip-address> List floating IP(s) according to given fixed IP address @@ -143,6 +143,32 @@ List floating IP(s) *Network version 2 only* +floating ip set +--------------- + +Set floating IP properties + +.. program:: floating ip set +.. code:: bash + + openstack floating ip set + --port <port> + [--fixed-ip-address <ip-address>] + <floating-ip> + +.. option:: --port <port> + + Assocaite the floating IP with port (name or ID) + +.. option:: --fixed-ip-address <ip-address> + + Fixed IP of the port (required only if port has multiple IPs) + +.. _floating_ip_set-floating-ip: +.. describe:: <floating-ip> + + Floating IP to associate (IP address or ID) + floating ip show ---------------- @@ -156,3 +182,24 @@ Display floating IP details .. describe:: <floating-ip> Floating IP to display (IP address or ID) + +floating ip unset +----------------- + +Unset floating IP Properties + +.. program:: floating ip unset +.. code:: bash + + openstack floating ip unset + --port + <floating-ip> + +.. option:: --port + + Disassociate any port associated with the floating IP + +.. _floating_ip_unset-floating-ip: +.. describe:: <floating-ip> + + Floating IP to disassociate (IP address or ID) diff --git a/doc/source/command-objects/group.rst b/doc/source/command-objects/group.rst index 3c3199cf..ac938efd 100644 --- a/doc/source/command-objects/group.rst +++ b/doc/source/command-objects/group.rst @@ -16,7 +16,7 @@ Add user to group [--group-domain <group-domain>] [--user-domain <user-domain>] <group> - <user> + <user> [<user> ...] .. option:: --group-domain <group-domain> @@ -38,7 +38,8 @@ Add user to group .. describe:: <user> - User to add to <group> (name or ID) + User(s) to add to <group> (name or ID) + (repeat option to add multiple users) group contains user ------------------- @@ -172,7 +173,7 @@ Remove user from group [--group-domain <group-domain>] [--user-domain <user-domain>] <group> - <user> + <user> [<user> ...] .. option:: --group-domain <group-domain> @@ -194,7 +195,8 @@ Remove user from group .. describe:: <user> - User to remove from <group> (name or ID) + User(s) to remove from <group> (name or ID) + (repeat option to remove multiple users) group set --------- diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index c39d9a28..ec51fa93 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -199,8 +199,8 @@ List available images [--property <key=value>] [--long] [--sort <key>[:<direction>]] - [--limit <limit>] - [--marker <marker>] + [--limit <num-images>] + [--marker <image>] .. option:: --public @@ -229,14 +229,18 @@ List available images Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma -.. option:: --limit <limit> +.. option:: --limit <num-images> Maximum number of images to display. -.. option:: --marker <marker> + *Image version 2 only* - The last image (name or ID) of the previous page. Display list of images - after marker. Display all images if not specified. +.. option:: --marker <image> + + The last image of the previous page. Display list of images + after marker. Display all images if not specified. (name or ID) + + *Image version 2 only* image remove project -------------------- diff --git a/doc/source/command-objects/network-agent.rst b/doc/source/command-objects/network-agent.rst index 947e07cf..f69d0ece 100644 --- a/doc/source/command-objects/network-agent.rst +++ b/doc/source/command-objects/network-agent.rst @@ -10,6 +10,31 @@ agent is "True". Network v2 +network agent add network +------------------------- + +Add network to an agent + +.. program:: network agent add network +.. code:: bash + + openstack network agent add network + [--dhcp] + <agent-id> + <network> + +.. describe:: --dhcp + + Add a network to DHCP agent + +.. describe:: <agent-id> + + Agent to which a network is added (ID only) + +.. describe:: <network> + + Network to be added to an agent (ID or name) + network agent delete -------------------- @@ -37,6 +62,7 @@ List network agents openstack network agent list [--agent-type <agent-type>] [--host <host>] + [--network <network>] .. option:: --agent-type <agent-type> @@ -49,6 +75,10 @@ List network agents List only agents running on the specified host +.. option:: --network <network> + + List agents hosting a network (ID or name) + network agent set ----------------- @@ -94,3 +124,28 @@ Display network agent details .. describe:: <network-agent> Network agent to display (ID only) + +network agent remove network +---------------------------- + +Remove network from an agent + +.. program:: network agent remove network +.. code:: bash + + openstack network agent remove network + [--dhcp] + <agent-id> + <network> + +.. describe:: --dhcp + + Remove network from DHCP agent. + +.. describe:: <agent-id> + + Agent to which a network is removed (ID only) + +.. describe:: <network> + + Network to be removed from an agent (ID or name) diff --git a/doc/source/command-objects/network-flavor-profile.rst b/doc/source/command-objects/network-flavor-profile.rst new file mode 100644 index 00000000..fdb95059 --- /dev/null +++ b/doc/source/command-objects/network-flavor-profile.rst @@ -0,0 +1,145 @@ +====================== +network flavor profile +====================== + +A **network flavor profile** allows administrators to create, delete, list, +show and update network service profile, which details a framework to enable +operators to configure and users to select from different abstract +representations of a service implementation in the Networking service. +It decouples the logical configuration from its instantiation enabling +operators to create user options according to deployment needs. + +Network v2 + +network flavor profile create +----------------------------- + +Create a new network flavor profile + +.. program:: network flavor profile create +.. code:: bash + + openstack network flavor profile create + [--project <project> [--project-domain <project-domain>]] + [--description <description>] + [--enable | --disable] + (--driver <driver> | --metainfo <metainfo> | --driver <driver> --metainfo <metainfo>) + +.. option:: --project <project> + + Owner's project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). This can + be used in case collisions between project names + exist + +.. option:: --description <description> + + Description for the flavor profile + + *Network version 2 only* + +.. option:: --enable + + Enable the flavor profile (default) + +.. option:: --disable + + Disable the flavor profile + +.. option:: --driver <driver> + + Python module path to driver + + *Network version 2 only* + +.. option:: --metainfo <metainfo> + + Metainfo for the flavor profile + + *Network version 2 only* + + +network flavor profile delete +----------------------------- + +Delete network flavor profile + +.. program:: network flavor profile delete +.. code:: bash + + openstack network flavor profile delete + <flavor-profile-id> [<flavor-profile-id> ...] + +.. describe:: <flavor-profile-id> + + Flavor profile(s) to delete (ID only) + +network flavor profile list +--------------------------- + +List network flavor profiles + +.. program:: network flavor profile list +.. code:: bash + + openstack network flavor profile list + +network flavor profile set +-------------------------- + +Set network flavor profile properties + +.. program:: network flavor profile set +.. code:: bash + + openstack network flavor profile set + [--description <description>] + [--driver <driver>] + [--enable | --disable] + [--metainfo <metainfo>] + <flavor-profile-id> + + +.. option:: --description <description> + + Description of the flavor profile + +.. option:: --driver <driver> + + Python module path to driver + +.. option:: --enable (Default) + + Enable the flavor profile + +.. option:: --disable + + Disable the flavor profile + +.. option:: --metainfo <metainfo> + + Metainfo for the flavor profile + +.. describe:: <flavor-profile-id> + + Flavor profile to update (ID only) + +network flavor profile show +--------------------------- + +Show network flavor profile + +.. program:: network flavor profile show +.. code:: bash + + openstack network flavor profile show + <flavor-profile-id> + +.. describe:: <flavor-profile-id> + + Flavor profile to display (ID only) diff --git a/doc/source/command-objects/network-flavor.rst b/doc/source/command-objects/network-flavor.rst index 4567682c..2d23bf05 100644 --- a/doc/source/command-objects/network-flavor.rst +++ b/doc/source/command-objects/network-flavor.rst @@ -8,6 +8,28 @@ service flavors. Network v2 +network flavor add profile +-------------------------- + +Add network flavor to service profile + +.. program:: network flavor add profile +.. code:: bash + + openstack network flavor add profile + <flavor> + <service-profile-id> + +.. describe:: <flavor> + + Flavor to which service profile is added. (Name or ID) + +.. describe:: <service-profile-id> + + Service profile to be added to flavor. (ID only) + +.. _network_flavor_add_profile: + network flavor create --------------------- @@ -26,7 +48,7 @@ Create network flavor .. option:: --service-type <service-type> Service type to which the flavor applies to: e.g. VPN. - (See openstack :ref:`network_service_provider_list`) (required) + (See openstack :ref:`\<service providers\> <network_service_provider_list>`) (required) .. option:: --description <description> @@ -85,6 +107,28 @@ List network flavors .. _network_flavor_list: +network flavor remove profile +----------------------------- + +Remove network flavor from service profile + +.. program:: network flavor remove profile +.. code:: bash + + openstack network flavor remove profile + <flavor> + <service-profile-id> + +.. describe:: <flavor> + + Flavor from which service profile is removed. (Name or ID) + +.. describe:: <service-profile-id> + + Service profile to be removed from flavor. (ID only) + +.. _network_flavor_remove_profile: + network flavor set ------------------ diff --git a/doc/source/command-objects/network-qos-policy.rst b/doc/source/command-objects/network-qos-policy.rst index 7ec6776c..a75c32fe 100644 --- a/doc/source/command-objects/network-qos-policy.rst +++ b/doc/source/command-objects/network-qos-policy.rst @@ -73,6 +73,25 @@ List Network QoS policies .. code:: bash openstack network qos policy list + [--project <project> [--project-domain <project-domain>]] + [--share | --no-share] + +.. option:: --project <project> + + List qos policies according to their project (name or ID) + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --share + + List qos policies shared between projects + +.. option:: --no-share + + List qos policies not shared between projects network qos policy set ---------------------- diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index dc597443..9162dbff 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -203,6 +203,7 @@ List networks [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] + [--agent <agent-id>] .. option:: --external @@ -290,6 +291,10 @@ List networks *Network version 2 only* +.. option:: --agent <agent-id> + + List networks hosted by agent (ID only) + network set ----------- diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index 0a32a827..6323c4ed 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -62,7 +62,7 @@ List objects [--delimiter <delimiter>] [--marker <marker>] [--end-marker <end-marker>] - [--limit <limit>] + [--limit <num-objects>] [--long] [--all] <container> @@ -83,7 +83,7 @@ List objects End anchor for paging -.. option:: --limit <limit> +.. option:: --limit <num-objects> Limit number of objects returned diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 5080addb..b3f4c7f9 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -30,6 +30,7 @@ Create new port [--security-group <security-group> | --no-security-group] [--dns-name <dns-name>] [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]] + [--qos-policy <qos-policy>] [--project <project> [--project-domain <project-domain>]] [--enable-port-security | --disable-port-security] <name> @@ -44,7 +45,7 @@ Create new port .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address> - Desired IP and/or subnet (name or ID) for this port: + Desired IP and/or subnet for this port (name or ID): subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses) @@ -104,6 +105,10 @@ Create new port ip-address=<ip-address>[,mac-address=<mac-address>] (repeat option to set multiple allowed-address pairs) +.. option:: --qos-policy <qos-policy> + + Attach QoS policy to this port (name or ID) + .. option:: --project <project> Owner's project (name or ID) @@ -182,7 +187,7 @@ List ports .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address> - Desired IP and/or subnet (name or ID) for filtering ports: + Desired IP and/or subnet for filtering ports (name or ID): subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses) @@ -217,8 +222,10 @@ Set port properties [--binding-profile <binding-profile>] [--no-binding-profile] [--host <host-id>] + [--qos-policy <qos-policy>] [--enable | --disable] [--name <name>] + [--mac-address <mac-address>] [--security-group <security-group>] [--no-security-group] [--enable-port-security | --disable-port-security] @@ -233,7 +240,7 @@ Set port properties .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address> - Desired IP and/or subnet (name or ID) for this port: + Desired IP and/or subnet for this port (name or ID): subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses) @@ -273,6 +280,10 @@ Set port properties Allocate port on host ``<host-id>`` (ID only) +.. option:: --qos-policy <qos-policy> + + Attach QoS policy to this port (name or ID) + .. option:: --enable Enable port @@ -285,6 +296,10 @@ Set port properties Set port name +.. option:: --mac-address + + Set port's MAC address (admin only) + .. option:: --security-group <security-group> Security group to associate with this port (name or ID) @@ -354,12 +369,13 @@ Unset port properties [--binding-profile <binding-profile-key> [...]] [--security-group <security-group> [...]] [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>] [...]] + [--qos-policy] <port> .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address> - Desired IP and/or subnet (name or ID) which should be removed - from this port: subnet=<subnet>,ip-address=<ip-address> + Desired IP and/or subnet which should be removed + from this port (name or ID): subnet=<subnet>,ip-address=<ip-address> (repeat option to unset multiple fixed IP addresses) .. option:: --binding-profile <binding-profile-key> @@ -378,6 +394,10 @@ Unset port properties ip-address=<ip-address>[,mac-address=<mac-address>] (repeat option to unset multiple allowed-address pairs) +.. option:: --qos-policy + + Remove the QoS policy attached to the port + .. _port_unset-port: .. describe:: <port> diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index 1111fa59..cb0941ca 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -95,7 +95,9 @@ List projects openstack project list [--domain <domain>] [--user <user>] + [--my-projects] [--long] + [--sort <key>[:<direction>,<key>:<direction>,..]] .. option:: --domain <domain> @@ -109,10 +111,22 @@ List projects .. versionadded:: 3 +.. option:: --my-projects + + List projects for the authenticated user. Supersedes other filters. + + .. versionadded:: 3 + .. option:: --long List additional fields in output +.. option:: --sort <key>[:<direction>,<key>:<direction>,..] + + Sort output by selected keys and directions (asc or desc) (default: asc), + multiple keys and directions can be specified --sort + <key>[:<direction>,<key>:<direction>,..] + project set ----------- diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst index 70e28dd8..f39536af 100644 --- a/doc/source/command-objects/quota.rst +++ b/doc/source/command-objects/quota.rst @@ -7,6 +7,29 @@ single object with multiple properties. Block Storage v1, v2, Compute v2, Network v2 +quota list +---------- + +List quotas for all projects with non-default quota values + +.. program:: quota list +.. code:: bash + + openstack quota list + --compute | --network | --volume + +.. option:: --network + + List network quotas + +.. option:: --compute + + List compute quotas + +.. option:: --volume + + List volume quotas + quota set --------- diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index 9e8007af..50e791ea 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -63,8 +63,8 @@ Create new router openstack router create [--project <project> [--project-domain <project-domain>]] [--enable | --disable] - [--distributed] - [--ha] + [--distributed | --centralized] + [--ha | --no-ha] [--description <description>] [--availability-zone-hint <availability-zone>] <name> @@ -90,10 +90,27 @@ Create new router Create a distributed router + The default router type (distributed vs centralized) is determined by a + configuration setting in the OpenStack deployment. Since we are unable + to know that default wihtout attempting to actually create a router it + is suggested to use either :option:`--distributed` or :option:`--centralized` + in situations where multiple cloud deployments may be used. + +.. option:: --centralized + + Create a centralized router + + See the note in :option:`--distributed` regarding the default used when + creating a new router. + .. option:: --ha Create a highly available router +.. option:: --no-ha + + Create a legacy router + .. option:: --description <description> Set router description diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 3d2bbdf3..dc78080b 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -13,16 +13,21 @@ Add fixed IP address to server .. code:: bash openstack server add fixed ip + [--fixed-ip-address <ip-address>] <server> <network> +.. option:: --fixed-ip-address <ip-address> + + Requested fixed IP address + .. describe:: <server> - Server (name or ID) to receive the fixed IP address + Server to receive the fixed IP address (name or ID) .. describe:: <network> - Network (name or ID) to allocate the fixed IP address from + Network to allocate the fixed IP address from (name or ID) server add floating ip ---------------------- @@ -33,16 +38,41 @@ Add floating IP address to server .. code:: bash openstack server add floating ip + [--fixed-ip-address <ip-address>] <server> <ip-address> +.. option:: --fixed-ip-address <ip-address> + + Fixed IP address to associate with this floating IP address + .. describe:: <server> - Server (name or ID) to receive the floating IP address + Server to receive the floating IP address (name or ID) .. describe:: <ip-address> - Floating IP address (IP address only) to assign to server + Floating IP address to assign to server (IP only) + +server add port +--------------- + +Add port to server + +.. program:: server add port +.. code:: bash + + openstack server add port + <server> + <port> + +.. describe:: <server> + + Server to add the port to (name or ID) + +.. describe:: <port> + + Port to add to the server (name or ID) server add security group ------------------------- @@ -285,7 +315,7 @@ List servers [--project <project> [--project-domain <project-domain>]] [--long] [--marker <server>] - [--limit <limit>] + [--limit <num-servers>] [--deleted] [--changes-since <changes-since>] @@ -353,10 +383,10 @@ List servers .. option:: --marker <server> - The last server (name or ID) of the previous page. Display list of servers - after marker. Display all servers if not specified. + The last server of the previous page. Display list of servers + after marker. Display all servers if not specified. (name or ID) -.. option:: --limit <limit> +.. option:: --limit <num-servers> Maximum number of servers to display. If limit equals -1, all servers will be displayed. If limit is greater than 'osapi_max_limit' option of Nova @@ -518,11 +548,11 @@ Remove fixed IP address from server .. describe:: <server> - Server (name or ID) to remove the fixed IP address from + Server to remove the fixed IP address from (name or ID) .. describe:: <ip-address> - Fixed IP address (IP address only) to remove from the server + Fixed IP address to remove from the server (IP only) server remove floating ip ------------------------- @@ -538,11 +568,31 @@ Remove floating IP address from server .. describe:: <server> - Server (name or ID) to remove the floating IP address from + Server to remove the floating IP address from (name or ID) .. describe:: <ip-address> - Floating IP address (IP address only) to remove from server + Floating IP address to remove from server (IP only) + +server remove port +------------------ + +Remove port from server + +.. program:: server remove port +.. code:: bash + + openstack server remove port + <server> + <port> + +.. describe:: <server> + + Server to remove the port from (name or ID) + +.. describe:: <port> + + Port to remove from the server (name or ID) server remove security group ---------------------------- diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index c5c431d0..fc516067 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -72,8 +72,8 @@ List snapshots openstack snapshot list [--all-projects] [--long] - [--limit <limit>] - [--marker <marker>] + [--limit <num-snapshots>] + [--marker <snapshot>] .. option:: --all-projects @@ -83,13 +83,13 @@ List snapshots List additional fields in output -.. option:: --limit <limit> +.. option:: --limit <num-snapshots> Maximum number of snapshots to display *Volume version 2 only* -.. option:: --marker <marker> +.. option:: --marker <snapshot> The last snapshot ID of the previous page diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 8b59bf8a..d47673de 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -150,7 +150,7 @@ List subnet pools .. option:: --address-scope <address-scope> - List only subnet pools of given address scope (name or ID) in output + List only subnet pools of given address scope in output (name or ID) subnet pool set --------------- diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 5eb55c23..4e609361 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -194,7 +194,7 @@ List subnets .. option:: --project <project> - List only subnets which belong to a given project (name or ID) in output + List only subnets which belong to a given project in output (name or ID) .. option:: --project-domain <project-domain> @@ -203,7 +203,7 @@ List subnets .. option:: --network <network> - List only subnets which belong to a given network (name or ID) in output + List only subnets which belong to a given network in output (name or ID) .. option:: --gateway <gateway> diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst index f2f814c5..585f47d4 100644 --- a/doc/source/command-objects/volume-backup.rst +++ b/doc/source/command-objects/volume-backup.rst @@ -92,8 +92,8 @@ List volume backups [--name <name>] [--status <status>] [--volume <volume>] - [--marker <marker>] - [--limit <limit>] + [--marker <volume-backup>] + [--limit <num-backups>] [--all-projects] .. _volume_backup_list-backup: @@ -114,13 +114,13 @@ List volume backups Filters results by the volume which they backup (name or ID)" -.. option:: --marker <marker> +.. option:: --marker <volume-backup> The last backup of the previous page (name or ID) *Volume version 2 only* -.. option:: --limit <limit> +.. option:: --limit <num-backups> Maximum number of backups to display diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/command-objects/volume-snapshot.rst index 449e45b9..67db62f2 100644 --- a/doc/source/command-objects/volume-snapshot.rst +++ b/doc/source/command-objects/volume-snapshot.rst @@ -84,8 +84,8 @@ List volume snapshots [--all-projects] [--project <project> [--project-domain <project-domain>]] [--long] - [--limit <limit>] - [--marker <marker>] + [--limit <num-snapshots>] + [--marker <snapshot>] [--name <name>] [--status <status>] [--volume <volume>] @@ -125,13 +125,13 @@ List volume snapshots Filters results by a volume (name or ID). -.. option:: --limit <limit> +.. option:: --limit <num-snapshots> Maximum number of snapshots to display *Volume version 2 only* -.. option:: --marker <marker> +.. option:: --marker <snapshot> The last snapshot ID of the previous page diff --git a/doc/source/command-objects/volume-transfer-request.rst b/doc/source/command-objects/volume-transfer-request.rst index 77c36429..23cd3d3e 100644 --- a/doc/source/command-objects/volume-transfer-request.rst +++ b/doc/source/command-objects/volume-transfer-request.rst @@ -13,17 +13,19 @@ Accept volume transfer request .. code:: bash openstack volume transfer request accept - <transfer-request> - <auth-key> + --auth-key <key> + <transfer-request-id> -.. _volume_transfer_request_accept: -.. describe:: <transfer-request> +.. option:: --auth-key <key> - Volume transfer request to accept (name or ID) + Volume transfer request authentication key + +.. _volume_transfer_request_accept: +.. describe:: <transfer-request-id> -.. describe:: <auth-key> + Volume transfer request to accept (ID only) - Authentication key of transfer request + Non-admin users are only able to specify the transfer request by ID. volume transfer request create ------------------------------ @@ -65,7 +67,7 @@ Delete volume transfer request(s) volume transfer request list ---------------------------- -Lists all volume transfer requests. +Lists all volume transfer requests .. program:: volume transfer request list .. code:: bash @@ -75,8 +77,7 @@ Lists all volume transfer requests. .. option:: --all-projects - Shows detail for all projects. Admin only. - (defaults to False) + Include all projects (admin only) volume transfer request show ---------------------------- diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index 67598e63..a06a5d40 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -37,18 +37,18 @@ Create new volume Set the type of volume - Select :option:`\<volume-type\>` from the available types as shown + Select ``<volume-type>`` from the available types as shown by ``volume type list``. .. option:: --image <image> - Use :option:`\<image\>` as source of volume (name or ID) + Use ``<image>`` as source of volume (name or ID) This is commonly used to create a boot volume for a server. .. option:: --snapshot <snapshot> - Use :option:`\<snapshot\>` as source of volume (name or ID) + Use ``<snapshot>`` as source of volume (name or ID) .. option:: --source <volume> @@ -72,7 +72,7 @@ Create new volume .. option:: --availability-zone <availability-zone> - Create volume in :option:`\<availability-zone\>` + Create volume in ``<availability-zone>`` .. option:: --consistency-group <consistency-group> @@ -158,12 +158,12 @@ List volumes [--status <status>] [--all-projects] [--long] - [--limit <limit>] - [--marker <marker>] + [--limit <num-volumes>] + [--marker <volume>] .. option:: --project <project> - Filter results by :option:`\<project\>` (name or ID) (admin only) + Filter results by ``<project>`` (name or ID) (admin only) *Volume version 2 only* @@ -177,7 +177,7 @@ List volumes .. option:: --user <user> - Filter results by :option:`\<user\>` (name or ID) (admin only) + Filter results by ``<user>`` (name or ID) (admin only) *Volume version 2 only* @@ -205,11 +205,11 @@ List volumes List additional fields in output -.. option:: --limit <limit> +.. option:: --limit <num-volumes> Maximum number of volumes to display -.. option:: --marker <marker> +.. option:: --marker <volume> The last volume ID of the previous page @@ -337,8 +337,8 @@ Set volume properties (repeat option to set multiple image properties) Image properties are copied along with the image when creating a volume - using :option:`--image`. Note that these properties are immutable on the - image itself, this option updates the copy attached to this volume. + using ``--image``. Note that these properties are immutable on the image + itself, this option updates the copy attached to this volume. *Volume version 2 only* |