diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/console-url.rst | 12 | ||||
| -rw-r--r-- | doc/source/command-objects/credential.rst | 108 | ||||
| -rw-r--r-- | doc/source/command-objects/floating-ip.rst | 82 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-floating.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/network-rbac.rst | 35 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 26 | ||||
| -rw-r--r-- | doc/source/command-objects/role-assignment.rst | 28 | ||||
| -rw-r--r-- | doc/source/command-objects/role.rst | 20 | ||||
| -rw-r--r-- | doc/source/command-objects/snapshot.rst | 15 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-type.rst | 14 |
10 files changed, 325 insertions, 19 deletions
diff --git a/doc/source/command-objects/console-url.rst b/doc/source/command-objects/console-url.rst index 7993a7bf..166d0a9e 100644 --- a/doc/source/command-objects/console-url.rst +++ b/doc/source/command-objects/console-url.rst @@ -30,6 +30,18 @@ Show server's remote console URL Show SPICE console URL +.. option:: --rdp + + Show RDP console URL + +.. option:: --serial + + Show serial console URL + +.. option:: --mks + + Show WebMKS console URL + .. describe:: <server> Server to show URL (name or ID) diff --git a/doc/source/command-objects/credential.rst b/doc/source/command-objects/credential.rst index ed8a00db..538362a8 100644 --- a/doc/source/command-objects/credential.rst +++ b/doc/source/command-objects/credential.rst @@ -1,27 +1,113 @@ -=========== +========== credential -=========== +========== Identity v3 credential create ------------------- +----------------- -.. ''[consider rolling the ec2 creds into this too]'' +Create new credential +.. program:: credential create .. code:: bash os credential create - --x509 - [<private-key-file>] - [<certificate-file>] + [--type <type>] + [--project <project>] + <user> <data> + +.. option:: --type <type> + + New credential type + +.. option:: --project <project> + + Project which limits the scope of the credential (name or ID) + +.. _credential_create: +.. describe:: <user> + + User that owns the credential (name or ID) + +.. describe:: <data> + + New credential data + +credential delete +----------------- + +Delete credential(s) + +.. program:: credential delete +.. code:: bash + + os credential delete + <credential-id> [<credential-id> ...] + +.. _credential_delete: +.. describe:: <credential-id> + + ID(s) of credential to delete + +credential list +--------------- + +List credentials + +.. program:: credential list +.. code:: bash + + os credential list + +credential set +-------------- + +Set credential properties + +.. program:: credential set +.. code:: bash + + os credential set + [--user <user>] + [--type <type>] + [--data <data>] + [--project <project>] + <credential-id> + +.. option:: --user <user> + + User that owns the credential (name or ID) + +.. option:: --type <type> + + New credential type + +.. option:: --data <data> + + New credential data + +.. option:: --project <project> + + Project which limits the scope of the credential (name or ID) + +.. _credential_set: +.. describe:: <credential-id> + + ID of credential to change credential show ----------------- +--------------- + +Display credential details +.. program:: credential show .. code:: bash os credential show - [--token] - [--user] - [--x509 [--root]] + <credential-id> + +.. _credential_show: +.. describe:: <credential-id> + + ID of credential to display diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst new file mode 100644 index 00000000..093bb8e4 --- /dev/null +++ b/doc/source/command-objects/floating-ip.rst @@ -0,0 +1,82 @@ +=========== +floating ip +=========== + +Compute v2, Network v2 + +floating ip create +------------------ + +Create floating IP + +.. program:: floating ip create +.. code:: bash + + os floating ip create + [--subnet <subnet>] + [--port <port>] + [--floating-ip-address <floating-ip-address>] + [--fixed-ip-address <fixed-ip-address>] + <network> + +.. option:: --subnet <subnet> + + Subnet on which you want to create the floating IP (name or ID) + *Network version 2 only* + +.. option:: --port <port> + + Port to be associated with the floating IP (name or ID) + *Network version 2 only* + +.. option:: --floating-ip-address <floating-ip-address> + + Floating IP address + *Network version 2 only* + +.. option:: --fixed-ip-address <fixed-ip-address> + + Fixed IP address mapped to the floating IP + *Network version 2 only* + +.. describe:: <network> + + Network to allocate floating IP from (name or ID) + +floating ip delete +------------------ + +Delete floating IP(s) + +.. program:: floating ip delete +.. code:: bash + + os floating ip delete <floating-ip> [<floating-ip> ...] + +.. describe:: <floating-ip> + + Floating IP(s) to delete (IP address or ID) + +floating ip list +---------------- + +List floating IP(s) + +.. program:: floating ip list +.. code:: bash + + os floating ip list + +floating ip show +---------------- + +Display floating IP details + +.. program:: floating ip show +.. code:: bash + + os floating ip show <floating-ip> + +.. describe:: <floating-ip> + + Floating IP to display (IP address or ID) diff --git a/doc/source/command-objects/ip-floating.rst b/doc/source/command-objects/ip-floating.rst index 378812d1..7b38a382 100644 --- a/doc/source/command-objects/ip-floating.rst +++ b/doc/source/command-objects/ip-floating.rst @@ -29,6 +29,7 @@ ip floating create ------------------ Create new floating IP address +(Deprecated, please use ``floating ip create`` instead) .. program:: ip floating create .. code:: bash @@ -68,6 +69,7 @@ ip floating delete ------------------ Delete floating IP(s) +(Deprecated, please use ``floating ip delete`` instead) .. program:: ip floating delete .. code:: bash @@ -83,6 +85,7 @@ ip floating list ---------------- List floating IP addresses +(Deprecated, please use ``floating ip list`` instead) .. program:: ip floating list .. code:: bash @@ -114,6 +117,7 @@ ip floating show ---------------- Display floating IP details +(Deprecated, please use ``floating ip show`` instead) .. program:: ip floating show .. code:: bash diff --git a/doc/source/command-objects/network-rbac.rst b/doc/source/command-objects/network-rbac.rst new file mode 100644 index 00000000..0cf2127f --- /dev/null +++ b/doc/source/command-objects/network-rbac.rst @@ -0,0 +1,35 @@ +============ +network rbac +============ + +A **network rbac** is a Role-Based Access Control (RBAC) policy for +network resources. It enables both operators and users to grant access +to network resources for specific projects. + +Network v2 + +network rbac list +----------------- + +List network RBAC policies + +.. program:: network rbac list +.. code:: bash + + os network rbac list + +network rbac show +----------------- + +Display network RBAC policy details + +.. program:: network rbac show +.. code:: bash + + os network rbac show + <rbac-policy> + +.. _network_rbac_show-rbac-policy: +.. describe:: <rbac-policy> + + RBAC policy (ID only) diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 0c472e7f..5d9a5ca8 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -24,6 +24,7 @@ Create new network [--enable | --disable] [--share | --no-share] [--availability-zone-hint <availability-zone>] + [--enable-port-security | --disable-port-security] [--external [--default | --no-default] | --internal] [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] @@ -72,6 +73,20 @@ Create new network *Network version 2 only* +.. option:: --enable-port-security + + Enable port security by default for ports created on + this network (default) + + *Network version 2 only* + +.. option:: --disable-port-security + + Disable port security by default for ports created on + this network + + *Network version 2 only* + .. option:: --subnet <subnet> IPv4 subnet for fixed IPs (in CIDR notation) @@ -191,6 +206,7 @@ Set network properties [--name <name>] [--enable | --disable] [--share | --no-share] + [--enable-port-security | --disable-port-security] [--external [--default | --no-default] | --internal] [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] @@ -218,6 +234,16 @@ Set network properties Do not share the network between projects +.. option:: --enable-port-security + + Enable port security by default for ports created on + this network + +.. option:: --disable-port-security + + Disable port security by default for ports created on + this network + .. option:: --external Set this network as an external network. diff --git a/doc/source/command-objects/role-assignment.rst b/doc/source/command-objects/role-assignment.rst index 893ebdc4..ef1b22ee 100644 --- a/doc/source/command-objects/role-assignment.rst +++ b/doc/source/command-objects/role-assignment.rst @@ -2,7 +2,7 @@ role assignment =============== -Identity v3 +Identity v2, v3 role assignment list -------------------- @@ -23,11 +23,14 @@ List role assignments [--project-domain <project-domain>] [--effective] [--inherited] + [--names] .. option:: --role <role> Role to filter (name or ID) + .. versionadded:: 3 + .. option:: --user <user> User to filter (name or ID) @@ -37,19 +40,27 @@ List role assignments Domain the user belongs to (name or ID). This can be used in case collisions between user names exist. + .. versionadded:: 3 + .. option:: --group <group> Group to filter (name or ID) + .. versionadded:: 3 + .. option:: --group-domain <group-domain> Domain the group belongs to (name or ID). This can be used in case collisions between group names exist. + .. versionadded:: 3 + .. option:: --domain <domain> Domain to filter (name or ID) + .. versionadded:: 3 + .. option:: --project <project> Project to filter (name or ID) @@ -59,14 +70,29 @@ List role assignments Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. + .. versionadded:: 3 + .. option:: --effective Returns only effective role assignments (defaults to False) + .. versionadded:: 3 + .. option:: --inherited Specifies if the role grant is inheritable to the sub projects + .. versionadded:: 3 + .. option:: --names Returns role assignments with names instead of IDs + +.. option:: --auth-user + + Returns role assignments for the authenticated user. + +.. option:: --auth-project + + Returns role assignments for the project to which the authenticated user + is scoped. diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 48751ed7..5542a35b 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -7,7 +7,7 @@ Identity v2, v3 role add -------- -Add role to a user or group in a project or domain +Add role assignment to a user or group in a project or domain .. program:: role add .. code:: bash @@ -123,31 +123,33 @@ List roles Filter roles by <domain> (name or ID) - .. versionadded:: 3 + (Deprecated, please use ``role assignment list`` instead) .. option:: --project <project> Filter roles by <project> (name or ID) - .. versionadded:: 3 + (Deprecated, please use ``role assignment list`` instead) .. option:: --user <user> Filter roles by <user> (name or ID) - .. versionadded:: 3 + (Deprecated, please use ``role assignment list`` instead) .. option:: --group <group> Filter roles by <group> (name or ID) - .. versionadded:: 3 + (Deprecated, please use ``role assignment list`` instead) .. option:: --user-domain <user-domain> Domain the user belongs to (name or ID). This can be used in case collisions between user names exist. + (Deprecated, please use ``role assignment list`` instead) + .. versionadded:: 3 .. option:: --group-domain <group-domain> @@ -155,6 +157,8 @@ List roles Domain the group belongs to (name or ID). This can be used in case collisions between group names exist. + (Deprecated, please use ``role assignment list`` instead) + .. versionadded:: 3 .. option:: --project-domain <project-domain> @@ -162,18 +166,22 @@ List roles Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. + (Deprecated, please use ``role assignment list`` instead) + .. versionadded:: 3 .. option:: --inherited Specifies if the role grant is inheritable to the sub projects. + (Deprecated, please use ``role assignment list`` instead) + .. versionadded:: 3 role remove ----------- -Remove role from domain/project : user/group +Remove role assignment from domain/project : user/group .. program:: role remove .. code:: bash diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index 8ac0b6b8..ce2d9c8e 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -68,6 +68,9 @@ List snapshots os snapshot list [--all-projects] + [--long] + [--limit <limit>] + [--marker <marker>] .. option:: --all-projects @@ -77,6 +80,18 @@ List snapshots List additional fields in output +.. option:: --limit <limit> + + Maximum number of snapshots to display + + *Volume version 2 only* + +.. option:: --marker <marker> + + The last snapshot ID of the previous page + + *Volume version 2 only* + snapshot set ------------ diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst index e2a277b0..d93532c7 100644 --- a/doc/source/command-objects/volume-type.rst +++ b/doc/source/command-objects/volume-type.rst @@ -87,11 +87,24 @@ List volume types os volume type list [--long] + [--public | --private] .. option:: --long List additional fields in output +.. option:: --public + + List only public types + + *Volume version 2 only* + +.. option:: --private + + List only private types (admin only) + + *Volume version 2 only* + volume type set --------------- @@ -145,7 +158,6 @@ volume type show Display volume type details - .. program:: volume type show .. code:: bash |