diff options
Diffstat (limited to 'doc/source/cli')
| -rw-r--r-- | doc/source/cli/command-objects/application-credentials.rst | 109 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/endpoint_group.rst | 28 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/floating-ip.rst | 2 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/port.rst | 16 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/project.rst | 35 | ||||
| -rw-r--r-- | doc/source/cli/commands.rst | 1 |
6 files changed, 188 insertions, 3 deletions
diff --git a/doc/source/cli/command-objects/application-credentials.rst b/doc/source/cli/command-objects/application-credentials.rst new file mode 100644 index 00000000..2a1fbff2 --- /dev/null +++ b/doc/source/cli/command-objects/application-credentials.rst @@ -0,0 +1,109 @@ +====================== +application credential +====================== + +Identity v3 + +With application credentials, a user can grant their applications limited +access to their cloud resources. Once created, users can authenticate with an +application credential by using the ``v3applicationcredential`` auth type. + +application credential create +----------------------------- + +Create new application credential + +.. program:: application credential create +.. code:: bash + + openstack application credential create + [--secret <secret>] + [--role <role>] + [--expiration <expiration>] + [--description <description>] + [--restricted|--unrestricted] + <name> + +.. option:: --secret <secret> + + Secret to use for authentication (if not provided, one will be generated) + +.. option:: --role <role> + + Roles to authorize (name or ID) (repeat option to set multiple values) + +.. option:: --expiration <expiration> + + Sets an expiration date for the application credential (format of + YYYY-mm-ddTHH:MM:SS) + +.. option:: --description <description> + + Application credential description + +.. option:: --unrestricted + + Enable application credential to create and delete other application + credentials and trusts (this is potentially dangerous behavior and is + disabled by default) + +.. option:: --restricted + + Prohibit application credential from creating and deleting other + application credentials and trusts (this is the default behavior) + +.. describe:: <name> + + Name of the application credential + + +application credential delete +----------------------------- + +Delete application credential(s) + +.. program:: application credential delete +.. code:: bash + + openstack application credential delete + <application-credential> [<application-credential> ...] + +.. describe:: <application-credential> + + Application credential(s) to delete (name or ID) + +application credential list +--------------------------- + +List application credentials + +.. program:: application credential list +.. code:: bash + + openstack application credential list + [--user <user>] + [--user-domain <user-domain>] + +.. option:: --user + + User whose application credentials to list (name or ID) + +.. option:: --user-domain + + Domain the user belongs to (name or ID). This can be + used in case collisions between user names exist. + +application credential show +--------------------------- + +Display application credential details + +.. program:: application credential show +.. code:: bash + + openstack application credential show + <application-credential> + +.. describe:: <application-credential> + + Application credential to display (name or ID) diff --git a/doc/source/cli/command-objects/endpoint_group.rst b/doc/source/cli/command-objects/endpoint_group.rst new file mode 100644 index 00000000..ccfe5f66 --- /dev/null +++ b/doc/source/cli/command-objects/endpoint_group.rst @@ -0,0 +1,28 @@ +============== +endpoint group +============== + +A **endpoint group** is used to create groups of endpoints that then +can be used to filter the endpoints that are available to a project. +Applicable to Identity v3 + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint group add project + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint group create + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint group delete + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint group list + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint group remove project + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint group set + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint group show diff --git a/doc/source/cli/command-objects/floating-ip.rst b/doc/source/cli/command-objects/floating-ip.rst index d9ed2307..925a230c 100644 --- a/doc/source/cli/command-objects/floating-ip.rst +++ b/doc/source/cli/command-objects/floating-ip.rst @@ -166,7 +166,7 @@ Set floating IP properties .. option:: --port <port> - Assocaite the floating IP with port (name or ID) + Associate the floating IP with port (name or ID) .. option:: --fixed-ip-address <ip-address> diff --git a/doc/source/cli/command-objects/port.rst b/doc/source/cli/command-objects/port.rst index f8e88230..335c2270 100644 --- a/doc/source/cli/command-objects/port.rst +++ b/doc/source/cli/command-objects/port.rst @@ -28,6 +28,7 @@ Create new port [--enable | --disable] [--mac-address <mac-address>] [--security-group <security-group> | --no-security-group] + [--dns-domain <dns-domain>] [--dns-name <dns-name>] [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]] [--qos-policy <qos-policy>] @@ -99,9 +100,14 @@ Create new port Associate no security groups with this port +.. option:: --dns-domain <dns-name> + + Set DNS domain for this port + (requires dns_domain for ports extension) + .. option:: --dns-name <dns-name> - Set DNS name to this port + Set DNS name for this port (requires DNS integration extension) .. option:: --allowed-address ip-address=<ip-address>[,mac-address=<mac-address>] @@ -264,6 +270,7 @@ Set port properties [--security-group <security-group>] [--no-security-group] [--enable-port-security | --disable-port-security] + [--dns-domain <dns-domain>] [--dns-name <dns-name>] [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]] [--no-allowed-address] @@ -354,9 +361,14 @@ Set port properties Disable port security for this port +.. option:: --dns-domain <dns-domain> + + Set DNS domain for this port + (requires dns_domain for ports extension) + .. option:: --dns-name <dns-name> - Set DNS name to this port + Set DNS name for this port (requires DNS integration extension) .. option:: --allowed-address ip-address=<ip-address>[,mac-address=<mac-address>] diff --git a/doc/source/cli/command-objects/project.rst b/doc/source/cli/command-objects/project.rst index cb0941ca..6891a79a 100644 --- a/doc/source/cli/command-objects/project.rst +++ b/doc/source/cli/command-objects/project.rst @@ -19,6 +19,7 @@ Create new project [--enable | --disable] [--property <key=value>] [--or-show] + [--tag <tag>] <name> .. option:: --domain <domain> @@ -56,6 +57,13 @@ Create new project If the project already exists return the existing project data and do not fail. +.. option:: --tag + + Add a tag to the project + (repeat option to set multiple tags) + + .. versionadded:: 3 + .. _project_create-name: .. describe:: <name> @@ -98,6 +106,8 @@ List projects [--my-projects] [--long] [--sort <key>[:<direction>,<key>:<direction>,..]] + [--tags <tag>[,<tag>,...]] [--tags-any <tag>[,<tag>,...]] + [--not-tags <tag>[,<tag>,...]] [--not-tags-any <tag>[,<tag>,...]] .. option:: --domain <domain> @@ -127,6 +137,30 @@ List projects multiple keys and directions can be specified --sort <key>[:<direction>,<key>:<direction>,..] +.. option:: --tags <tag>[,<tag>,...] + + List projects which have all given tag(s) + + .. versionadded:: 3 + +.. option:: --tags-any <tag>[,<tag>,...] + + List projects which have any given tag(s) + + .. versionadded:: 3 + +.. option:: --not-tags <tag>[,<tag>,...] + + Exclude projects which have all given tag(s) + + .. versionadded:: 3 + +.. option:: --not-tags-any <tag>[,<tag>,...] + + Exclude projects which have any given tag(s) + + .. versionadded:: 3 + project set ----------- @@ -141,6 +175,7 @@ Set project properties [--description <description>] [--enable | --disable] [--property <key=value>] + [--tag <tag> | --clear-tags | --remove-tags <tag>] <project> .. option:: --name <name> diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst index 0c1992ad..d840549c 100644 --- a/doc/source/cli/commands.rst +++ b/doc/source/cli/commands.rst @@ -91,6 +91,7 @@ referring to both Compute and Volume quotas. * ``domain``: (**Identity**) a grouping of projects * ``ec2 credentials``: (**Identity**) AWS EC2-compatible credentials * ``endpoint``: (**Identity**) the base URL used to contact a specific service +* ``endpoint group``: (**Identity**) group endpoints to be used as filters * ``extension``: (**Compute**, **Identity**, **Network**, **Volume**) OpenStack server API extensions * ``federation protocol``: (**Identity**) the underlying protocol used while federating identities * ``flavor``: (**Compute**) predefined server configurations: ram, root disk and so on |