OpenStack Command-Line Interface Reference

Transcription

1 docs.openstack.org

2 OpenStack Command-Line Interface Reference current ( ) Copyright 2014 OpenStack Foundation Some rights reserved. This guide documents the OpenStack command-line clients. Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. ii

3 Table of Contents Preface... xx Conventions... xx Document change history... xx 1. OpenStack command-line clients... 1 Overview... 1 Install the OpenStack command-line clients... 3 Discover the version number for a client... 6 Set environment variables using the OpenStack RC file Bare metal command-line client ironic usage ironic optional arguments ironic chassis-create ironic chassis-delete ironic chassis-list ironic chassis-node-list ironic chassis-show ironic chassis-update ironic driver-list ironic driver-properties ironic driver-show ironic driver-vendor-passthru ironic node-create ironic node-delete ironic node-get-boot-device ironic node-get-console ironic node-get-supported-boot-devices ironic node-list ironic node-port-list ironic node-set-boot-device ironic node-set-console-mode ironic node-set-power-state ironic node-set-provision-state ironic node-show ironic node-update ironic node-validate ironic node-vendor-passthru ironic port-create ironic port-delete ironic port-list ironic port-show ironic port-update Block Storage command-line client cinder usage cinder optional arguments Block Storage API v1 commands Block Storage API v2 commands Compute command-line client nova usage iii

4 nova optional arguments nova absolute-limits nova add-fixed-ip nova add-secgroup nova agent-create nova agent-delete nova agent-list nova agent-modify nova aggregate-add-host nova aggregate-create nova aggregate-delete nova aggregate-details nova aggregate-list nova aggregate-remove-host nova aggregate-set-metadata nova aggregate-update nova availability-zone-list nova backup nova baremetal-interface-add nova baremetal-interface-list nova baremetal-interface-remove nova baremetal-node-create nova baremetal-node-delete nova baremetal-node-list nova baremetal-node-show nova boot nova cell-capacities nova cell-show nova clear-password nova cloudpipe-configure nova cloudpipe-create nova cloudpipe-list nova console-log nova credentials nova delete nova diagnostics nova dns-create nova dns-create-private-domain nova dns-create-public-domain nova dns-delete nova dns-delete-domain nova dns-domains nova dns-list nova endpoints nova evacuate nova fixed-ip-get nova fixed-ip-reserve nova fixed-ip-unreserve nova flavor-access-add nova flavor-access-list nova flavor-access-remove iv

5 nova flavor-create nova flavor-delete nova flavor-key nova flavor-list nova flavor-show nova floating-ip-associate nova floating-ip-bulk-create nova floating-ip-bulk-delete nova floating-ip-bulk-list nova floating-ip-create nova floating-ip-delete nova floating-ip-disassociate nova floating-ip-list nova floating-ip-pool-list nova force-delete nova get-password nova get-rdp-console nova get-serial-console nova get-spice-console nova get-vnc-console nova host-action nova host-describe nova host-evacuate nova host-list nova host-meta nova host-servers-migrate nova host-update nova hypervisor-list nova hypervisor-servers nova hypervisor-show nova hypervisor-stats nova hypervisor-uptime nova image-create nova image-delete nova image-list nova image-meta nova image-show nova instance-action nova instance-action-list nova interface-attach nova interface-detach nova interface-list nova keypair-add nova keypair-delete nova keypair-list nova keypair-show nova list nova list-extensions nova list-secgroup nova live-migration nova lock v

6 nova meta nova migrate nova migration-list nova net nova net-create nova net-delete nova net-list nova network-associate-host nova network-associate-project nova network-create nova network-delete nova network-disassociate nova network-list nova network-show nova pause nova quota-class-show nova quota-class-update nova quota-defaults nova quota-delete nova quota-show nova quota-update nova rate-limits nova reboot nova rebuild nova refresh-network nova remove-fixed-ip nova remove-secgroup nova rename nova rescue nova reset-network nova reset-state nova resize nova resize-confirm nova resize-revert nova restore nova resume nova root-password nova scrub nova secgroup-add-default-rule nova secgroup-add-group-rule nova secgroup-add-rule nova secgroup-create nova secgroup-delete nova secgroup-delete-default-rule nova secgroup-delete-group-rule nova secgroup-delete-rule nova secgroup-list nova secgroup-list-default-rules nova secgroup-list-rules nova secgroup-update nova server-group-create vi

