diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 2 | ||||
| -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 | 61 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/image.rst | 16 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/ip-floating-pool.rst | 16 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/ip-floating.rst | 129 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/network.rst | 12 | ||||
| -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/command-objects/role.rst | 22 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/subnet.rst | 8 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/volume-type.rst | 8 | ||||
| -rw-r--r-- | doc/source/cli/commands.rst | 2 | ||||
| -rw-r--r-- | doc/source/cli/data/neutron.csv | 38 | ||||
| -rw-r--r-- | doc/source/cli/data/nova.csv | 4 | ||||
| -rw-r--r-- | doc/source/contributor/command-options.rst | 2 | ||||
| -rw-r--r-- | doc/source/index.rst | 2 |
18 files changed, 332 insertions, 178 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 597b54ed..d959d443 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,4 +3,4 @@ # process, which may cause wedges in the gate later. openstackdocstheme>=1.18.1 # Apache-2.0 reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,>=1.6.2 # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD 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..c0ba7ebf 100644 --- a/doc/source/cli/command-objects/floating-ip.rst +++ b/doc/source/cli/command-objects/floating-ip.rst @@ -20,6 +20,7 @@ Create floating IP [--description <description>] [--qos-policy <qos-policy>] [--project <project> [--project-domain <project-domain>]] + [--tag <tag> | --no-tag] <network> .. option:: --subnet <subnet> @@ -66,6 +67,18 @@ Create floating IP *Network version 2 only* +.. option:: --tag <tag> + + Tag to be added to the floating IP (repeat option to set multiple tags) + + *Network version 2 only* + +.. option:: --no-tag + + No tags associated with the floating IP + + *Network version 2 only* + .. describe:: <network> Network to allocate floating IP from (name or ID) @@ -100,6 +113,8 @@ List floating IP(s) [--status <status>] [--project <project> [--project-domain <project-domain>]] [--router <router>] + [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] + [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]] .. option:: --network <network> @@ -150,6 +165,30 @@ List floating IP(s) *Network version 2 only* +.. option:: --tags <tag>[,<tag>,...] + + List floating IP(s) which have all given tag(s) + + *Network version 2 only* + +.. option:: --any-tags <tag>[,<tag>,...] + + List floating IP(s) which have any given tag(s) + + *Network version 2 only* + +.. option:: --not-tags <tag>[,<tag>,...] + + Exclude floating IP(s) which have all given tag(s) + + *Network version 2 only* + +.. option:: --not-any-tags <tag>[,<tag>,...] + + Exclude floating IP(s) which have any given tag(s) + + *Network version 2 only* + floating ip set --------------- @@ -162,11 +201,12 @@ Set floating IP properties --port <port> [--fixed-ip-address <ip-address>] [--qos-policy <qos-policy> | --no-qos-policy] + [--tag <tag>] [--no-tag] <floating-ip> .. 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> @@ -180,6 +220,15 @@ Set floating IP properties Remove the QoS policy attached to the floating IP +.. option:: --tag <tag> + + Tag to be added to the floating IP (repeat option to set multiple tags) + +.. option:: --no-tag + + Clear tags associated with the floating IP. Specify both --tag + and --no-tag to overwrite current tags + .. _floating_ip_set-floating-ip: .. describe:: <floating-ip> @@ -210,6 +259,7 @@ Unset floating IP Properties openstack floating ip unset --port --qos-policy + [--tag <tag> | --all-tag] <floating-ip> .. option:: --port @@ -220,6 +270,15 @@ Unset floating IP Properties Remove the QoS policy attached to the floating IP +.. option:: --tag <tag> + + Tag to be removed from the floating IP + (repeat option to remove multiple tags) + +.. option:: --all-tag + + Clear all tags associated with the floating IP + .. _floating_ip_unset-floating-ip: .. describe:: <floating-ip> diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst index e2257bbb..f0b5bfaa 100644 --- a/doc/source/cli/command-objects/image.rst +++ b/doc/source/cli/command-objects/image.rst @@ -266,6 +266,22 @@ List available images *Image version 2 only* +image member list +----------------- + +List projects associated with image + +.. program:: image member list +.. code:: bash + + openstack image member list + <image> + +.. _image_member_list-image: +.. describe:: <image> + + Image(s) to view members for (name or ID) + image remove project -------------------- diff --git a/doc/source/cli/command-objects/ip-floating-pool.rst b/doc/source/cli/command-objects/ip-floating-pool.rst deleted file mode 100644 index 6d00355a..00000000 --- a/doc/source/cli/command-objects/ip-floating-pool.rst +++ /dev/null @@ -1,16 +0,0 @@ -================ -ip floating pool -================ - -Compute v2 - -ip floating pool list ---------------------- - -List pools of floating IP addresses -(Deprecated, please use ``floating ip pool list`` instead) - -.. program:: ip floating pool list -.. code:: bash - - openstack ip floating pool list diff --git a/doc/source/cli/command-objects/ip-floating.rst b/doc/source/cli/command-objects/ip-floating.rst deleted file mode 100644 index 4e5f7b00..00000000 --- a/doc/source/cli/command-objects/ip-floating.rst +++ /dev/null @@ -1,129 +0,0 @@ -=========== -ip floating -=========== - -Compute v2, Network v2 - -ip floating add ---------------- - -Add floating IP address to server -(Deprecated, please use ``server add floating ip`` instead) - -.. program:: ip floating add -.. code:: bash - - openstack ip floating add - <ip-address> - <server> - -.. describe:: <ip-address> - - IP address to add to server (name only) - -.. describe:: <server> - - Server to receive the IP address (name or ID) - -ip floating create ------------------- - -Create new floating IP address -(Deprecated, please use ``floating ip create`` instead) - -.. program:: ip floating create -.. code:: bash - - openstack ip floating 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 v2 only) - -.. option:: --port <port> - - Port to be associated with the floating IP (name or ID) - (Network v2 only) - -.. option:: --floating-ip-address <floating-ip-address> - - Floating IP address - (Network v2 only) - -.. option:: --fixed-ip-address <fixed-ip-address> - - Fixed IP address mapped to the floating IP - (Network v2 only) - -.. describe:: <network> - - Network to allocate floating IP from (name or ID) - -ip floating delete ------------------- - -Delete floating IP(s) -(Deprecated, please use ``floating ip delete`` instead) - -.. program:: ip floating delete -.. code:: bash - - openstack ip floating delete - <floating-ip> [<floating-ip> ...] - -.. describe:: <floating-ip> - - Floating IP(s) to delete (IP address or ID) - -ip floating list ----------------- - -List floating IP addresses -(Deprecated, please use ``floating ip list`` instead) - -.. program:: ip floating list -.. code:: bash - - openstack ip floating list - -ip floating remove ------------------- - -Remove floating IP address from server -(Deprecated, please use ``server remove floating ip`` instead) - -.. program:: ip floating remove -.. code:: bash - - openstack ip floating 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) - -ip floating show ----------------- - -Display floating IP details -(Deprecated, please use ``floating ip show`` instead) - -.. program:: ip floating show -.. code:: bash - - openstack ip floating show <floating-ip> - -.. describe:: <floating-ip> - - Floating IP to display (IP address or ID) diff --git a/doc/source/cli/command-objects/network.rst b/doc/source/cli/command-objects/network.rst index 5f20dc38..220fbf32 100644 --- a/doc/source/cli/command-objects/network.rst +++ b/doc/source/cli/command-objects/network.rst @@ -24,6 +24,7 @@ Create new network [--enable | --disable] [--share | --no-share] [--description <description>] + [--mtu <mtu>] [--availability-zone-hint <availability-zone>] [--enable-port-security | --disable-port-security] [--external [--default | --no-default] | --internal] @@ -74,6 +75,12 @@ Create new network *Network version 2 only* +.. option:: --mtu <mtu> + + Set network mtu + + *Network version 2 only* + .. option:: --availability-zone-hint <availability-zone> Availability Zone in which to create this network @@ -353,6 +360,7 @@ Set network properties [--enable | --disable] [--share | --no-share] [--description <description>] + [--mtu <mtu>] [--enable-port-security | --disable-port-security] [--external [--default | --no-default] | --internal] [--provider-network-type <provider-network-type>] @@ -386,6 +394,10 @@ Set network properties Set network description +.. option:: --mtu <mtu> + + Set network mtu + .. option:: --enable-port-security Enable port security by default for ports created on 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/command-objects/role.rst b/doc/source/cli/command-objects/role.rst index fe3126c0..9819fd12 100644 --- a/doc/source/cli/command-objects/role.rst +++ b/doc/source/cli/command-objects/role.rst @@ -13,12 +13,21 @@ Add role assignment to a user or group in a project or domain .. code:: bash openstack role add - --domain <domain> | --project <project> [--project-domain <project-domain>] + --system <system> | --domain <domain> | --project <project> [--project-domain <project-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] --role-domain <role-domain> --inherited <role> +.. option:: --system <system> + + Include <system> + + System or service to grant authorization to. Currently only ``all`` is + supported which encompasses the entire deployment system. + + .. versionadded:: 3 + .. option:: --domain <domain> Include <domain> (name or ID) @@ -210,12 +219,21 @@ Remove role assignment from domain/project : user/group .. code:: bash openstack role remove - --domain <domain> | --project <project> [--project-domain <project-domain>] + --system <system> | --domain <domain> | --project <project> [--project-domain <project-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] --role-domain <role-domain> --inherited <role> +.. option:: --system <system> + + Include <system> + + System or service to remove authorization from. Currently only ``all`` is + supported which encompasses the entire deployment system. + + .. versionadded:: 3 + .. option:: --domain <domain> Include <domain> (name or ID) diff --git a/doc/source/cli/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst index 0a56ccf1..73e656d8 100644 --- a/doc/source/cli/command-objects/subnet.rst +++ b/doc/source/cli/command-objects/subnet.rst @@ -265,6 +265,7 @@ Set subnet properties [--dns-nameserver <dns-nameserver>] [--no-dns-nameserver] [--gateway <gateway-ip>] + [--network-segment <network-segment>] [--host-route destination=<subnet>,gateway=<ip-address>] [--no-host-route] [--service-type <service-type>] @@ -310,6 +311,13 @@ Set subnet properties 'none': This subnet will not use a gateway, e.g.: ``--gateway 192.168.9.1``, ``--gateway none``. +.. option:: --network-segment <network-segment> + + Network segment to associate with this subnet (name or ID). It is only + allowed to set the segment if the current value is `None`, the network + must also have only one segment and only one subnet can exist on the + network. + .. option:: --host-route destination=<subnet>,gateway=<ip-address> Additional route for this subnet e.g.: diff --git a/doc/source/cli/command-objects/volume-type.rst b/doc/source/cli/command-objects/volume-type.rst index afa293d7..2b5aff99 100644 --- a/doc/source/cli/command-objects/volume-type.rst +++ b/doc/source/cli/command-objects/volume-type.rst @@ -62,8 +62,8 @@ Create new volume type .. option:: --encryption-provider <provider> - Set the class that provides encryption support for this volume type - (e.g "LuksEncryptor") (admin only) + Set the encryption provider format for this volume type + (e.g "luks" or "plain") (admin only) This option is required when setting encryption type of a volume. Consider using other encryption options such as: :option:`--encryption-cipher`, @@ -197,8 +197,8 @@ Set volume type properties .. option:: --encryption-provider <provider> - Set the class that provides encryption support for this volume type - (e.g "LuksEncryptor") (admin only) + Set the encryption provider format for this volume type + (e.g "luks" or "plain") (admin only) This option is required when setting encryption type of a volume for the first time. Consider using other encryption options such as: :option:`--encryption-cipher`, diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst index 0c1992ad..76126a74 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 @@ -103,6 +104,7 @@ referring to both Compute and Volume quotas. * ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes * ``identity provider``: (**Identity**) a source of users and authentication * ``image``: (**Image**) a disk image +* ``image member``: (**Image**) a project that is a member of an Image * ``ip availability``: (**Network**) - details of IP usage of a network * ``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 diff --git a/doc/source/cli/data/neutron.csv b/doc/source/cli/data/neutron.csv index a276cf89..be3f32a8 100644 --- a/doc/source/cli/data/neutron.csv +++ b/doc/source/cli/data/neutron.csv @@ -11,25 +11,25 @@ auto-allocated-topology-delete,network auto allocated topology delete,Delete the auto-allocated-topology-show,network auto allocated topology create,Show the auto-allocated topology of a given tenant. availability-zone-list,availability zone list,List availability zones. bash-completion,complete,Prints all of the commands and options for bash-completion. -bgp-dragent-list-hosting-speaker,,List Dynamic Routing agents hosting a BGP speaker. -bgp-dragent-speaker-add,,Add a BGP speaker to a Dynamic Routing agent. -bgp-dragent-speaker-remove,,Removes a BGP speaker from a Dynamic Routing agent. -bgp-peer-create,,Create a BGP Peer. -bgp-peer-delete,,Delete a BGP peer. -bgp-peer-list,,List BGP peers. -bgp-peer-show,,Show information of a given BGP peer. -bgp-peer-update,,Update BGP Peer's information. -bgp-speaker-advertiseroute-list,,List routes advertised by a given BGP speaker. -bgp-speaker-create,,Create a BGP Speaker. -bgp-speaker-delete,,Delete a BGP speaker. -bgp-speaker-list,,List BGP speakers. -bgp-speaker-list-on-dragent,,List BGP speakers hosted by a Dynamic Routing agent. -bgp-speaker-network-add,,Add a network to the BGP speaker. -bgp-speaker-network-remove,,Remove a network from the BGP speaker. -bgp-speaker-peer-add,,Add a peer to the BGP speaker. -bgp-speaker-peer-remove,,Remove a peer from the BGP speaker. -bgp-speaker-show,,Show information of a given BGP speaker. -bgp-speaker-update,,Update BGP Speaker's information. +bgp-dragent-list-hosting-speaker,bgp speaker show dragents,List Dynamic Routing agents hosting a BGP speaker. +bgp-dragent-speaker-add,bgp dragent add speaker,Add a BGP speaker to a Dynamic Routing agent. +bgp-dragent-speaker-remove,bgp dragent remove speaker,Removes a BGP speaker from a Dynamic Routing agent. +bgp-peer-create,bgp peer create,Create a BGP Peer. +bgp-peer-delete,bgp peer delete,Delete a BGP peer. +bgp-peer-list,bgp peer list,List BGP peers. +bgp-peer-show,bgp peer show,Show information of a given BGP peer. +bgp-peer-update,bgp peer set,Update BGP Peer's information. +bgp-speaker-advertiseroute-list,bgp speaker list advertised routes,List routes advertised by a given BGP speaker. +bgp-speaker-create,bgp speaker create,Create a BGP Speaker. +bgp-speaker-delete,bgp speaker delete,Delete a BGP speaker. +bgp-speaker-list,bgp speaker list,List BGP speakers. +bgp-speaker-list-on-dragent,bgp speaker list --agent,List BGP speakers hosted by a Dynamic Routing agent. +bgp-speaker-network-add,bgp speaker add network,Add a network to the BGP speaker. +bgp-speaker-network-remove,bgp speaker remove network,Remove a network from the BGP speaker. +bgp-speaker-peer-add,bgp speaker add peer,Add a peer to the BGP speaker. +bgp-speaker-peer-remove,bgp speaker remove peer,Remove a peer from the BGP speaker. +bgp-speaker-show,bgp speaker show,Show information of a given BGP speaker. +bgp-speaker-update,bgp speaker set,Update BGP Speaker's information. dhcp-agent-list-hosting-net,network agent list --network,List DHCP agents hosting a network. dhcp-agent-network-add,network agent add network,Add a network to a DHCP agent. dhcp-agent-network-remove,network agent remove network,Remove a network from a DHCP agent. diff --git a/doc/source/cli/data/nova.csv b/doc/source/cli/data/nova.csv index 74f76c77..338244e0 100644 --- a/doc/source/cli/data/nova.csv +++ b/doc/source/cli/data/nova.csv @@ -60,7 +60,7 @@ instance-action,,Show an action. instance-action-list,,List actions on a server. interface-attach,,Attach a network interface to a server. interface-detach,,Detach a network interface from a server. -interface-list,,List interfaces attached to a server. +interface-list,port list --server,List interfaces attached to a server. keypair-add,keypair create,Create a new key pair for use with servers. keypair-delete,keypair delete,Delete keypair given by its name. keypair-list,keypair list,Print a list of keypairs for a user @@ -137,4 +137,4 @@ volume-update,,Update volume attachment. x509-create-cert,WONTFIX,Create x509 cert for a user in tenant. x509-get-root-cert,WONTFIX,Fetch the x509 root cert. bash-completion,complete,Prints all of the commands and options to -help,help,Display help about this program or one of its subcommands.
\ No newline at end of file +help,help,Display help about this program or one of its subcommands. diff --git a/doc/source/contributor/command-options.rst b/doc/source/contributor/command-options.rst index 70890ec6..845d51f9 100644 --- a/doc/source/contributor/command-options.rst +++ b/doc/source/contributor/command-options.rst @@ -19,7 +19,7 @@ In short: * All option names shall be GNU-style long names (two leading dashes). * Some global options may have short names, generally limited to those defined - in support libraries such as ``cliff``. + in support libraries such as `cliff <https://docs.openstack.org/cliff/latest>`__. General Command Options ======================= diff --git a/doc/source/index.rst b/doc/source/index.rst index 3f63edb3..37cc6c57 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -65,7 +65,7 @@ Developers may also be found in the `IRC channel`_ ``#openstack-sdks``. .. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow .. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs .. _blueprints: https://blueprints.launchpad.net/python-openstackclient -.. _PyPi: https://pypi.python.org/pypi/python-openstackclient +.. _PyPi: https://pypi.org/project/python-openstackclient .. _tarball: http://tarballs.openstack.org/python-openstackclient .. _IRC channel: https://wiki.openstack.org/wiki/IRC |