openstack-manuals/doc/common/section_cli_keystone_apiv3.xml

39 lines
1.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="use-v3-instead-of-default-v2">
<title>Use Identity Service API v3 instead of API v2.0</title>
<para>Use the following parameters in combination on any
keystone command to specify which version of the API to
use:</para>
<itemizedlist>
<listitem>
<para><parameter>--os-endpoint</parameter>. The
endpoint to use instead of the one in the service
catalog. Defaults to
<code>env[OS_SERVICE_ENDPOINT]</code>.</para>
<para>The <literal>keystone</literal> client detects
the version of the API from this parameter.</para>
</listitem>
<listitem>
<para><parameter>--os-auth_url</parameter>. The
Identity Service endpoint to use for
authentication. Defaults to
<code>env[OS_AUTH_URL]</code>.</para>
</listitem>
<listitem>
<para><parameter>--os-identity-api-version</parameter>.
The Identity Service API version. Defaults to
<code>env[OS_IDENTITY_API_VERSION]</code> or
<literal>2.0</literal>.</para>
</listitem>
</itemizedlist>
<para>For example, use the following parameters to use API
v3:</para>
<screen><prompt>$</prompt> <userinput><parameter>--os-auth_url</parameter> "http://15.253.57.115:35357/v3" <parameter>--os-identity-api-version</parameter> 3</userinput></screen>
<para>Use the following parameters to use API v2.0:</para>
<screen><prompt>$</prompt> <userinput><parameter>--os-auth_url</parameter> "http://15.253.57.115:35357/v2.0" <parameter>--os-identity-api-version</parameter> 2.0</userinput></screen>
</section>