7 nova server-group-delete nova server-group-get nova server-group-list nova service-delete nova service-disable nova service-enable nova service-list nova shelve nova shelve-offload nova show nova ssh nova start nova stop nova suspend nova unlock nova unpause nova unrescue nova unshelve nova usage nova usage-list nova version-list nova volume-attach nova volume-create nova volume-delete nova volume-detach nova volume-list nova volume-show nova volume-snapshot-create nova volume-snapshot-delete nova volume-snapshot-list nova volume-snapshot-show nova volume-type-create nova volume-type-delete nova volume-type-list nova volume-update nova x509-create-cert nova x509-get-root-cert Identity service command-line client keystone usage keystone optional arguments keystone bootstrap keystone catalog keystone discover keystone ec2-credentials-create keystone ec2-credentials-delete keystone ec2-credentials-get keystone ec2-credentials-list keystone endpoint-create keystone endpoint-delete keystone endpoint-get keystone endpoint-list vii

8 keystone password-update keystone role-create keystone role-delete keystone role-get keystone role-list keystone service-create keystone service-delete keystone service-get keystone service-list keystone tenant-create keystone tenant-delete keystone tenant-get keystone tenant-list keystone tenant-update keystone token-get keystone user-create keystone user-delete keystone user-get keystone user-list keystone user-password-update keystone user-role-add keystone user-role-list keystone user-role-remove keystone user-update Image Service command-line client glance usage glance optional arguments Image Service API v1 commands Image Service API v2 commands Image Service property keys Networking command-line client neutron usage neutron optional arguments neutron API v2.0 commands neutron agent-delete neutron agent-list neutron agent-show neutron agent-update neutron cisco-credential-create neutron cisco-credential-delete neutron cisco-credential-list neutron cisco-credential-show neutron cisco-network-profile-create neutron cisco-network-profile-delete neutron cisco-network-profile-list neutron cisco-network-profile-show neutron cisco-network-profile-update neutron cisco-policy-profile-list neutron cisco-policy-profile-show neutron cisco-policy-profile-update neutron dhcp-agent-list-hosting-net viii

9 neutron dhcp-agent-network-add neutron dhcp-agent-network-remove neutron ext-list neutron ext-show neutron firewall-create neutron firewall-delete neutron firewall-list neutron firewall-policy-create neutron firewall-policy-delete neutron firewall-policy-insert-rule neutron firewall-policy-list neutron firewall-policy-remove-rule neutron firewall-policy-show neutron firewall-policy-update neutron firewall-rule-create neutron firewall-rule-delete neutron firewall-rule-list neutron firewall-rule-show neutron firewall-rule-update neutron firewall-show neutron firewall-update neutron floatingip-associate neutron floatingip-create neutron floatingip-delete neutron floatingip-disassociate neutron floatingip-list neutron floatingip-show neutron gateway-device-create neutron gateway-device-delete neutron gateway-device-list neutron gateway-device-show neutron gateway-device-update neutron ipsec-site-connection-create neutron ipsec-site-connection-delete neutron ipsec-site-connection-list neutron ipsec-site-connection-show neutron ipsec-site-connection-update neutron l3-agent-list-hosting-router neutron l3-agent-router-add neutron l3-agent-router-remove neutron lb-agent-hosting-pool neutron lb-healthmonitor-associate neutron lb-healthmonitor-create neutron lb-healthmonitor-delete neutron lb-healthmonitor-disassociate neutron lb-healthmonitor-list neutron lb-healthmonitor-show neutron lb-healthmonitor-update neutron lb-member-create neutron lb-member-delete neutron lb-member-list ix

10 neutron lb-member-show neutron lb-member-update neutron lb-pool-create neutron lb-pool-delete neutron lb-pool-list neutron lb-pool-list-on-agent neutron lb-pool-show neutron lb-pool-stats neutron lb-pool-update neutron lb-vip-create neutron lb-vip-delete neutron lb-vip-list neutron lb-vip-show neutron lb-vip-update neutron meter-label-create neutron meter-label-delete neutron meter-label-list neutron meter-label-rule-create neutron meter-label-rule-delete neutron meter-label-rule-list neutron meter-label-rule-show neutron meter-label-show neutron nec-packet-filter-create neutron nec-packet-filter-delete neutron nec-packet-filter-list neutron nec-packet-filter-show neutron nec-packet-filter-update neutron net-create neutron net-delete neutron net-external-list neutron net-gateway-connect neutron net-gateway-create neutron net-gateway-delete neutron net-gateway-disconnect neutron net-gateway-list neutron net-gateway-show neutron net-gateway-update neutron net-list neutron net-list-on-dhcp-agent neutron net-show neutron net-update neutron nuage-netpartition-create neutron nuage-netpartition-delete neutron nuage-netpartition-list neutron nuage-netpartition-show neutron port-create neutron port-delete neutron port-list neutron port-show neutron port-update neutron queue-create x

