diff options
Diffstat (limited to 'doc/source/cli/command-objects')
3 files changed, 193 insertions, 6 deletions
diff --git a/doc/source/cli/command-objects/compute-service.rst b/doc/source/cli/command-objects/compute-service.rst index 51d5c864..a76a9c26 100644 --- a/doc/source/cli/command-objects/compute-service.rst +++ b/doc/source/cli/command-objects/compute-service.rst @@ -18,13 +18,19 @@ Delete compute service(s) .. _compute_service_delete-service: .. describe:: <service> - Compute service(s) to delete (ID only) + Compute service(s) to delete (ID only). If using + ``--os-compute-api-version`` 2.53 or greater, the ID is a UUID which can + be retrieved by listing compute services using the same 2.53+ microversion. compute service list -------------------- List compute services +Using ``--os-compute-api-version`` 2.53 or greater will return the ID as a +UUID value which can be used to uniquely identify the service in a multi-cell +deployment. + .. program:: compute service list .. code:: bash @@ -74,11 +80,12 @@ Set compute service properties .. option:: --up - Force up service + Force up service. Requires ``--os-compute-api-version`` 2.11 or greater. .. option:: --down - Force down service + Force down service. . Requires ``--os-compute-api-version`` 2.11 or + greater. .. _compute_service_set-host: .. describe:: <host> diff --git a/doc/source/cli/command-objects/floating-ip-port-forwarding.rst b/doc/source/cli/command-objects/floating-ip-port-forwarding.rst new file mode 100644 index 00000000..5012787a --- /dev/null +++ b/doc/source/cli/command-objects/floating-ip-port-forwarding.rst @@ -0,0 +1,173 @@ +=========================== +floating ip port forwarding +=========================== + +Network v2 + +floating ip port forwarding create +---------------------------------- + +Create floating IP Port Forwarding + +.. program:: floating ip port forwarding create +.. code:: bash + + openstack floating ip port forwarding create + --internal-ip-address <internal-ip-address> + --port <port> + --internal-protocol-port <port-number> + --external-protocol-port <port-number> + --protocol <protocol> + <floating-ip> + + +.. describe:: --internal-ip-address <internal-ip-address> + + The fixed IPv4 address of the network port associated + to the floating IP port forwarding + +.. describe:: --port <port> + + The name or ID of the network port associated to the + floating IP port forwarding + +.. describe:: --internal-protocol-port <port-number> + + The protocol port number of the network port fixed + IPv4 address associated to the floating IP port + forwarding + +.. describe:: --external-protocol-port <port-number> + + The protocol port number of the port forwarding's + floating IP address + +.. describe:: --protocol <protocol> + + The protocol used in the floating IP port forwarding, + for instance: TCP, UDP + +.. describe:: <floating-ip> + + Floating IP that the port forwarding belongs to (IP + address or ID) + +floating ip port forwarding delete +---------------------------------- + +Delete floating IP Port Forwarding(s) + +.. program:: floating ip port forwarding delete +.. code:: bash + + openstack floating ip port forwarding delete <floating-ip> + <port-forwarding-id> [<port-forwarding-id> ...] + +.. describe:: <floating-ip> + + Floating IP that the port forwarding belongs to (IP + address or ID) + +.. describe:: <port-forwarding-id> + + The ID of the floating IP port forwarding + +floating ip port forwarding list +-------------------------------- + +List floating IP Port Forwarding(s) + +.. program:: floating ip port forwarding list +.. code:: bash + + openstack floating ip port forwarding list + [--port <port>] + [--external-protocol-port <port-number>] + [--protocol protocol] + <floating-ip> + +.. option:: --port <port> + + The ID of the network port associated to the floating + IP port forwarding + +.. option:: --protocol <protocol> + + The IP protocol used in the floating IP port + forwarding + +.. describe:: <floating-ip> + + Floating IP that the port forwarding belongs to (IP + address or ID) + +floating ip port forwarding set +------------------------------- + +Set floating IP Port Forwarding properties + +.. program:: floating ip port forwarding set +.. code:: bash + + openstack floating ip port forwarding set + [--port <port>] + [--internal-ip-address <internal-ip-address>] + [--internal-protocol-port <port-number>] + [--external-protocol-port <port-number>] + [--protocol <protocol>] + <floating-ip> + <port-forwarding-id> + +.. option:: --port <port> + + The ID of the network port associated to the floating + IP port forwarding + +.. option:: --internal-ip-address <internal-ip-address> + + The fixed IPv4 address of the network port associated + to the floating IP port forwarding + +.. option:: --internal-protocol-port <port-number> + + The TCP/UDP/other protocol port number of the network + port fixed IPv4 address associated to the floating IP + port forwarding + +.. option:: --external-protocol-port <port-number> + + The TCP/UDP/other protocol port number of the port + forwarding's floating IP address + +.. option:: --protocol <protocol> + + The IP protocol used in the floating IP port + forwarding + +.. describe:: <floating-ip> + + Floating IP that the port forwarding belongs to (IP + address or ID) + +.. describe:: <port-forwarding-id> + + The ID of the floating IP port forwarding + +floating ip port forwarding show +-------------------------------- + +Display floating IP Port Forwarding details + +.. program:: floating ip port forwarding show +.. code:: bash + + openstack floating ip show <floating-ip> <port-forwarding-id> + +.. describe:: <floating-ip> + + Floating IP that the port forwarding belongs to (IP + address or ID) + +.. describe:: <port-forwarding-id> + + The ID of the floating IP port forwarding diff --git a/doc/source/cli/command-objects/security-group-rule.rst b/doc/source/cli/command-objects/security-group-rule.rst index 5809e002..5a2d8342 100644 --- a/doc/source/cli/command-objects/security-group-rule.rst +++ b/doc/source/cli/command-objects/security-group-rule.rst @@ -27,8 +27,9 @@ Create a new security group rule .. option:: --remote-ip <ip-address> - Remote IP address block - (may use CIDR notation; default for IPv4 rule: 0.0.0.0/0) + Remote IP address block (may use CIDR notation; + default for IPv4 rule: 0.0.0.0/0, + default for IPv6 rule: ::/0) .. option:: --remote-group <group> @@ -134,6 +135,7 @@ List security group rules openstack security group rule list [--all-projects] [--protocol <protocol>] + [--ethertype <ethertype>] [--ingress | --egress] [--long] [<group>] @@ -151,7 +153,6 @@ List security group rules *Compute version 2 does not have additional fields to display.* - .. option:: --protocol List rules by the IP protocol (ah, dhcp, egp, esp, gre, icmp, igmp, @@ -161,6 +162,12 @@ List security group rules *Network version 2* +.. option:: --ethertype + + List rules by the Ethertype (IPv4 or IPv6) + + *Network version 2* + .. option:: --ingress List rules applied to incoming network traffic |