How To Create A Port On A Neutron.Org Server On A Microsoft Powerbook (Networking) On A Macbook 2 (Netware) On An Ipad Or Ipad On A

Transcription

1 docs.rackspace.com/api

2 Cloud Networks Getting Started ( ) 2015 Rackspace US, Inc. This document is for software developers who develop applications by using Rackspace Cloud Networks, which is powered by the OpenStack Networking code base. In addition to the core features of the OpenStack Networking Application Programming Interface (API) v2, Rackspace has also deployed certain extensions as permitted by the OpenStack Networking API contract. The document is for informational purposes only and is provided AS IS. RACKSPACE MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE ACCURACY OR COM- PLETENESS OF THE CONTENTS OF THIS DOCUMENT AND RESERVES THE RIGHT TO MAKE CHANGES TO SPECIFICATIONS AND PROD- UCT/SERVICES DESCRIPTION AT ANY TIME WITHOUT NOTICE. RACKSPACE SERVICES OFFERINGS ARE SUBJECT TO CHANGE WITH- OUT NOTICE. USERS MUST TAKE FULL RESPONSIBILITY FOR APPLICATION OF ANY SERVICES MENTIONED HEREIN. EXCEPT AS SET FORTH IN RACKSPACE GENERAL TERMS AND CONDITIONS AND/OR CLOUD TERMS OF SERVICE, RACKSPACE ASSUMES NO LIABILITY WHATSOEVER, AND DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO ITS SERVICES INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. Except as expressly provided in any written license agreement from Rackspace, the furnishing of this document does not give you any license to patents, trademarks, copyrights, or other intellectual property. Rackspace, Rackspace logo and Fanatical Support are registered service marks of Rackspace US, Inc. All other product names and trademarks used in this document are for identification purposes only and are property of their respective owners. ii

3 Table of Contents Preface... 1 Intended audience... 1 Pricing and service level... 1 Document change history... 2 Resources... 2 Overview... 3 What are the Cloud Networks service limits?... 3 Networking: Neutron versus Nova-Network... 4 Which networks are available?... 4 Which networks are attached during provisioning?... 5 Consequences of detaching from Rackspace networks... 6 Learn how to use the examples in this guide... 8 How the neutron client works... 8 How the nova client works... 9 How curl commands work... 9 Set up the environment and authenticate Install the nova client with the Cloud Networks extension (optional) Install the neutron client (optional) Get the authentication token Export environment variables to run curl commands (optional) Create your first cloud network Create network with neutron client Create network with curl Boot a new server with your cloud network Boot server with neutron client Boot server with curl Delete your cloud network Delete your network with neutron client Delete your network with curl Use allocation pools to control dynamic IP address allocation Use allocation pools to control dynamic IP address allocation with neutron client Use allocation pools to control dynamic IP address allocation with curl Configure host routes Configure host routes with neutron Configure host routes with curl Provision additional IP and dual-stack IP addresses on an isolated network port Provision a port with additional IP and dual-stack IPs with neutron client Provision a port with additional IP and dual-stack IPs with curl Use security groups to control traffic Using security groups with neutron client Using security groups with curl Attach your network to an existing server Glossary iii

4 List of Figures 1. Steps to create a network Steps to provision a server with a network Steps to delete a network Steps to use allocation pools to control dynamic IP address allocation Steps to configure host routes Steps to provision dual-stack IP addresses on a port Steps to create, use, and modify security groups and rules iv

5 List of Tables 1. curl command-line options Neutron client prerequisite software v

6 Preface Intended audience... 1 Pricing and service level... 1 Document change history... 2 Resources... 2 Rackspace Cloud Networks enables you to create isolated networks and provision server instances with Rackspace networks or the isolated networks that you created. When you create an isolated network, it is associated with your tenant ID, which is also known as your account ID or account number. If you don't know your tenant ID, you can find it by logging in to the Cloud Control Panel and expanding the Account menu in the upper-right corner of the screen. Your tenant ID is shown at the top of the menu, listed as Account #. Cloud Networks was originally released using the Cloud Servers Nova-Network API, whose operations are detailed in Network extension of the Next Generation Cloud Servers Developers Guide. Now Cloud Networks has been released using the Neutron API (see API operations in the Cloud Networks Developer Guide). We recommend that you use the Neutron API operations even though the Nova-Network API operations still work. For information that helps you determine which method is better for you, see Networking: neutron versus nova-network. We welcome feedback, comments, and bug reports at Intended audience This guide assists software developers who want to develop applications by using Cloud Networks with the Neutron API. To use this information, you should have access to an active Rackspace Cloud Servers account and access to Cloud Networks. You should also be familiar with the following concepts: Cloud Servers service RESTful web services HTTP/1.1 JSON data serialization formats Pricing and service level Cloud Networks is part of the Rackspace Cloud and your use through the API is billed according to the pricing schedule for Cloud Servers at servers/pricing/. The Service Level Agreement (SLA) for Cloud Networks, as part of Cloud Servers, is available at 1