11 neutron queue-delete neutron queue-list neutron queue-show neutron quota-delete neutron quota-list neutron quota-show neutron quota-update neutron router-create neutron router-delete neutron router-gateway-clear neutron router-gateway-set neutron router-interface-add neutron router-interface-delete neutron router-list neutron router-list-on-l3-agent neutron router-port-list neutron router-show neutron router-update neutron security-group-create neutron security-group-delete neutron security-group-list neutron security-group-rule-create neutron security-group-rule-delete neutron security-group-rule-list neutron security-group-rule-show neutron security-group-show neutron security-group-update neutron service-provider-list neutron subnet-create neutron subnet-delete neutron subnet-list neutron subnet-show neutron subnet-update neutron vpn-ikepolicy-create neutron vpn-ikepolicy-delete neutron vpn-ikepolicy-list neutron vpn-ikepolicy-show neutron vpn-ikepolicy-update neutron vpn-ipsecpolicy-create neutron vpn-ipsecpolicy-delete neutron vpn-ipsecpolicy-list neutron vpn-ipsecpolicy-show neutron vpn-ipsecpolicy-update neutron vpn-service-create neutron vpn-service-delete neutron vpn-service-list neutron vpn-service-show neutron vpn-service-update neutron-debug command-line client neutron-debug usage neutron-debug optional arguments xi

12 neutron-debug probe-create command neutron-debug probe-list command neutron-debug probe-clear command neutron-debug probe-delete command neutron-debug probe-exec command neutron-debug ping-all command neutron-debug example Object Storage command-line client swift usage swift examples swift optional arguments swift delete swift download swift list swift post swift stat swift upload Orchestration command-line client heat usage heat optional arguments heat action-check heat action-resume heat action-suspend heat build-info heat event-list heat event-show heat output-list heat output-show heat resource-list heat resource-metadata heat resource-show heat resource-signal heat resource-template heat resource-type-list heat resource-type-show heat resource-type-template heat stack-abandon heat stack-adopt heat stack-cancel-update heat stack-create heat stack-delete heat stack-list heat stack-preview heat stack-show heat stack-update heat template-show heat template-validate Telemetry command-line client ceilometer usage ceilometer optional arguments ceilometer alarm-combination-create xii

13 ceilometer alarm-combination-update ceilometer alarm-delete ceilometer alarm-history ceilometer alarm-list ceilometer alarm-show ceilometer alarm-state-get ceilometer alarm-state-set ceilometer alarm-threshold-create ceilometer alarm-threshold-update ceilometer alarm-update ceilometer event-list ceilometer event-show ceilometer event-type-list ceilometer meter-list ceilometer query-alarm-history ceilometer query-alarms ceilometer query-samples ceilometer resource-list ceilometer resource-show ceilometer sample-create ceilometer sample-list ceilometer statistics ceilometer trait-description-list ceilometer trait-list Database Service command-line client trove usage trove optional arguments trove backup-copy trove backup-create trove backup-delete trove backup-list trove backup-list-instance trove backup-show trove cluster-create trove cluster-delete trove cluster-instances trove cluster-list trove cluster-show trove configuration-attach trove configuration-create trove configuration-default trove configuration-delete trove configuration-detach trove configuration-instances trove configuration-list trove configuration-parameter-list trove configuration-parameter-show trove configuration-patch trove configuration-show trove configuration-update trove create xiii

14 trove database-create trove database-delete trove database-list trove datastore-list trove datastore-show trove datastore-version-list trove datastore-version-show trove delete trove detach-replica trove flavor-list trove flavor-show trove limit-list trove list trove metadata-create trove metadata-delete trove metadata-edit trove metadata-list trove metadata-show trove metadata-update trove resize-instance trove resize-volume trove restart trove root-enable trove root-show trove secgroup-add-rule trove secgroup-delete-rule trove secgroup-list trove secgroup-list-rules trove secgroup-show trove show trove update trove user-create trove user-delete trove user-grant-access trove user-list trove user-revoke-access trove user-show trove user-show-access trove user-update-attributes Database Service Management command-line client trove-manage usage trove-manage optional arguments trove-manage datastore_update command trove-manage datastore_version_update command trove-manage db_downgrade command trove-manage db_recreate command trove-manage db_sync command trove-manage db_upgrade command Data processing command-line client sahara usage sahara optional arguments xiv

15 sahara cluster-create sahara cluster-delete sahara cluster-list sahara cluster-show sahara cluster-template-create sahara cluster-template-delete sahara cluster-template-list sahara cluster-template-show sahara data-source-create sahara data-source-delete sahara data-source-list sahara data-source-show sahara image-add-tag sahara image-list sahara image-register sahara image-remove-tag sahara image-show sahara image-unregister sahara job-binary-create sahara job-binary-data-create sahara job-binary-data-delete sahara job-binary-data-list sahara job-binary-delete sahara job-binary-list sahara job-binary-show sahara job-create sahara job-delete sahara job-list sahara job-show sahara job-template-create sahara job-template-delete sahara job-template-list sahara job-template-show sahara node-group-template-create sahara node-group-template-delete sahara node-group-template-list sahara node-group-template-show sahara plugin-list sahara plugin-show OpenStack client openstack usage openstack optional arguments openstack aggregate add host openstack aggregate create openstack aggregate delete openstack aggregate list openstack aggregate remove host openstack aggregate set openstack aggregate show openstack backup create openstack backup delete xv

