diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/address-scope.rst | 120 | ||||
| -rw-r--r-- | doc/source/command-objects/credential.rst (renamed from doc/source/command-objects/credentials.rst) | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/endpoint.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/flavor.rst | 22 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 27 | ||||
| -rw-r--r-- | doc/source/command-objects/network-segment.rst | 54 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 22 | ||||
| -rw-r--r-- | doc/source/command-objects/quota.rst | 50 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 42 | ||||
| -rw-r--r-- | doc/source/command-objects/server-backup.rst | 44 | ||||
| -rw-r--r-- | doc/source/command-objects/server-group.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/snapshot.rst | 11 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 12 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 4 |
16 files changed, 408 insertions, 27 deletions
diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/command-objects/address-scope.rst new file mode 100644 index 00000000..7481ed53 --- /dev/null +++ b/doc/source/command-objects/address-scope.rst @@ -0,0 +1,120 @@ +============= +address scope +============= + +An **address scope** is a scope of IPv4 or IPv6 addresses that belongs +to a given project and may be shared between projects. + +Network v2 + +address scope create +-------------------- + +Create new address scope + +.. program:: address scope create +.. code:: bash + + os address scope create + [--project <project> [--project-domain <project-domain>]] + [--ip-version <ip-version>] + [--share | --no-share] + <name> + +.. option:: --project <project> + + Owner's 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:: --ip-version <ip-version> + + IP version (4 or 6, default is 4) + +.. option:: --share + + Share the address scope between projects + +.. option:: --no-share + + Do not share the address scope between projects (default) + +.. _address_scope_create-name: +.. describe:: <name> + + New address scope name + +address scope delete +-------------------- + +Delete address scope(s) + +.. program:: address scope delete +.. code:: bash + + os address scope delete + <address-scope> [<address-scope> ...] + +.. _address_scope_delete-address-scope: +.. describe:: <address-scope> + + Address scope(s) to delete (name or ID) + +address scope list +------------------ + +List address scopes + +.. program:: address scope list +.. code:: bash + + os address scope list + +address scope set +----------------- + +Set address scope properties + +.. program:: address scope set +.. code:: bash + + os address scope set + [--name <name>] + [--share | --no-share] + <address-scope> + +.. option:: --name <name> + + Set address scope name + +.. option:: --share + + Share the address scope between projects + +.. option:: --no-share + + Do not share the address scope between projects + +.. _address_scope_set-address-scope: +.. describe:: <address-scope> + + Address scope to modify (name or ID) + +address scope show +------------------ + +Display address scope details + +.. program:: address scope show +.. code:: bash + + os address scope show + <address-scope> + +.. _address_scope_show-address-scope: +.. describe:: <address-scope> + + Address scope to display (name or ID) diff --git a/doc/source/command-objects/credentials.rst b/doc/source/command-objects/credential.rst index 9f4aabe4..ed8a00db 100644 --- a/doc/source/command-objects/credentials.rst +++ b/doc/source/command-objects/credential.rst @@ -1,27 +1,27 @@ =========== -credentials +credential =========== Identity v3 -credentials create +credential create ------------------ .. ''[consider rolling the ec2 creds into this too]'' .. code:: bash - os credentials create + os credential create --x509 [<private-key-file>] [<certificate-file>] -credentials show +credential show ---------------- .. code:: bash - os credentials show + os credential show [--token] [--user] [--x509 [--root]] diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst index 074f20a0..9872a587 100644 --- a/doc/source/command-objects/endpoint.rst +++ b/doc/source/command-objects/endpoint.rst @@ -188,9 +188,9 @@ Display endpoint details .. code:: bash os endpoint show - <endpoint-id> + <endpoint> .. _endpoint_show-endpoint: -.. describe:: <endpoint-id> +.. describe:: <endpoint> - Endpoint ID to display + Endpoint to display (endpoint ID, service ID, service name, service type) diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index 322943d7..a30bedec 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -128,12 +128,23 @@ Set flavor properties os flavor set [--property <key=value> [...] ] + [--project <project>] + [--project-domain <project-domain>] <flavor> .. option:: --property <key=value> Property to add or modify for this flavor (repeat option to set multiple properties) +.. option:: --project <project> + + Set flavor access to project (name or ID) (admin 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. + .. describe:: <flavor> Flavor to modify (name or ID) @@ -164,12 +175,23 @@ Unset flavor properties os flavor unset [--property <key> [...] ] + [--project <project>] + [--project-domain <project-domain>] <flavor> .. option:: --property <key> Property to remove from flavor (repeat option to remove multiple properties) +.. option:: --project <project> + + Remove flavor access from project (name or ID) (admin 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. + .. describe:: <flavor> Flavor to modify (name or ID) diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 942c03d5..d6451af7 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -499,3 +499,30 @@ Display image details .. describe:: <image> Image to display (name or ID) + +image unset +----------- + +*Only supported for Image v2* + +Unset image tags or properties + +.. program:: image unset +.. code:: bash + + os image set + [--tag <tag>] + [--property <property>] + <image> + +.. option:: --tag <tag> + + Unset a tag on this image (repeat option to unset multiple tags) + +.. option:: --property <property> + + Unset a property on this image (repeat option to unset multiple properties) + +.. describe:: <image> + + Image to modify (name or ID) diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/command-objects/network-segment.rst new file mode 100644 index 00000000..56a11e1e --- /dev/null +++ b/doc/source/command-objects/network-segment.rst @@ -0,0 +1,54 @@ +=============== +network segment +=============== + +A **network segment** is an isolated Layer 2 segment within a network. +A network may contain multiple network segments. Depending on the +network configuration, Layer 2 connectivity between network segments +within a network may not be guaranteed. + +Network v2 + +network segment list +-------------------- + +List network segments + +.. caution:: This is a beta command and subject to change. + Use global option ``--os-beta-command`` to + enable this command. + +.. program:: network segment list +.. code:: bash + + os network segment list + [--long] + [--network <network>] + +.. option:: --long + + List additional fields in output + +.. option:: --network <network> + + List network segments that belong to this network (name or ID) + +network segment show +-------------------- + +Display network segment details + +.. caution:: This is a beta command and subject to change. + Use global option ``--os-beta-command`` to + enable this command. + +.. program:: network segment show +.. code:: bash + + os network segment show + <network-segment> + +.. _network_segment_show-segment: +.. describe:: <network-segment> + + Network segment to display (ID only) diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 91eb2b08..8668daee 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -28,6 +28,7 @@ Create new network [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] + [--transparent-vlan | --no-transparent-vlan] <name> .. option:: --project <project> @@ -123,6 +124,18 @@ Create new network *Network version 2 only* +.. option:: --transparent-vlan + + Make the network VLAN transparent + + *Network version 2 only* + +.. option:: --no-transparent-vlan + + Do not make the network VLAN transparent + + *Network version 2 only* + .. _network_create-name: .. describe:: <name> @@ -182,6 +195,7 @@ Set network properties [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] + [--transparent-vlan | --no-transparent-vlan] <network> .. option:: --name <name> @@ -234,6 +248,14 @@ Set network properties VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks +.. option:: --transparent-vlan + + Make the network VLAN transparent + +.. option:: --no-transparent-vlan + + Do not make the network VLAN transparent + .. _network_set-network: .. describe:: <network> diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst index 9e09bd48..dc5e3623 100644 --- a/doc/source/command-objects/quota.rst +++ b/doc/source/command-objects/quota.rst @@ -32,6 +32,20 @@ Set quotas for project [--volumes <new-volumes>] [--volume-type <volume-type>] + # Network settings + [--floating-ips <num-floatingips>] + [--secgroup-rules <num-security-group-rules>] + [--secgroups <num-security-groups>] + [--networks <num-networks>] + [--subnets <num-subnets>] + [--ports <num-ports>] + [--routers <num-routers>] + [--rbac-policies <num-rbac-policies>] + [--vips <num-vips>] + [--subnetpools <num-subnetpools>] + [--members <num-members>] + [--health-monitors <num-health-monitors>] + <project> Set quotas for class @@ -126,6 +140,42 @@ Set quotas for class Set quotas for a specific <volume-type> +.. option:: --networks <num-networks> + + New value for the networks quota + +.. option:: --subnets <num-subnets> + + New value for the subnets quota + +.. option:: --ports <num-ports> + + New value for the ports quota + +.. option:: --routers <num-routers> + + New value for the routers quota + +.. option:: --rbac-policies <num-rbac-policies> + + New value for the rbac-policies quota + +.. option:: --vips <num-vips> + + New value for the vips quota + +.. option:: --subnetpools <num-subnetpools> + + New value for the subnetpools quota + +.. option:: --members <num-members> + + New value for the members quota + +.. option:: --health-monitors <num-health-monitors> + + New value for the health-monitors quota + quota show ---------- diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index 1bb9341e..9ca7661e 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -186,7 +186,7 @@ Set router properties [--name <name>] [--enable | --disable] [--distributed | --centralized] - [--route destination=<subnet>,gateway=<ip-address> | --clear-routes] + [--route destination=<subnet>,gateway=<ip-address> | --no-route] <router> .. option:: --name <name> @@ -216,7 +216,7 @@ Set router properties gateway: nexthop IP address (repeat option to set multiple routes) -.. option:: --clear-routes +.. option:: --no-route Clear routes associated with the router diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index b0ac3c94..97cce35c 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -16,18 +16,14 @@ Create a new security group rule .. code:: bash os security group rule create - [--proto <proto>] [--src-ip <ip-address> | --src-group <group>] - [--dst-port <port-range>] + [--dst-port <port-range> | [--icmp-type <icmp-type> [--icmp-code <icmp-code>]]] + [--protocol <protocol>] [--ingress | --egress] [--ethertype <ethertype>] [--project <project> [--project-domain <project-domain>]] <group> -.. option:: --proto <proto> - - IP protocol (icmp, tcp, udp; default: tcp) - .. option:: --src-ip <ip-address> Source IP address block @@ -39,8 +35,35 @@ Create a new security group rule .. option:: --dst-port <port-range> - Destination port, may be a single port or port range: 137:139 - (only required for IP protocols tcp and udp) + Destination port, may be a single port or a starting and + ending port range: 137:139. Required for IP protocols TCP + and UDP. Ignored for ICMP IP protocols. + +.. option:: --icmp-type <icmp-type> + + ICMP type for ICMP IP protocols + + *Network version 2 only* + +.. option:: --icmp-code <icmp-code> + + ICMP code for ICMP IP protocols + + *Network version 2 only* + +.. option:: --protocol <protocol> + + IP protocol (icmp, tcp, udp; default: tcp) + + *Compute version 2* + + IP protocol (ah, dccp, egp, esp, gre, icmp, igmp, + ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, + ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, + udp, udplite, vrrp and integer representations [0-255]; + default: tcp) + + *Network version 2* .. option:: --ingress @@ -56,7 +79,8 @@ Create a new security group rule .. option:: --ethertype <ethertype> - Ethertype of network traffic (IPv4, IPv6; default: IPv4) + Ethertype of network traffic + (IPv4, IPv6; default: based on IP protocol) *Network version 2 only* diff --git a/doc/source/command-objects/server-backup.rst b/doc/source/command-objects/server-backup.rst new file mode 100644 index 00000000..23e17d5f --- /dev/null +++ b/doc/source/command-objects/server-backup.rst @@ -0,0 +1,44 @@ +============= +server backup +============= + +A server backup is a disk image created in the Image store from a running server +instance. The backup command manages the number of archival copies to retain. + +Compute v2 + +server backup create +-------------------- + +Create a server backup image + +.. program:: server create +.. code:: bash + + os server backup create + [--name <image-name>] + [--type <backup-type>] + [--rotate <count>] + [--wait] + <server> + +.. option:: --name <image-name> + + Name of the backup image (default: server name) + +.. option:: --type <backup-type> + + Used to populate the ``backup_type`` property of the backup + image (default: empty) + +.. option:: --rotate <count> + + Number of backup images to keep (default: 1) + +.. option:: --wait + + Wait for operation to complete + +.. describe:: <server> + + Server to back up (name or ID) diff --git a/doc/source/command-objects/server-group.rst b/doc/source/command-objects/server-group.rst index 55d789c7..414f49b1 100644 --- a/doc/source/command-objects/server-group.rst +++ b/doc/source/command-objects/server-group.rst @@ -31,7 +31,7 @@ Create a new server group server group delete ------------------- -Delete an existing server group +Delete existing server group(s) .. program:: server group delete .. code-block:: bash diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index bf972986..f11355b6 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -559,6 +559,7 @@ Set server properties --property <key=value> [--property <key=value>] ... --root-password + --state <state> <server> .. option:: --name <new-name> @@ -574,6 +575,10 @@ Set server properties Property to add/change for this server (repeat option to set multiple properties) +.. option:: --state <state> + + New server state (valid value: active, error) + .. describe:: <server> Server (name or ID) diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index b4838684..90330118 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -2,7 +2,7 @@ snapshot ======== -Block Storage v1 +Block Storage v1, v2 snapshot create --------------- @@ -82,6 +82,7 @@ Set snapshot properties [--name <name>] [--description <description>] [--property <key=value> [...] ] + [--state <state>] <snapshot> .. _snapshot_restore-snapshot: @@ -97,6 +98,14 @@ Set snapshot properties Property to add or modify for this snapshot (repeat option to set multiple properties) +.. option:: --state <state> + + New snapshot state. + Valid values are "available", "error", "creating", + "deleting", and "error_deleting". + + *Volume version 2 only* + .. describe:: <snapshot> Snapshot to modify (name or ID) diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 6edbe8e8..8abf25a6 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -16,7 +16,6 @@ Create subnet pool .. code:: bash os subnet pool create - [--pool-prefix <pool-prefix> [...]] [--default-prefix-length <default-prefix-length>] [--min-prefix-length <min-prefix-length>] [--max-prefix-length <max-prefix-length>] @@ -24,13 +23,9 @@ Create subnet pool [--address-scope <address-scope>] [--default | --no-default] [--share | --no-share] + --pool-prefix <pool-prefix> [...] <name> -.. option:: --pool-prefix <pool-prefix> - - Set subnet pool prefixes (in CIDR notation) - (repeat option to set multiple prefixes) - .. option:: --default-prefix-length <default-prefix-length> Set subnet pool default prefix length @@ -73,6 +68,11 @@ Create subnet pool Set this subnet pool as not shared +.. describe:: --pool-prefix <pool-prefix> + + Set subnet pool prefixes (in CIDR notation) + (repeat option to set multiple prefixes) + .. _subnet_pool_create-name: .. describe:: <name> diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 8daa251f..ff6354e6 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -147,6 +147,10 @@ List subnets List additional fields in output +.. option:: --ip-version {4, 6} + + List only subnets of given IP version in output + subnet set ---------- |