7 Document change history This version of the guide applies only to v2.0 of the API. The most recent changes are described in the following table: Revision Date June 5, 2015 Summary of Changes Corrected erroneous example in the section called Create a security group (neutron client) [101]. Corrected erroneous text in the section called Create a security group (neutron client) [101] and the section called Add a rule for SSH traffic (neutron client) [102]. May 26, 2015 Corrected some examples for Use security groups to control traffic [99]. May 12, 2015 March 24, 2015 March 19, 2015 March 6, 2015 January 15, 2015 November 20, 2014 September 30, 2014 Resources Fixed the following operation examples: create subnet, create port, delete network, delete subnet, and boot server for several use cases. Expanded section on security groups to provide a use case. Added the section called Install the neutron client (optional) [12] and updated the usecases to add neutron client examples. Updated Identity API endpoint documentation to remove references to regional endpoints. All customers can authenticate using the global endpoint, regardless of geographic location. Updated the section called Authenticate with curl [20] with information about using multi-factor authentication for added security when a user authenticates with username and password credentials. Public release of this document. Published document with neutron API calls. Next generation Cloud Servers v2 Cloud Networks v2 Identity v2 Next Generation Cloud Servers Release Notes Next Generation Cloud Servers Getting Started Next Generation Cloud Servers Developer Guide Cloud Networks Release Notes Cloud Networks Getting Started Cloud Networks Developer Guide Cloud Identity Client Developer Guide v2.0 For additional Cloud Servers and Cloud Networks service resources, see the Rackspace Cloud site, which provides related documents and links to Rackspace support channels including Knowledge Center articles, phone, chat, and tickets. For product updates and announcements through Twitter, see rackspace. For information about the supernova client, which is an unsupported wrapper for the nova client that is useful for managing multiple nova environments, see supernova client. 2

8 Overview What are the Cloud Networks service limits?... 3 Networking: Neutron versus Nova-Network... 4 Which networks are available?... 4 Which networks are attached during provisioning?... 5 Consequences of detaching from Rackspace networks... 6 This overview introduces the types of Cloud Networks API operations, Cloud Networks service limits, a comparison between the Neutron API and the Nova-Network API, the available networks, which networks are attached to a server (based on the provisioning method), and a discussion about the consequences of choosing not to attach to Rackspace PublicNet and ServiceNet networks. You can use the Cloud Networks service Neutron API to perform the following tasks: List networks to which the specified tenant has access. Create isolated networks. Show details for isolated networks. Delete an isolated network, if it is not associated with any server. Note Manage subnets. Manage ports. To detach a network from a server, you must use the Cloud Networks virtual interface extension to delete the virtual interface for the network from the server. For more information, see the Next Generation Cloud Servers Developer Guide. Manage security groups and security group rules. What are the Cloud Networks service limits? The following limits exist within the Cloud Networks service: Cloud networks per region: 10 Subnets per network: 2 (one IPv4 and one IPv6) DNS nameservers per subnet: 2 Host Routes per subnet: 3 Allocation pools per subnet: 5 Number of fixed IP addresses per port: 4 3