16 openstack backup list openstack backup restore openstack backup show openstack compute agent create openstack compute agent delete openstack compute agent list openstack compute agent set openstack compute service list openstack compute service set openstack console log show openstack console url show openstack container create openstack container delete openstack container list openstack container show openstack ec2 credentials create openstack ec2 credentials delete openstack ec2 credentials list openstack ec2 credentials show openstack endpoint create openstack endpoint delete openstack endpoint list openstack endpoint show openstack extension list openstack flavor create openstack flavor delete openstack flavor list openstack flavor show openstack host list openstack host show openstack hypervisor list openstack hypervisor show openstack image create openstack image delete openstack image list openstack image save openstack image set openstack image show openstack ip fixed add openstack ip fixed remove openstack ip floating add openstack ip floating create openstack ip floating delete openstack ip floating list openstack ip floating pool list openstack ip floating remove openstack keypair create openstack keypair delete openstack keypair list openstack keypair show openstack limits show xvi

17 openstack module list openstack network create openstack network delete openstack network list openstack network set openstack network show openstack object create openstack object delete openstack object list openstack object show openstack project create openstack project delete openstack project list openstack project set openstack project show openstack project usage list openstack quota set openstack quota show openstack role add openstack role create openstack role delete openstack role list openstack role remove openstack role show openstack security group create openstack security group delete openstack security group list openstack security group rule create openstack security group rule delete openstack security group rule list openstack security group set openstack security group show openstack server add security group openstack server add volume openstack server create openstack server delete openstack server image create openstack server list openstack server lock openstack server migrate openstack server pause openstack server reboot openstack server rebuild openstack server remove security group openstack server remove volume openstack server rescue openstack server resize openstack server resume openstack server set openstack server show openstack server ssh xvii

18 openstack server suspend openstack server unlock openstack server unpause openstack server unrescue openstack server unset openstack service create openstack service delete openstack service list openstack service show openstack snapshot create openstack snapshot delete openstack snapshot list openstack snapshot set openstack snapshot show openstack token issue openstack token revoke openstack user create openstack user delete openstack user list openstack user role list openstack user set openstack user show openstack volume create openstack volume delete openstack volume list openstack volume set openstack volume show openstack volume type create openstack volume type delete openstack volume type list openstack volume type set openstack volume type unset openstack volume unset A. Community support Documentation ask.openstack.org OpenStack mailing lists The OpenStack wiki The Launchpad Bugs area The OpenStack IRC channel Documentation feedback OpenStack distribution packages xviii

19 List of Tables 1.1. OpenStack services and clients Prerequisite software Property keys xix

20 Preface Conventions... xx Document change history... xx Conventions Notices The OpenStack documentation uses several typesetting conventions. Notices take these forms: Note A handy tip or reminder. Important Something you must be aware of before proceeding. Warning Command prompts Critical information about the risk of data loss or security issues. $ prompt Any user, including the root user, can run commands that are prefixed with the $ prompt. # prompt The root user must run commands that are prefixed with the # prompt. You can also prefix these commands with the sudo command, if available, to run them. Document change history This version of the guide replaces and obsoletes all earlier versions. The following table describes the most recent changes: Revision Date October 15, 2014 September 6, 2014 April 16, 2014 January 29, 2014 March 14, 2014 Summary of Changes For the Juno release, this guide has been updated for all integrated command-line clients. The additional chapters for the Juno release include the OpenStack client, the Data processing client, and the trove-manage command. Document OpenStack client. For the Icehouse release, updated documentation for clients, add trove options, document neutron-debug, document Image Service property keys. Initial version. Added documentation for the neutron-debug command. xx

