Merge "Doc: Update and add IP address"
This commit is contained in:
doc/source
openstackclient/compute/v2
45
doc/source/command-objects/ip-fixed.rst
Normal file
45
doc/source/command-objects/ip-fixed.rst
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
========
|
||||||
|
ip fixed
|
||||||
|
========
|
||||||
|
|
||||||
|
Compute v2
|
||||||
|
|
||||||
|
ip fixed add
|
||||||
|
------------
|
||||||
|
|
||||||
|
Add fixed IP address to server
|
||||||
|
|
||||||
|
.. program:: ip fixed add
|
||||||
|
.. code:: bash
|
||||||
|
|
||||||
|
os ip fixed add
|
||||||
|
<network>
|
||||||
|
<server>
|
||||||
|
|
||||||
|
.. describe:: <network>
|
||||||
|
|
||||||
|
Network to fetch an IP address from (name or ID)
|
||||||
|
|
||||||
|
.. describe:: <server>
|
||||||
|
|
||||||
|
Server to receive the IP address (name or ID)
|
||||||
|
|
||||||
|
ip fixed remove
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Remove fixed IP address from server
|
||||||
|
|
||||||
|
.. program:: ip fixed remove
|
||||||
|
.. code:: bash
|
||||||
|
|
||||||
|
os ip fixed remove
|
||||||
|
<ip-address>
|
||||||
|
<server>
|
||||||
|
|
||||||
|
.. describe:: <ip-address>
|
||||||
|
|
||||||
|
IP address to remove from server (name only)
|
||||||
|
|
||||||
|
.. describe:: <server>
|
||||||
|
|
||||||
|
Server to remove the IP address from (name or ID)
|
15
doc/source/command-objects/ip-floating-pool.rst
Normal file
15
doc/source/command-objects/ip-floating-pool.rst
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
================
|
||||||
|
ip floating pool
|
||||||
|
================
|
||||||
|
|
||||||
|
Compute v2
|
||||||
|
|
||||||
|
ip floating pool list
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
List pools of floating IP addresses
|
||||||
|
|
||||||
|
.. program:: ip floating pool list
|
||||||
|
.. code:: bash
|
||||||
|
|
||||||
|
os ip floating pool list
|
@@ -1,24 +1,24 @@
|
|||||||
==========
|
===========
|
||||||
floatingip
|
ip floating
|
||||||
==========
|
===========
|
||||||
|
|
||||||
Compute v2
|
Compute v2
|
||||||
|
|
||||||
ip floating add
|
ip floating add
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Add floating-ip to server
|
Add floating IP address to server
|
||||||
|
|
||||||
.. program:: ip floating add
|
.. program:: ip floating add
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
os ip floating add
|
os ip floating add
|
||||||
<ip_address>
|
<ip-address>
|
||||||
<server>
|
<server>
|
||||||
|
|
||||||
.. describe:: <ip_address>
|
.. describe:: <ip-address>
|
||||||
|
|
||||||
IP address to add to server
|
IP address to add to server (name only)
|
||||||
|
|
||||||
.. describe:: <server>
|
.. describe:: <server>
|
||||||
|
|
||||||
@@ -27,7 +27,7 @@ Add floating-ip to server
|
|||||||
ip floating create
|
ip floating create
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
Create new floating-ip
|
Create new floating IP address
|
||||||
|
|
||||||
.. program:: ip floating create
|
.. program:: ip floating create
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
@@ -37,27 +37,27 @@ Create new floating-ip
|
|||||||
|
|
||||||
.. describe:: <pool>
|
.. describe:: <pool>
|
||||||
|
|
||||||
Pool to fetch floating IP from
|
Pool to fetch IP address from (name or ID)
|
||||||
|
|
||||||
ip floating delete
|
ip floating delete
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
Delete a floating-ip
|
Delete a floating IP address
|
||||||
|
|
||||||
.. program:: ip floating delete
|
.. program:: ip floating delete
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
os ip floating delete
|
os ip floating delete
|
||||||
<ip_address>
|
<ip-address>
|
||||||
|
|
||||||
.. describe:: <ip_address>
|
.. describe:: <ip-address>
|
||||||
|
|
||||||
IP address to delete
|
IP address to delete (ID only)
|
||||||
|
|
||||||
ip floating list
|
ip floating list
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
List floating-ips
|
List floating IP addresses
|
||||||
|
|
||||||
.. program:: ip floating list
|
.. program:: ip floating list
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
@@ -67,18 +67,18 @@ List floating-ips
|
|||||||
ip floating remove
|
ip floating remove
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
Remove floating-ip from server
|
Remove floating IP address from server
|
||||||
|
|
||||||
.. program:: ip floating remove
|
.. program:: ip floating remove
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
os ip floating remove
|
os ip floating remove
|
||||||
<ip_address>
|
<ip-address>
|
||||||
<server>
|
<server>
|
||||||
|
|
||||||
.. describe:: <ip_address>
|
.. describe:: <ip-address>
|
||||||
|
|
||||||
IP address to remove from server
|
IP address to remove from server (name only)
|
||||||
|
|
||||||
.. describe:: <server>
|
.. describe:: <server>
|
||||||
|
|
@@ -91,13 +91,14 @@ referring to both Compute and Volume quotas.
|
|||||||
* ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes
|
* ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes
|
||||||
* ``identity provider``: (**Identity**) a source of users and authentication
|
* ``identity provider``: (**Identity**) a source of users and authentication
|
||||||
* ``image``: (**Image**) a disk image
|
* ``image``: (**Image**) a disk image
|
||||||
* ``ip fixed``: Compute, Network - an internal IP address assigned to a server
|
* ``ip fixed``: (**Compute**, **Network**) - an internal IP address assigned to a server
|
||||||
* ``ip floating``: Compute, Network - a public IP address that can be mapped to a server
|
* ``ip floating``: (**Compute**, **Network**) - a public IP address that can be mapped to a server
|
||||||
|
* ``ip floating pool``: (**Compute**, **Network**) - a pool of public IP addresses
|
||||||
* ``keypair``: (**Compute**) an SSH public key
|
* ``keypair``: (**Compute**) an SSH public key
|
||||||
* ``limits``: (**Compute**, **Volume**) resource usage limits
|
* ``limits``: (**Compute**, **Volume**) resource usage limits
|
||||||
* ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts
|
* ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts
|
||||||
* ``module``: internal - installed Python modules in the OSC process
|
* ``module``: internal - installed Python modules in the OSC process
|
||||||
* ``network``: Network - a virtual network for connecting servers and other resources
|
* ``network``: (**Network**) - a virtual network for connecting servers and other resources
|
||||||
* ``object``: (**Object Store**) a single file in the Object Store
|
* ``object``: (**Object Store**) a single file in the Object Store
|
||||||
* ``policy``: (**Identity**) determines authorization
|
* ``policy``: (**Identity**) determines authorization
|
||||||
* ``project``: (**Identity**) owns a group of resources
|
* ``project``: (**Identity**) owns a group of resources
|
||||||
@@ -106,8 +107,8 @@ referring to both Compute and Volume quotas.
|
|||||||
* ``request token``: (**Identity**) temporary OAuth-based token
|
* ``request token``: (**Identity**) temporary OAuth-based token
|
||||||
* ``role``: (**Identity**) a policy object used to determine authorization
|
* ``role``: (**Identity**) a policy object used to determine authorization
|
||||||
* ``role assignment``: (**Identity**) a relationship between roles, users or groups, and domains or projects
|
* ``role assignment``: (**Identity**) a relationship between roles, users or groups, and domains or projects
|
||||||
* ``security group``: Compute, Network - groups of network access rules
|
* ``security group``: (**Compute**, **Network**) - groups of network access rules
|
||||||
* ``security group rule``: Compute, Network - the individual rules that define protocol/IP/port access
|
* ``security group rule``: (**Compute**, **Network**) - the individual rules that define protocol/IP/port access
|
||||||
* ``server``: (**Compute**) virtual machine instance
|
* ``server``: (**Compute**) virtual machine instance
|
||||||
* ``server image``: (**Compute**) saved server disk image
|
* ``server image``: (**Compute**) saved server disk image
|
||||||
* ``service``: (**Identity**) a cloud service
|
* ``service``: (**Identity**) a cloud service
|
||||||
|
@@ -23,7 +23,7 @@ from openstackclient.common import utils
|
|||||||
|
|
||||||
|
|
||||||
class AddFixedIP(command.Command):
|
class AddFixedIP(command.Command):
|
||||||
"""Add fixed-ip command"""
|
"""Add fixed IP address to server"""
|
||||||
|
|
||||||
log = logging.getLogger(__name__ + ".AddFixedIP")
|
log = logging.getLogger(__name__ + ".AddFixedIP")
|
||||||
|
|
||||||
@@ -32,12 +32,12 @@ class AddFixedIP(command.Command):
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"network",
|
"network",
|
||||||
metavar="<network>",
|
metavar="<network>",
|
||||||
help="Name of the network to fetch an IP address from",
|
help="Network to fetch an IP address from (name or ID)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"server",
|
"server",
|
||||||
metavar="<server>",
|
metavar="<server>",
|
||||||
help="Name of the server to receive the IP address",
|
help="Server to receive the IP address (name or ID)",
|
||||||
)
|
)
|
||||||
return parser
|
return parser
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ class AddFixedIP(command.Command):
|
|||||||
|
|
||||||
|
|
||||||
class RemoveFixedIP(command.Command):
|
class RemoveFixedIP(command.Command):
|
||||||
"""Remove fixed-ip command"""
|
"""Remove fixed IP address from server"""
|
||||||
|
|
||||||
log = logging.getLogger(__name__ + ".RemoveFixedIP")
|
log = logging.getLogger(__name__ + ".RemoveFixedIP")
|
||||||
|
|
||||||
@@ -65,12 +65,12 @@ class RemoveFixedIP(command.Command):
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"ip_address",
|
"ip_address",
|
||||||
metavar="<ip-address>",
|
metavar="<ip-address>",
|
||||||
help="IP address to remove from server",
|
help="IP address to remove from server (name only)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"server",
|
"server",
|
||||||
metavar="<server>",
|
metavar="<server>",
|
||||||
help="Name of the server to remove the IP address from",
|
help="Server to remove the IP address from (name or ID)",
|
||||||
)
|
)
|
||||||
return parser
|
return parser
|
||||||
|
|
||||||
|
@@ -26,7 +26,7 @@ from openstackclient.common import utils
|
|||||||
|
|
||||||
|
|
||||||
class AddFloatingIP(command.Command):
|
class AddFloatingIP(command.Command):
|
||||||
"""Add floating-ip to server"""
|
"""Add floating IP address to server"""
|
||||||
|
|
||||||
log = logging.getLogger(__name__ + ".AddFloatingIP")
|
log = logging.getLogger(__name__ + ".AddFloatingIP")
|
||||||
|
|
||||||
@@ -35,7 +35,7 @@ class AddFloatingIP(command.Command):
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"ip_address",
|
"ip_address",
|
||||||
metavar="<ip-address>",
|
metavar="<ip-address>",
|
||||||
help="IP address to add to server",
|
help="IP address to add to server (name only)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"server",
|
"server",
|
||||||
@@ -56,7 +56,7 @@ class AddFloatingIP(command.Command):
|
|||||||
|
|
||||||
|
|
||||||
class CreateFloatingIP(show.ShowOne):
|
class CreateFloatingIP(show.ShowOne):
|
||||||
"""Create new floating-ip"""
|
"""Create new floating IP address"""
|
||||||
|
|
||||||
log = logging.getLogger(__name__ + '.CreateFloatingIP')
|
log = logging.getLogger(__name__ + '.CreateFloatingIP')
|
||||||
|
|
||||||
@@ -65,7 +65,7 @@ class CreateFloatingIP(show.ShowOne):
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
'pool',
|
'pool',
|
||||||
metavar='<pool>',
|
metavar='<pool>',
|
||||||
help='Pool to fetch floating IP from',
|
help='Pool to fetch IP address from (name or ID)',
|
||||||
)
|
)
|
||||||
return parser
|
return parser
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ class CreateFloatingIP(show.ShowOne):
|
|||||||
|
|
||||||
|
|
||||||
class DeleteFloatingIP(command.Command):
|
class DeleteFloatingIP(command.Command):
|
||||||
"""Delete a floating-ip"""
|
"""Delete a floating IP address"""
|
||||||
|
|
||||||
log = logging.getLogger(__name__ + '.DeleteFloatingIP')
|
log = logging.getLogger(__name__ + '.DeleteFloatingIP')
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ class DeleteFloatingIP(command.Command):
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"ip_address",
|
"ip_address",
|
||||||
metavar="<ip-address>",
|
metavar="<ip-address>",
|
||||||
help="IP address to delete",
|
help="IP address to delete (ID only)",
|
||||||
)
|
)
|
||||||
return parser
|
return parser
|
||||||
|
|
||||||
@@ -107,7 +107,7 @@ class DeleteFloatingIP(command.Command):
|
|||||||
|
|
||||||
|
|
||||||
class ListFloatingIP(lister.Lister):
|
class ListFloatingIP(lister.Lister):
|
||||||
"""List floating-ips"""
|
"""List floating IP addresses"""
|
||||||
|
|
||||||
log = logging.getLogger(__name__ + '.ListFloatingIP')
|
log = logging.getLogger(__name__ + '.ListFloatingIP')
|
||||||
|
|
||||||
@@ -127,7 +127,7 @@ class ListFloatingIP(lister.Lister):
|
|||||||
|
|
||||||
|
|
||||||
class RemoveFloatingIP(command.Command):
|
class RemoveFloatingIP(command.Command):
|
||||||
"""Remove floating-ip from server"""
|
"""Remove floating IP address from server"""
|
||||||
|
|
||||||
log = logging.getLogger(__name__ + ".RemoveFloatingIP")
|
log = logging.getLogger(__name__ + ".RemoveFloatingIP")
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ class RemoveFloatingIP(command.Command):
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"ip_address",
|
"ip_address",
|
||||||
metavar="<ip-address>",
|
metavar="<ip-address>",
|
||||||
help="IP address to remove from server",
|
help="IP address to remove from server (name only)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"server",
|
"server",
|
||||||
|
@@ -23,7 +23,7 @@ from openstackclient.common import utils
|
|||||||
|
|
||||||
|
|
||||||
class ListFloatingIPPool(lister.Lister):
|
class ListFloatingIPPool(lister.Lister):
|
||||||
"""List floating-ip-pools"""
|
"""List pools of floating IP addresses"""
|
||||||
|
|
||||||
log = logging.getLogger(__name__ + '.ListFloatingIPPool')
|
log = logging.getLogger(__name__ + '.ListFloatingIPPool')
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user