9 Ports (hosts) per network: 250 Security groups per port: 5 Security group rules per security group: 20 Security group rules per user: 100 Networking: Neutron versus Nova-Network Rackspace first introduced networking services that were based on the OpenStack Nova-Network API and exposed these services via the /os-networksv2 Cloud Servers extension. For documentation on these operations, see Network extension of the Next Generation Cloud Servers Developers Guide. This version of the service is now superseded by the current networking API, based on OpenStack Neutron, which offers a richer suite of networking services. Both APIs continue to function, but the Neutron API will be the base for all the future networking services that Rackspace offers. We recommend that you use the Neutron API for your Cloud Networks API operations. The current API introduces three new top-level resources /networks, /ports, and / subnets which are included in the OpenStack Neutron API. All new networking services that we offer will make use of these resources and build on the OpenStack Neutron API to help you build rich networking topologies and configure advanced network services. As part of the new API, the following new capabilities are available to users: Create and manage isolated networks using the new API Assign routes to cloud servers at boot-time (host routes) Specify allocation pools to subnets (CIDRs) on isolated networks to control the IP address assignment on your cloud servers Allocate an IP address of your choice to ports on isolated Networks Dual-stack isolated networks: Allocate both IPv4 and IPv6 addresses on the same isolated network port. The Neutron API supports JSON data serialization format for requests and responses. For guidance on the Nova-Network API networking operations, see Network extension of the Next Generation Cloud Servers Developers Guide. Which networks are available? The Rackspace Public Cloud enables you to attach one or more of the following networks to your server: Public (PublicNet): Rackspace PublicNet connects the cloud infrastructure components (like servers, load balancers, and network appliances) to the Internet. PublicNet is optimized for north-south traffic (traffic flowing to and from the In- 4

10 ternet). It follows a direct addressing model, so that all public IP addresses are directly configured on the servers without using Network Address Translation (NAT). PublicNet is dual-stacked for IPv4 and IPv6. When you create servers with PublicNet, your servers get an IPv4 and an IPv6 address by default. When you list networks, PublicNet is labeled public. Service (ServiceNet) ServiceNet is an internal, IPv4-only multi-tenant network within each Rackspace Cloud region that is optimized to carry east-west traffic. It provides servers access to regional services such as Cloud Files, Cloud Load Balancers, Cloud Databases, and Cloud Backup at no cost. ServiceNet is also required for Windows Cloud Server activation. We recommend that you connect servers to ServiceNet so that they can access these services. The networks /12 and /12 are reserved for ServiceNet. Isolated networks (Cloud Networks) When you list networks, ServiceNet is labeled private. Isolated networks are user-defined L2 networks that are fully isolated and single-tenant, and offer users a means to securely connect their application servers. They are provided at no charge. Isolated Networks can now be provisioned either as IPv4 or IPv6, or they can be dual stacked (IPv4 and IPv6). Isolated networks are recommended for all inter-server communication. Even though ServiceNet can also be used for server east-west (backend) connectivity, ServiceNet is not recommended for that purpose because, unlike isolated networks, ServiceNet is multi-tenant. Isolated networks also include full support for the broadcasting and multicasting required for some clustering technologies. Which networks are attached during provisioning? Which networks get attached, manually or automatically, to a newly provisioned server depends on which of the following methods you use to provision that server: Cloud Servers Neutron API: You must specify the networks that you want to attach to your server. The UUID for ServiceNet is , and the UUID for PublicNet is Note The Neutron API is currently accessible by using curl commands, browser plug-ins for REST, or various programming languages and tools. The neutron client is not supported at this time. 5

11 nova boot command: You must specify the networks that you want to attach to your server. If you do not specify any networks, ServiceNet and PublicNet are attached by default. To attach to isolated networks that you have created, you must explicitly specify them in the command. If you do so, those networks, in addition to PublicNet and ServiceNet, are attached to your server. Cloud Control Panel: PublicNet and ServiceNet are automatically attached, but you can disable these networks during the server creation process. You can also attach any isolated networks that you have created. Note You can explicitly opt out of attaching to the Rackspace networks, which introduces certain potential complications. For more information, see Consequences of detaching from Rackspace networks. Consequences of detaching from Rackspace networks When you provision a next generation cloud server, you can attach to one or more isolated networks and the Rackspace networks. You can also explicitly opt out of attaching the Rackspace networks to the server, which introduces the following consequences: If you do not attach the PublicNet network to the server, the server cannot access the Internet and some Rackspace products and services. If you do not attach the ServiceNet network to the server, the server cannot access certain Rackspace products and services. The following graphic depicts the services that are available only when you attach the Rackspace networks to your server: 6

12 To opt out of attaching the Rackspace networks to your server, perform the following action depending on how you are provisioning the server: nova boot command: Specify the optional --no-public and --no-service-net parameters. Cloud Servers Nova-Network API (nova client or curl): If you do not specify any networks, ServiceNet and PublicNet are attached by default. However, if you specify an isolated network, you must explicitly specify the UUIDs for PublicNet and ServiceNet to attach these networks to your server. The UUID for ServiceNet is , and the UUID for PublicNet is Omit these UUIDs from the request to opt out of attaching to these networks. Cloud Control Panel: Clear the PublicNet and ServiceNet selections during the server creation process. You are warned that your capabilities might be degraded by this choice. 7