21 1. OpenStack command-line clients Overview Overview... 1 Install the OpenStack command-line clients... 3 Discover the version number for a client... 6 Set environment variables using the OpenStack RC file... 7 Each OpenStack project provides a command-line client, which enables you to access the project API through easy-to-use commands. For example, the Compute service provides a nova command-line client. You can run the commands from the command line, or include the commands within scripts to automate tasks. If you provide OpenStack credentials, such as your user name and password, you can run these commands on any computer. Internally, each command uses curl command-line tools, which embed API requests. Open- Stack APIs are RESTful APIs, and use the HTTP protocol. They include methods, URIs, media types, and response codes. OpenStack APIs are open-source Python clients, and can run on Linux or Mac OS X systems. On some client commands, you can specify a debug parameter to show the underlying API request for the command. This is a good way to become familiar with the OpenStack API calls. The following table lists the command-line client for each OpenStack service with its package name and description. Table 1.1. OpenStack services and clients Service Client Package Description Block Storage cinder python-cinderclient Create and manage volumes. Compute nova python-novaclient Create and manage images, instances, and flavors. Database Service trove python-troveclient Create and manage databases. Identity keystone python-keystoneclient Create and manage users, tenants, roles, endpoints, and credentials. Image Service glance python-glanceclient Create and manage images. Networking neutron python-neutronclient Configure networks for guest servers. This client was previously called quantum. Object Storage swift python-swiftclient Gather statistics, list items, update metadata, and upload, download, and delete files stored by the Object Storage service. Gain access to an Object Storage installation for ad hoc processing. Orchestration heat python-heatclient Launch stacks from templates, view details of running stacks including events and resources, and update and delete stacks. Telemetry ceilometer python-ceilometerclient Create and collect measurements across OpenStack. Data Processing sahara python-saharaclient Creates and manages Hadoop clusters on OpenStack. Common client openstack python-openstackclient Common client for the OpenStack project. 1

22 2