13 Learn how to use the examples in this guide How the neutron client works... 8 How the nova client works... 9 How curl commands work... 9 For each exercise in this guide, you choose one of the following methods to make Cloud Networks API calls: The neutron client. We recommend that you use the neutron client to run simple commands that make neutron API calls. This open-source Python client runs on Linux or Mac OS X systems and is easy to learn and use. You can specify --debug as the first parameter on any neutron command to show the underlying API request for the command. This is a good way to become familiar with API requests. For example: neutron --debug netlist. For more information, see How the neutron client works. The nova client: Use the nova client to run simple Nova-Network API commands such as those required to boot servers and to attach and detach networks. For more information, see How the nova client works. curl commands: With curl, you send HTTP requests with embedded API calls from the command line. The curl examples in this guide show request and response bodies that are in JSON format. See How curl commands work. You can use curl in one example and switch to a client in the next example. If you choose to use a curl command for any example, you must export the environment variables required to run the curl examples. See Export environment variables to run curl commands (optional). How the neutron client works The neutron client is an open-source Python client that you use to run commands to make API calls. Each client command runs curl commands that embed API requests. The client runs from a desktop computer or remote system, such as a cloud server. To install and configure the neutron client on a Linux distribution or on Mac OS X, see Install the neutron client (optional). To export environment variables (see Export environment variables to run curl commands (optional). Note You can specify --debug as the first parameter on any neutron command to show the underlying API request for the command. This is a good way to become familiar with API requests. For example: neutron --debug net-list. 8

14 Warning If you upgrade the operating system of the desktop or remote machine where you installed the client, you may need to reinstall the neutron client. How the nova client works The nova client is an open-source Python client that lets you run commands to make Nova-Network API calls. The client is easy to learn and use. Each client command runs curl commands that embed API requests. You can run the client from a desktop computer or remote system, such as a cloud server. You can use the nova client to perform the following operations: 1. Boot a server with isolated networks and ports. 2. Attach and detach networks from servers (if the Cloud Networks extension is installed). To install the nova client on a Linux distribution or on Mac OS X, see Install the nova Client with the Cloud Networks Extension in the Next Generation Cloud Servers Getting Started Guide. How curl commands work curl is a command-line tool that you can use to interact with REST interfaces. curl lets you to transmit and receive HTTP requests and responses from the command line or a shell script, which enables you to work with the API directly. It is available for Linux distributions, Mac OS X, and Windows. For information about curl, see To run the curl request examples shown in this guide, copy each example from the HTML version of this guide directly to the command line or a script. The following command is an example curl command that provisions a server with an isolated network using JSON. Example 1. curl command example: JSON request $ curl \ -X POST \ -H "X-Auth-Project-Id: $account" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -H "X-Auth-Token: $token" \ -d '"server": "name": "my_server_with_network", "imageref": "d42f821e-c2d f07- af5ed7912d0e", "flavorref": "2", "max_count": 1, "min_count": 1, "networks": ["uuid": "538a112a-34d1-47ff-bf1e-c40639e886e2", "uuid": " ", "uuid": " "]' \ python -m json.tool Note The carriage returns in the curl request examples use a backslash (\) as an escape character. The escape character allows continuation of the command across multiple lines. 9

15 The curl examples in this guide use the following command-line options. Table 1. curl command-line options Option Description -d Sends the specified data in a POST request to the HTTP server. Use this option to send a JSON request body to the server. -H Specifies an extra HTTP header in the request. You can specify any number of extra headers. Precede each header with the -H option. Common headers in Rackspace API requests are as follows: Content-Type: Required for operations with a request body. Specifies the format of the request body. Following is the syntax for the header where format is json: Content-Type: application/format X-Auth-Token: Required. Specifies the authentication token. X-Auth-Project-Id: Optional. Specifies the project ID, which can be your account number or another value. Accept: Optional. Specifies the format of the response body. Following is the syntax for the header where the format is json, which is the default: Accept: application/format -i Includes the HTTP header in the output. -s Specifies silent or quiet mode, which makes curl mute. No progress or error messages are shown. -T Transfers the specified local file to the remote URL. -X Specifies the request method to use when communicating with the HTTP server. The specified request is used instead of the default method, which is GET. More about json.tool For commands that return a response, you can append the following code to the command to call json.tool to pretty-print output: python -m json.tool To use json.tool, import the JSON module. For information about json.tool, see json JSON encoder and decoder. If you run a Python version earlier than 2.6, import the simplejson module and use simplejson.tool. For information about simplejson.tool, see simplejson JSON encoder and decoder. 10

16 If you do not want to pretty-print JSON output, omit this code. 11

17 Set up the environment and authenticate Install the nova client with the Cloud Networks extension (optional) Install the neutron client (optional) Get the authentication token Export environment variables to run curl commands (optional) To follow the examples in this guide, you can use curl, neutron, or, in some cases, nova commands. If you plan to use the nova or neutron clients, install them, and then get your authentication token. If you plan to use curl commands, get your authentication token and then export your environment variables. Note You can use any combination of methods to run the commands in this guide, switching back and forth if you like. You are not locked into one method just because you started with it. All methods are available with curl. Some methods are not available in the nova or neutron clients. Regardless of which method you choose to make API calls, you must get an authentication token. Install the nova client with the Cloud Networks extension (optional) The Rackspace Neutron API doesn t currently offer a way to authenticate or to attach networks to, and detach networks from, a server. If you want to attach and detach networks by using the nova client, you must use the Cloud Networks virtual interface extension by installing the os_virtual_interfacesv2_python_novaclient_ext package. Note The python-novaclient is developed and maintained by the OpenStack community. Although we do not directly support python-novaclient, you can post in the comments below if you run into any difficulties. For help installing the nova client and Cloud Networks extension, see Install the nova Client with the Cloud Networks Extension in the Next Generation Cloud Servers Getting Started Guide. Next step: Get the authentication token Install the neutron client (optional) Follow the necessary steps to install the neutron client To manage your network from the command line, you can use the open-source neutron client application called rackspace-python-neutronclient. 12

18 Before you install the neutron client, install the following software: Table 2. Neutron client prerequisite software Prerequisite Description Python 2.6 or later Currently, the neutron client does not support Python 3. setuptools package Installed by default on Mac OS X. Many Linux distributions provide packages to make setuptools easy to install. pip package Search your package manager for setuptools to find an installation package. If you cannot find one, download the setuptools package directly from pypi.python.org/pypi/setuptools. To install the neutron client on a Mac OS X or Linux system, use pip because it is easy and ensures that you get the latest version of the neutron client from the Python Package Index. Also, it lets you update the package later on. Install pip through the package manager for your system: Mac OS X pip $ sudo easy_install Ubuntu python-pip $ aptitude install Debian python-pip $ aptitude install Fedora $ yum install pythonpip CentOS, or RHEL (from EPEL or another 3rd party repository) Nova client $ yum install pythonpip Before you can use the neutron client commands, you must have an authentication token. Since the neutron client doesn't provide authentication, install the nova client. See Install the nova Client with the Cloud Networks Extension in the Next Generation Cloud Servers Getting Started Guide. To install the neutron client: 1. Install or update the neutron client package Run the following command for your operating system to install the rackspacepython-neutronclient package, which includes the neutron client: For Ubuntu, Debian, or OS X: For RHEL, CentOS, or Fedora: $ sudo pip install rackspace-neutronclient 13

19 $ sudo python-pip install rackspace-neutronclient Note If you previously installed the rackspace-python-neutronclient package, run the following command for your operating system to upgrade it: For Ubuntu, Debian, or OS X: $ sudo pip install --upgrade rackspaceneutronclient For RHEL, CentOS, or Fedora: 2. Set environment variables $ sudo python-pip install --upgrade rackspace-neutronclient Edit your bash profile to add and set environment variables that enable the neutron client to connect to your Rackspace Cloud account. Use nano, or an editor of your choice, to edit your.bash_profile file: $ nano ~/.bash_profile Add the following sets of lines to your bash profile and save the file. Substitute your username and tenant ID for the placeholders and modify the OS_UAUTH_URL if you use a different authentication endpoint. Example 2. US Data Center Example export OS_AUTH_URL= export OS_EXECUTABLE=neutron export OS_AUTH_SYSTEM=rackspace export OS_AUTH_STRATEGY=rackspace export OS_REGION_NAME=DFW export OS_USERNAME=<username> export OS_TENANT_NAME=<tenant_id> export OS_PROJECT_ID=<tenant_id> export OS_PASSWORD=<apikey> export OS_NO_CACHE=1 3. Set permissions on the bash profile Because the bash profile contains a password, set permissions on it so other people cannot read it: $ chmod 600 ~/.bash_profile 4. Source the environment variables To source the variables to make them available in your current shell, run the following command: 14

20 $ source ~/.bash_profile 5. Test the neutron client To verify that you can talk to the API server, authenticate using nova client: $ nova credentials Then, list networks, using the neutron client: $ neutron net-list 6. Get help for neutron client commands To get help for neutron client commands, run the following command: $ neutron help To get help for a specific command, type the command name after the help parameter, as follows: $ neutron help <command_name> You cannot use every command that is listed. The neutron client was written for use with recent development versions of OpenStack, so it includes support for some features that are not available in the Rackspace Cloud. Note To show and become familiar with the underlying API v2 request for a command, specify the --debug parameter as the first parameter on any command. For example: $ neutron --debug net-list 7. Troubleshooting The python-neutronclient is developed and maintained by the OpenStack community. If you cannot run commands successfully, make sure that you entered your user name, password, and account number correctly in the bash profile file. If you change any environment variables, either log out and back in or source your bash profile again. To override some environment variable settings, you can use the options that are listed at the end of the neutron help output. For example, you can override the OS_PASSWORD setting in the bash profile by specifying a password on a neutron command, as follows: $ neutron --password <password> net-list Where password is your Rackspace password. 15

21 Having the upstream python-neutronclient installed at the same time as the rackspace-python-neutronclient may cause problems. If you are having trouble, try installing your neutron clients using the following instructions and then attempt to reinstall the neutron client as shown in the preceding step. python-neutronclient $ sudo pip uninstall -y rackspace-neutronclient $ sudo pip uninstall -y rackspace-auth-neutronclientext $ sudo pip uninstall -y To show the underlying API request for any neutron client command, specify --debug as the first parameter on any neutron command. This is a good way to become familiar with API requests. For example: neutron --debug net-list. While Rackspace does not directly support python-neutronclient, if the above steps don't help, you can post a question in the comments below. Next step: Get the authentication token Get the authentication token To authenticate access to Rackspace Cloud services, you issue an authentication request to the Rackspace Cloud Identity service, which is an implementation of the OpenStack Keystone Identity Service v2.0. Authenticate by using the following endpoint: v2.0 In response to valid credentials, an authentication request to the Rackspace Cloud Identity service returns an authentication token and a service catalog that contains a list of all services and endpoints available for this token. Because the authentication token expires after 24 hours, you must generate a new token once a day. For detailed information about the Rackspace Identity Service v2.0, see Cloud Identity Client Developer Guide API v2.0. Next step: Choose one of the following methods: Authenticate with the nova client 16

22 Authenticate with curl 17

23 Authenticate with the nova client When you authenticate by using the nova client, you execute separate commands to get the authentication token and the service catalog. To authenticate with the nova client: 1. Get an authentication token: $ nova credentials Successful authentication returns user credentials, including ID, name, roles, and the authentication token. The token appears in the id field in the Token box as shown in the following example. Example 3. Authentication credentials response User Credentials Value id name MyRackspaceAcct roles [u'description': u'user Admin Role.', u'id': u'3', u'name': u'identity:user-admin'] Token Value expires T13:58: :00 id 1bd336d5-e0c6-49d9-b902-d3dbdc tenant u'id': u'010101', u'name': u'010101' After you generate a token, the nova client automatically injects the token into any nova client commands that you issue. However, because the token expires after 24 hours, you must generate a new token once a day. 2. Get the service catalog with a list of endpoints: $ nova endpoints For each service, the response includes the public URL (which is the endpoint, including your tenant ID, that you use to access the service), the region, the service name, the tenant ID, the version ID, and the endpoints that you can use to get version information for the API. 18

24 To access the Cloud Networks or next generation Cloud Servers service, use the publicurl value for the cloudserversopenstack service. The following example shows the information returned for the DFW region for the next generation Cloud Servers service: Example 4. Authentication endpoints response cloudserversopenstack Value publicurl region DFW servicename cloudserversopenstack tenantid versionid 2 versioninfo versionlist The cloudserversopenstack service might show multiple endpoints to enable regional choice. Select the appropriate endpoint for the region that you want to interact with by examining the region field. 3. Copy the values in the publicurl and tenantid fields for the cloudserversopenstack service for your region. Next step: Create your first cloud network 19

25 Authenticate with curl To authenticate with curl, issue a POST /tokens request to the appropriate Rackspace Cloud Identity Service endpoint. In the request body, supply one of the following sets of credentials: User name and password User name and API key Your user name and password are the ones that you use to log in to the Rackspace Cloud Control Panel. Note If you authenticate with username and password credentials, you can use multi-factor authentication to add an additional level of account security. This feature is not implemented for username and API credentials. For more information, see Multifactor authentication in the Cloud Identity Client Developer Guide. To obtain your API key, log in to select Account:username > Account Settings, and click Show next to the API Key field. To authenticate with curl: 1. Get an authentication token and a service catalog with a list of endpoints. Use one of the following curl commands to authenticate to the Identity endpoint: Example 5. Authenticate with username and password: JSON request $ curl -s -X 'POST' \ -d '"auth":"passwordcredentials":"username":"yourusername", "password":"yourpassword"' \ -H "Content-Type: application/json" python -m json.tool Example 6. Authenticate with username and API key: JSON request $ curl -s -X 'POST' \ -d '"auth":"rax-kskey:apikeycredentials":"username":"yourusername", "apikey":"yourapikey"' \ -H "Content-Type: application/json" python -m json.tool Tip For information about the json.tool, see More about json.tool. In response to valid credentials, your request returns an authentication token and a service catalog with the endpoints that you need to request services. Note If you authenticated with username and password credentials, and the Identity service returns a 401 message requesting additional credentials, your account is configured for multi-factor authentication. To complete the authentication process, submit a second POST tokens request with multi-factor authentication credentials. 20

26 Do not include explicit API endpoints in your scripts and applications. Instead, find the endpoint for your service and region. The following output shows a partial authentication response in JSON format: Example 7. Authentication: JSON response "access": "servicecatalog": [ "endpoints": [ "publicurl": " "region": "ORD", "tenantid": "010101", "publicurl": " "region": "HKG", "tenantid": "010101", "publicurl": " "region": "DFW", "tenantid": "010101" ], "name": "cloudimages", "type": "image", "endpoints": [ "publicurl": " "region": "DFW", ],,, "tenantid": "010101", "versionid": "2", "versioninfo": " "versionlist": " "publicurl": " "region": "SYD", "tenantid": "010101", "versionid": "2", "versioninfo": " "versionlist": " "publicurl": " "region": "IAD", "tenantid": "010101", "versionid": "2", "versioninfo": " "versionlist": " "name": "cloudserversopenstack", "type": "compute" ], "token": "RAX-AUTH:authenticatedBy": [ "APIKEY" ], "expires": " T11:16:40.995Z", "id": "459a28e0-777f-416c-8f22-9f6598fabd2f", "tenant": "id": "010101", "name": "010101", "user": "RAX-AUTH:defaultRegion": "ORD", "id": " ", "name": "MyRackspaceAcct", "roles": [ "description": "User Admin Role.", "id": "3", "name": "identity:user-admin" ] 21

27 Successful authentication returns the following information: Endpoints to request Rackspace Cloud services. Appears in the endpoints element in the servicecatalog element. Endpoint information includes the public URL (which is the endpoint that you use to access the service), region, tenant ID, and version information. Tenant ID. Appears in the tenantid field in the endpoints element. Also known as the account number. You include the tenant ID in the endpoint URL when you call a Rackspace Cloud service. The name of the service. Appears in the name field. To access the next generation Cloud Servers service, locate and use the publicurl value for the cloudserversopenstack service. A service might show multiple endpoints to enable regional choice. Select the appropriate endpoint for the region that you want to interact with by examining the region field. Expiration date and time for authentication token. Appears in the expires field in the token element. The authentication token expires after this date and time, unless it is revoked earlier. After the token expires or is revoked, you must generate a new token if you want to continue accessing Rackspace Cloud services. This field predicts the maximum lifespan for a token, but does not guarantee that the token reaches that lifespan. Clients are encouraged to cache a token until it expires. Authentication token. Appears in the id field in the token element. You pass the authentication token in the X-Auth-Token header each time that you send a request to a service. 2. Copy the values in the publicurl and tenantid fields for the cloudserversopenstack service for your region. Copy the authentication token from the id field in the token element. As a next step, you can set environment variables to these values. Next step: Choose one of the following steps: Export environment variables to run curl commands (optional) Create your first cloud network 22

28 Export environment variables to run curl commands (optional) To run the curl command examples in this guide, follow this procedure to export values to environment variables. Export your tenant ID and authentication token to environment variables. All curl examples in this guide use these environment variables. To export environment variables 1. Export your tenant ID to the account environment variable: $ export account="tenantid" tenantid is the value in the tenantid field in the authentication response. 2. Export your authentication token to the token environment variable: $ export token="id" id is the value in the id field in the token field in the authentication response. Next step: Create your first cloud network 23

29 Create your first cloud network Create network with neutron client Create network with curl The following flow chart shows the steps for creating a network. Detailed steps are provided in this section. 24

30 Figure 1. Steps to create a network 25

31 The sections are also organized by example type. To simplify your path through this chapter, decide whether you prefer neutron-client or curl examples. Note Network Limitations: The isolated network must exist in the same region as the cloud server. You can create up to 10 isolated networks with up to 250 servers attached to each one. Next step: Choose one of the following methods: Create network with neutron client Create network with curl Create network with neutron client These sections walk you through creating your network and subnet and then listing them by using the neutron client. Start here: Create a network (neutron client) Create a network (neutron client) To create a network, you specify a name for your network. After you create a network, copy its network ID. You use this ID to create a subnet and attach it to a port. To create a network 1. Issue the following neutron command. Positional arguments: The network name. In this example, the name is amp. Output: $ neutron net-create <amp> The command returns the response, as shown in the following output: Field Value admin_state_up True 26

32 id 29f52c7e-6efd-4335-a14a-db77d32a2555 name amp shared False status ACTIVE subnets tenant_id 53501b3c25d34f8ea293c03298caed Copy the ID value from the output. You will use this value when you create a subnet, provision your server, or perform other related activities. In this example, the ID is 29f52c7e-6efd-4335-a14a-db77d32a2555, but use the id from your response. Next step: Create a subnet (neutron client) Create a subnet (neutron client) To create a subnet, you specify a network, an IP address, and a name for your subnet. After you create a subnet, copy its subnet ID for future reference. To create a subnet 1. Issue the following neutron command. name The subnet name. In this example, the name is Subamp. ip-version The version of the subnet IP. In this example, the version is 4. The network ID or name. In this example, we used the network ID 29f52c7e-6efd-4335-a14a-db77d32a2555. The network CIDR. In this example, the CIDR is /24. $ neutron subnet-create --name <Subamp> --ip-version <4> <29f52c7e-6efd-4335-a14a-db77d32a2555> < /24> Positional arguments: Output: The command returns the response, as shown in the following output: Field Value allocation_pools "start": " ", "end": " " cidr /24 dns_nameservers enable_dhcp gateway_ip host_routes id 23e3059e-4f39-4f7f-8cf2-c326e5de6c37 ip_version 4 name Subamp 27

33 network_id 29f52c7e-6efd-4335-a14a-db77d32a2555 tenant_id 53501b3c25d34f8ea293c03298caed Copy the id value from the output for future reference. In this example, the id is 23e3059e-4f39-4f7f-8cf2-c326e5de6c37, but use the id from your response. Next step: List networks (neutron client) List networks (neutron client) To list networks Issue the following neutron client command: Output: $ neutron net-list For each network, the command returns the result as shown in the following output id name subnets f52c7e-6efd-4335-a14a-db77d32a2555 amp 23e3059e-4f39-4f7f-8cf2- c326e5de6c / Next step: List subnets (neutron client) List subnets (neutron client) The following steps shows you how to list subnets using the neutron client. To list subnets Issue the following neutron client command: Output: $ neutron subnet-list For each subnet, the command returns the result as shown in the following output

34 id name cidr allocation_pools e3059e-4f39-4f7f-8cf2-c326e5de6c37 Subamp /24 "start": " ", "end": " " Next step: Boot a new server with your cloud network Create network with curl These sections walk you through creating your network and subnet and then listing them by using curl. Start here: Create a network (curl) Create a network (curl) After you create a network, copy its network ID. You use this ID to create a subnet or attach the network to a server. The Cloud Networks API supports only JSON formatting. XML is not supported. To create a network 1. Issue the following curl command, substituting your own values for the ones shown: $ curl -s networks \ -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -H "X-Auth-Token: $token" \ -d '"network": "name": "amp"' python -m json.tool In this curl command, you specify several options. For information about the options, see curl command-line options. The operation returns the response body, as shown in the following example: "network": "status":"active", "subnets":[ ], "name":"amp", "admin_state_up":true, "tenant_id":"53501b3c25d34f8ea293c03298caed60", "shared":false, "id":"29f52c7e-6efd-4335-a14a-db77d32a2555", 29

35 2. Copy the id value from the output. You will use this value when you create a subnet, provision your server, or perform other related activities. In this example, the ID is 29f52c7e-6efd-4335-a14a-db77d32a2555, but use the ID from your response. Next step: Create a subnet (curl) Create a subnet (curl) To create a subnet, you specify a network ID (using the ID that you copied in the preceding step), an IP address, and a name for your subnet. After you create a subnet, copy its ID for future reference. To create a subnet 1. Issue the following curl command, substituting your own values for the ones shown: $ curl -s subnets \ -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -H "X-Auth-Token: $token" \ -d '"subnet":"name":"subamp","cidr":" /24","ip_version":4, "network_id":"29f52c7e-6efd-4335-a14a-db77d32a2555"' \ python -m json.tool In this curl command, you specify several options. For information about the options, see curl command-line options. The operation returns the response body, as shown in the following example: "subnet": "cidr":" /24", "ip_version":4, "network_id":"29f52c7e-6efd-4335-a14a-db77d32a2555", "allocation_pools":[ "end":" ", "start":" ", "dns_nameservers":[ ], "host_routes":[ ], "enable_dhcp":false, "gateway_ip":null, "id":"23e3059e-4f39-4f7f-8cf2-c326e5de6c37", "name":"subamp", "tenant_id":"53501b3c25d34f8ea293c03298caed60" 2. Copy the id value from the output for future reference. In this example, the ID is 23e3059e-4f39-4f7f-8cf2-c326e5de6c37, but use the ID from your response. Next step: List networks (curl) 30

36 List networks (curl) The following step shows you how to list networks using curl. To list networks Issue the following curl command: $ curl networks \ -X GET -H "X-Auth-Token: $token" python -m json.tool The operation returns the response body as shown in the following example: "networks":[ "status":"active", "subnets":[ "23e3059e-4f39-4f7f-8cf2-c326e5de6c /24" ], "name":"amp", "admin_state_up":true, "tenant_id":"53501b3c25d34f8ea293c03298caed60", "shared":true, "id":"29f52c7e-6efd-4335-a14a-db77d32a2555", ] Next step: List subnets (curl) List subnets (curl) The following step shows you how to list subnets using curl. To list subnets Issue the following curl command: $ curl subnets \ -X GET -H "X-Auth-Token: $token" python -m json.tool The operation returns the response body as shown in the following example: "subnet": "allocation_pools":[ "end":" ", "start":" " 31