23 Install the OpenStack command-line clients Install the prerequisite software and the Python package for each OpenStack client. Install the prerequisite software Most Linux distributions include packaged versions of the command-line clients that you can install directly, see the section called Installing from packages [5]. If you need to install the command-line packages source packages, the following table lists the software that you need to have to run the command-line clients, and provides installation instructions as needed. Table 1.2. Prerequisite software Prerequisite Python 2.7 or later setuptools package Description Currently, the clients do not support Python 3. Installed by default on Mac OS X. Many Linux distributions provide packages to make setuptools easy to install. Search your package manager for setuptools to find an installation package. If you cannot find one, download the setuptools package directly from The recommended way to install setuptools on Microsoft Windows is to follow the documentation provided on the setuptools website. Another option is to use the unofficial binary installer maintained by Christoph Gohlke ( pip package To install the clients on a Linux, Mac OS X, or Microsoft Windows system, use pip. It is easy to use, ensures that you get the latest version of the clients from the Python Package Index, and lets you update or remove the packages later on. Since the installation process compiles source files, this requires the related Python development package for your operating system and distribution. Install pip through the package manager for your system: MacOS. # easy_install pip Microsoft Windows. Ensure that the C:\Python27\Scripts directory is defined in the PATH environment variable, and use the easy_install command from the setuptools package: C:\>easy_install pip Another option is to use the unofficial binary installer provided by Christoph Gohlke ( Ubuntu and Debian. # apt-get install python-devel python-pip Note that extra dependencies may be required, per operating system, depending on the package being installed, such as is the case with Tempest. A packaged version en- Red Hat Enterprise Linux, CentOS, or Fedora. ables you to use yum to install the package: # yum install python-dev python-pip 3

24 Prerequisite Description There are also packaged versions of the clients available in RDO that enable yum to install the clients as described in the section called Installing from packages [5]. Install the clients SUSE Linux Enterprise Linux 11. A packaged version available in the Open Build Service enables you to use or zypper to install the package. First, add the Open Build Service repository: # zypper addrepo -f obs://cloud:openstack:icehouse/sle_11_sp3 Icehouse Then install pip and use it to manage client installation: # zypper install python-devel python-pip There are also packaged versions of the clients available that enable zypper to install the clients as described in the section called Installing from packages [5]. opensuse. You can install pip and use it to manage client installation: # zypper install python-devel python-pip There are also packaged versions of the clients available that enable zypper to install the clients as described in the section called Installing from packages [5] When following the instructions in this section, replace PROJECT with the lowercase name of the client to install, such as nova. Repeat for each client. The following values are valid: ceilometer - Telemetry API cinder - Block Storage API and extensions glance - Image Service API heat - Orchestration API keystone - Identity service API and extensions neutron - Networking API nova - Compute API and extensions sahara - Database Processing API swift - Object Storage API trove - Database Service API common - Common OpenStack client The following example shows the command for installing the nova client with pip. # pip install python-novaclient 4

25 Installing with pip Use pip to install the OpenStack clients on a Linux, Mac OS X, or Microsoft Windows system. It is easy to use and ensures that you get the latest version of the client from the Python Package Index. Also, pip enables you to update or remove a package. Install each client separately by using the following command: For Mac OS X or Linux: # pip install python-projectclient For Microsoft Windows: C:\>pip install python-projectclient Installing from packages RDO, opensuse and SUSE Linux Enterprise have client packages that can be installed without pip. On Red Hat Enterprise Linux, CentOS, or Fedora, use yum to install the clients from the packaged versions available in RDO: # yum install python-projectclient For opensuse, use zypper to install the clients from the distribution packages Service: # zypper install python-project For SUSE Linux Enterprise Server, use zypper to install the clients from the distribution packages in the Open Build Service. First, add the Open Build Service repository: # zypper addrepo -f obs://cloud:openstack:icehouse/sle_11_sp3 Icehouse Then you can install the packages: # zypper install python-project Upgrade or remove clients What's next To upgrade a client, add the --upgrade option to the pip install command: # pip install --upgrade python-projectclient To remove the a client, run the pip uninstall command: # pip uninstall python-projectclient Before you can run client commands, you must create and source the PROJECTopenrc.sh file to set environment variables. See the section called Set environment variables using the OpenStack RC file [7]. 5

26 Discover the version number for a client Run the following command to discover the version number for a client: $ PROJECT --version For example, to see the version number for the nova client, run the following command: $ nova --version The version number ( in the example) is returned

27 Set environment variables using the OpenStack RC file To set the required environment variables for the OpenStack command-line clients, you must create an environment file called an OpenStack rc file, or openrc.sh file. If your OpenStack installation provides it, you can download the file from the OpenStack dashboard as an administrative user or any other user. This project-specific environment file contains the credentials that all OpenStack services use. When you source the file, environment variables are set for your current shell. The variables enable the OpenStack client commands to communicate with the OpenStack services that run in the cloud. Note Defining environment variables using an environment file is not a common practice on Microsoft Windows. Environment variables are usually defined in the Advanced tab of the System Properties dialog box. Download and source the OpenStack RC file 1. Log in to the OpenStack dashboard, choose the project for which you want to download the OpenStack RC file, and click Access & Security. 2. On the API Access tab, click Download OpenStack RC File and save the file. The filename will be of the form PROJECT-openrc.sh where PROJECT is the name of the project for which you downloaded the file. 3. Copy the PROJECT-openrc.sh file to the computer from which you want to run OpenStack commands. For example, copy the file to the computer from which you want to upload an image with a glance client command. 4. On any shell from which you want to run OpenStack commands, source the PROJECTopenrc.sh file for the respective project. In the following example, the demo-openrc.sh file is sourced for the demo project: $ source demo-openrc.sh 5. When you are prompted for an OpenStack password, enter the password for the user who downloaded the PROJECT-openrc.sh file. Create and source the OpenStack RC file Alternatively, you can create the PROJECT-openrc.sh file from scratch, if for some reason you cannot download the file from the dashboard. 1. In a text editor, create a file named PROJECT-openrc.sh file and add the following authentication information: 7

28 export OS_USERNAME=username export OS_PASSWORD=password export OS_TENANT_NAME=projectName export OS_AUTH_URL= # The following lines can be omitted export OS_TENANT_ID=tenantIDString export OS_REGION_NAME=regionName 2. On any shell from which you want to run OpenStack commands, source the PROJECTopenrc.sh file for the respective project. In this example, you source the admin-openrc.sh file for the admin project: $ source admin-openrc.sh Note You are not prompted for the password with this method. The password lives in clear text format in the PROJECT-openrc.sh file. Restrict the permissions on this file to avoid security problems. You can also remove the OS_PASSWORD variable from the file, and use the --password parameter with OpenStack client commands instead. Override environment variable values When you run OpenStack client commands, you can override some environment variable settings by using the options that are listed at the end of the help output of the various client commands. For example, you can override the OS_PASSWORD setting in the PROJECT-openrc.sh file by specifying a password on a keystone command, as follows: $ keystone --os-password PASSWORD service-list Where PASSWORD is your password. Keyring support Keyring is a password management system available in OpenStack. You can install it using the following command: $ pip install keyring Note Keyring is used only if --os-use-keyring is specified or if the environment variable OS_USE_KEYRING=true is defined. A user specifies their username and password credentials to interact with OpenStack, using any client command. These credentials can be specified using various mechanisms, namely, the environment variable, or command line argument. It is not safe to specify the password using either of these methods. For example, when you specify your password using the command-line client with the -- os-password argument, anyone with access to your computer can view it in plain text with the ps field. 8

29 To avoid storing the password in plain text, you can prompt for the OpenStack password interactively. Then, the keyring can store the password and the user can safely retrieve it from their keyring. The encrypted password is stored in the ~/.openstack-keyring.cfg file. 9

30 2. Bare metal command-line client ironic usage ironic optional arguments ironic chassis-create ironic chassis-delete ironic chassis-list ironic chassis-node-list ironic chassis-show ironic chassis-update ironic driver-list ironic driver-properties ironic driver-show ironic driver-vendor-passthru ironic node-create ironic node-delete ironic node-get-boot-device ironic node-get-console ironic node-get-supported-boot-devices ironic node-list ironic node-port-list ironic node-set-boot-device ironic node-set-console-mode ironic node-set-power-state ironic node-set-provision-state ironic node-show ironic node-update ironic node-validate ironic node-vendor-passthru ironic port-create ironic port-delete ironic port-list ironic port-show ironic port-update The ironic client is the command-line interface (CLI) for the Bare metal and its extensions. This chapter documents ironic version For help on a specific ironic command, enter: $ ironic help COMMAND ironic usage usage: ironic [--version] [--debug] [-v] [-k] [--cert-file CERT_FILE] [--key-file KEY_FILE] [--ca-file CA_FILE] [--timeout TIMEOUT] [--os-username OS_USERNAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--ironic-url IRONIC_URL] [--ironic-api-version IRONIC_API_VERSION] [--os-service-type OS_SERVICE_TYPE] 10

31 Subcommands [--os-endpoint-type OS_ENDPOINT_TYPE] <subcommand>... chassis-create chassis-delete chassis-list chassis-node-list chassis-show chassis-update node-create node-delete node-get-boot-device node-get-console node-get-supported-boot-devices node-list node-port-list node-set-boot-device node-set-console-mode node-set-power-state node-set-provision-state node-show node-update node-validate node-vendor-passthru port-create port-delete port-list port-show Create a new chassis. Delete a chassis. List chassis. List the nodes contained in the chassis. Show a chassis. Update a chassis. Register a new node with the Ironic service. Unregister a node from the Ironic service. Get the current boot device. Return the connection information for the node's console, if enabled. Get the supported boot devices. List nodes which are registered with the Ironic service. List the ports associated with the node. Set the boot device for a node. Enable or disable serial console access for this node. Power the node on or off. Provision an instance on, or delete an instance from a node. Show detailed information for a node. Update information about a registered node. Validate the node driver interfaces. Call a vendor-passthru extension for a node. Create a new port. Delete a port. List ports. Show a port. 11

32 port-update driver-list driver-properties driver-show driver-vendor-passthru bash-completion Update a port. List of enabled drivers. Get properties of the driver. Show a driver. Call a vendor-passthru extension for a driver. Prints all of the commands and options for bash- completion. help ironic optional arguments Display help about this program or one of its subcommands. --version --debug -v, --verbose -k, --insecure --cert-file CERT_FILE --key-file KEY_FILE --ca-file CA_FILE --timeout TIMEOUT --os-username OS_USERNAME --os-password OS_PASSWORD --os-tenant-id OS_TENANT_ID --os-tenant-name OS_TENANT_NAME --os-auth-url OS_AUTH_URL --os-region-name OS_REGION_NAME show program's version number and exit Defaults to env[ironicclient_debug] Print more verbose output Explicitly allow ironicclient to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key Path of client key to use in SSL connection. This option is not necessary if your key is prepended to your cert file Path of CA SSL certificate(s) used to verify the remote server certificate. Without this option ironic looks for the default system CA certificates Number of seconds to wait for a response; defaults to 600 Defaults to env[os_username] Defaults to env[os_password] Defaults to env[os_tenant_id] Defaults to env[os_tenant_name] Defaults to env[os_auth_url] Defaults to env[os_region_name] 12

33 --os-auth-token OS_AUTH_TOKEN --ironic-url IRONIC_URL --ironic-api-version IRONIC_API_VERSION --os-service-type OS_SERVICE_TYPE --os-endpoint-type OS_ENDPOINT_TYPE ironic chassis-create Defaults to env[os_auth_token] Defaults to env[ironic_url] Defaults to env[ironic_api_version] or 1 Defaults to env[os_service_type] or "baremetal" Defaults to env[os_endpoint_type] or "publicurl" usage: ironic chassis-create [-d <description>] [-e <key=value>] Create a new chassis. -d <description>, --description <description> -e <key=value>, --extra <key=value> ironic chassis-delete Free text description of the chassis Record arbitrary key/value metadata. Can be specified multiple times usage: ironic chassis-delete <chassis id> [<chassis id>...] Delete a chassis. <chassis id> ironic chassis-list UUID of chassis usage: ironic chassis-list [--detail] [--limit <limit>] [--marker <marker>] [--sort-key <sort_key>] [--sort-dir <sort_dir>] List chassis. --detail --limit <limit> Show detailed information about chassis. Maximum number of chassis to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service. 13

34 --marker <marker> --sort-key <sort_key> Chassis UUID (e.g of the last chassis in the list from a previous request). Returns the list of chassis after this UUID. Chassis field that will be used for sorting. --sort-dir <sort_dir> ironic chassis-node-list Sort direction: one of "asc" (the default) or "desc". usage: ironic chassis-node-list [--detail] [--limit <limit>] [--marker <marker>] [--sort-key <sort_key>] [--sort-dir <sort_dir>] <chassis id> List the nodes contained in the chassis. <chassis id> UUID of chassis --detail --limit <limit> --marker <marker> --sort-key <sort_key> --sort-dir <sort_dir> ironic chassis-show Show detailed information about nodes. Maximum number of nodes to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service. Node UUID (e.g of the last node in the list from a previous request). Returns the list of nodes after this UUID. Node field that will be used for sorting. Sort direction: one of "asc" (the default) or "desc". usage: ironic chassis-show <chassis id> Show a chassis. <chassis id> UUID of chassis ironic chassis-update usage: ironic chassis-update <chassis id> <op> <path=value> [<path=value>...] Update a chassis. <chassis id> UUID of chassis 14

35 <op> Operations: 'add', 'replace' or 'remove' <path=value> ironic driver-list usage: ironic driver-list List of enabled drivers. ironic driver-properties Attributes to add/replace or remove (only PATH is necessary on remove) usage: ironic driver-properties <driver name> Get properties of the driver. <driver name> ironic driver-show name of a driver usage: ironic driver-show <driver_name> Show a driver. <driver_name> Name of the driver ironic driver-vendor-passthru usage: ironic driver-vendor-passthru <driver_name> <method> [<arg=value> [<arg=value>...]] Call a vendor-passthru extension for a driver. <driver_name> <method> Name of the driver vendor-passthru method to be called <arg=value> ironic node-create arguments to be passed to vendor-passthru method usage: ironic node-create [-c <chassis uuid>] [-d <driver>] [-i <key=value>] [-p <key=value>] [-e <key=value>] Register a new node with the Ironic service. 15

36 -c <chassis uuid>, --chassis_uuid <chassis uuid> UUID of the chassis that this node belongs to -d <driver>, --driver <driver> Driver used to control the node [REQUIRED] -i <key=value>, --driver_info <key=value> -p <key=value>, --properties <key=value> -e <key=value>, --extra <key=value> ironic node-delete Key/value pairs used by the driver, such as out-of- band managementcredentials. Can be specified multiple times Key/value pairs describing the physical characteristics of the node. This is exported to Nova and used by the scheduler. Can be specified multiple times Record arbitrary key/value metadata. Can be specified multiple times usage: ironic node-delete <node id> [<node id>...] Unregister a node from the Ironic service. <node id> UUID of node ironic node-get-boot-device usage: ironic node-get-boot-device <node uuid> Get the current boot device. <node uuid> UUID of node ironic node-get-console usage: ironic node-get-console <node uuid> Return the connection information for the node's console, if enabled. <node uuid> UUID of node ironic node-get-supported-boot-devices usage: ironic node-get-supported-boot-devices <node uuid> 16

37 Get the supported boot devices. <node uuid> ironic node-list UUID of node usage: ironic node-list [--limit <limit>] [--marker <marker>] [--sort-key <sort_key>] [--sort-dir <sort_dir>] [--maintenance <maintenance>] [--associated <assoc>] [--detail] List nodes which are registered with the Ironic service. --limit <limit> --marker <marker> --sort-key <sort_key> --sort-dir <sort_dir> --maintenance <maintenance> --associated <assoc> --detail ironic node-port-list Maximum number of nodes to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service. Node UUID (e.g of the last node in the list from a previous request). Returns the list of nodes after this UUID. Node field that will be used for sorting. Sort direction: one of "asc" (the default) or "desc". List nodes in maintenance mode: 'true' or 'false' List nodes by instance association: 'true' or 'false' Show detailed information about nodes usage: ironic node-port-list [--detail] [--limit <limit>] [--marker <marker>] [--sort-key <sort_key>] [--sort-dir <sort_dir>] <node id> List the ports associated with the node. <node id> UUID of node --detail --limit <limit> Show detailed information about ports. Maximum number of ports to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service. 17

38 --marker <marker> --sort-key <sort_key> Port UUID (e.g of the last port in the list from a previous request). Returns the list of ports after this UUID. Port field that will be used for sorting. --sort-dir <sort_dir> Sort direction: one of "asc" (the default) or "desc". ironic node-set-boot-device usage: ironic node-set-boot-device [--persistent] <node uuid> <boot device> Set the boot device for a node. <node uuid> <boot device> UUID of node Supported boot devices: 'pxe', 'disk', 'cdrom', 'bios', 'safe' --persistent Make changes persistent for all future boots ironic node-set-console-mode usage: ironic node-set-console-mode <node uuid> <enabled> Enable or disable serial console access for this node. <node uuid> UUID of node <enabled> Enable or disable the console access. Supported options are: 'true' or 'false' ironic node-set-power-state usage: ironic node-set-power-state <node id> <power state> Power the node on or off. <node id> UUID of node <power state> Supported states: 'on' or 'off' or 'reboot' ironic node-set-provision-state usage: ironic node-set-provision-state <node id> <provision state> 18