IM Command-line Interface (CLI)

The im_client is a CLI client that uses XML-RPC or REST APIs of IM Server.

Installation

Prerequisites

The im_client needs at least Python 2.4 to run.

It is also required to install the RADL parser (https://github.com/grycap/radl), available in pip as the ‘RADL’ package. It is also required the Python Requests library (http://docs.python-requests.org/) available as ‘python-requests’ in O.S. packages or ‘requests’ in pip.

Optional packages

In case of using the SSL secured version of the XMLRPC API the SpringPython framework (http://springpython.webfactional.com/) must be installed.

Installing

Docker image

A Docker image named grycap/im-client has been created. Information about this image can be found here: https://hub.docker.com/r/grycap/im-client/. It is also available in Github Container registry ghcr.io/grycap/im-client: https://github.com/grycap/im-client/pkgs/container/im-client.

How to launch the IM client using docker:

docker run --rm -ti -v "$PWD:/im-client" grycap/im-client list

From pip

You only have to call the install command of the pip tool with the IM-client package:

$ pip install IM-client

From source

Download de source code from the Github repo: https://github.com/grycap/im-client/releases. Then you only need to install the tar-gziped file to any directoy:

$ tar xvzf IM-client-X.XX.tar.gz

Configuration

To avoid typing the parameters in all the client calls. The user can define a config file “im_client.cfg” in the current directory or a file “.im_client.cfg” in their home directory. In the config file the user can specify the following parameters:

[im_client]
# only set one of the urls
#xmlrpc_url=http://localhost:8899
restapi_url=http://localhost:8800
auth_file=auth.dat
xmlrpc_ssl_ca_certs=/tmp/pki/ca-chain.pem

Invocation

The im_client is called like this:

$ im_client.py [-u|--xmlrpc-url <url>] [-r|--restapi-url <url>] [-v|--verify-ssl] [-a|--auth_file <filename>] operation op_parameters
-u|--xmlrpc-url url

URL to the XML-RPC service. This option or the ` -r` one must be specified.

-r|--rest-url url

URL to the REST API on the IM service. This option or the ` -u` one must be specified.

-v|--verify-ssl

Verify the certificates of the SSL connection. The default value is False.

-a|--auth_file filename

Path to the authorization file, see Authorization File. This option is compulsory.

-f|--force

Force the deletion of the infrastructure. Only for destroy operation. The default value is False.

-q|--quiet

Work in quiet mode. Avoid all unnecessary prints. The default value is False.

-n|--name

Show/use Infrastructure name in the selected operation. In case of list operation it will show the name of each infrastructure (if available). In other operations if this flag is set the user should specify the name of the infrastructure instead of the ID. The default value is False.

operation
list filter
List the infrastructure IDs created by the user. The filter parameter is optional and is a regex that will be used to filter the list of infrastructures. This regex will be used with the RADL or TOSCA of the infrastructure.
create inputfile async_flag
Create an infrastructure using RADL/TOSCA specified in the file with path inputfile. The async_flag parameter is optional and is a flag to specify if the creation call will wait the resources to be created or return immediately the id of the infrastructure.
destroy infId
Destroy the infrastructure with ID infId.
getinfo infId
Show the information about all the virtual machines associated to the infrastructure with ID infId.
getcontmsg infId
Show the contextualization message of the infrastructure with ID id.
getstate infId
Show the state of the infrastructure with ID id.
getoutputs <infId>
Show the outputs of infrastructure with ID infId (Only in case of TOSCA docs with REST API).
getvminfo infId vmId
Show the information associated to the virtual machine with ID vmId associated to the infrastructure with ID infId.
getvmcontmsg infId vmId
Show the contextualization message of the virtual machine with ID vmId associated to the infrastructure with ID infId.
addresource infId radlfile ctxt_flag
Add to infrastructure with ID infId the resources specifies in the RADL file with path radlfile. The ctxt_flag parameter is optional and is a flag to specify if the contextualization step will be launched just after the VM addition. If not specified the contextualization step will be launched.
removeresource infId vmId ctxt_flag
Destroy the virtual machine with ID vmId in the infrastructure with ID infId. The ctxt_flag parameter is optional and is a flag to specify if the contextualization step will be launched just after the VM addition. If not specified the contextualization step will be launched.
start infId
Resume all the virtual machines associated to the infrastructure with ID infId, stopped previously by the operation stop.
stop infId
Stop (but not remove) the virtual machines associated to the infrastructure with ID infId.
alter infId vmId radlfile
Modify the specification of the virtual machine with ID vmId associated to the infrastructure with ID vmId, using the RADL specification in file with path radlfile.
reconfigure infId radl_file vm_list
Reconfigure the infrastructure with ID infId and also update the configuration data specified in the optional radl_file. The last vm_list parameter is optional and is a list integers specifying the IDs of the VMs to reconfigure. If not specified all the VMs will be reconfigured.
startvm infId vmId
Resume the specified virtual machine vmId associated to the infrastructure with ID infId, stopped previously by the operation stop.
stopvm infId vmId
Stop (but not remove) the specified virtual machine vmId associated to the infrastructure with ID infrastructure with ID infId.
rebootvm infId vmId
Reboot the specified virtual machine vmId associated to the infrastructure with ID infrastructure with ID infId.
sshvm infId vmId [show_only]
Connect with SSH with the specified virtual machine vmId associated to the infrastructure with ID infrastructure with ID infId. The show_only parameter is optional and is a flag to specify if ssh command will only be shown in stdout instead of executed.
export infId delete
Export the data of the infrastructure with ID infId. The delete parameter is optional and is a flag to specify if the infrastructure will be deleted from the IM service (the VMs are not deleted).
import json_file
Import the data of an infrastructure previously exported with the previous function. The json_file is a file with the data generated with the export function.
wait infId [max_time]
Wait infrastructure with ID infId to get a final state. It will return code 0 if it becomes configured or 1 otherwhise. Optional parameter max_time to set the max time to wait.
create_wait_outputs inputfile

This operation is a combination of the create, wait and getoutputs functions. First it creates the infrastructure using the specified inputfile, then waits for it to be configured, and finally gets the TOSCA outputs. In case of failure in then infrastructure creation step only the error message will be returned. The results will be returned to stdout in json format:

{"infid": "ID", "error": "Error message"}

Authorization File

To access the IM service an authentication file must be created. It must have one line per authentication element. It must have at least one line with the authentication data for the IM service and another one for the Cloud/s provider/s the user want to access.

The authorization file stores in plain text the credentials to access the cloud providers, the IM service and the VMRC service. Each line of the file is composed by pairs of key and value separated by semicolon, and refers to a single credential. The key and value should be separated by ” = “, that is an equals sign preceded and followed by one white space at least, like this:

id = id_value ; type = value_of_type ; username = value_of_username ; password = value_of_password

Values can contain “=”, and “\n” is replaced by carriage return. You can also delimit the values using single or double quotes (e.g. if a semicolon or some quote character appear in a value)(from version 1.6.6):

id = id_value ; type = value_of_type ; username = value_of_username ; password = 'some;"password'
id = id_value ; type = value_of_type ; username = value_of_username ; password = "some;'password"

The available keys are:

  • type indicates the service that refers the credential. The services supported are InfrastructureManager, VMRC, OpenNebula, EC2,, FogBow, OpenStack, OCCI, LibCloud, Docker, GCE, Azure, Kubernetes, vSphere, Linode, Orange, EGI, Vault and Lambda.
  • username indicates the user name associated to the credential. In EC2 and Lambda it refers to the Access Key ID. In GCE it refers to Service Account’s Email Address. In CloudStack and Linode refers to Api Key value.
  • password indicates the password associated to the credential. In EC2 and Lambda it refers to the Secret Access Key. In GCE it refers to Service Private Key (either in JSON or PKCS12 formats). See how to get it and how to extract the private key file from here info). In CloudStack refers to Secret Key value.
  • tenant indicates the tenant associated to the credential. This field is only used in the OpenStack, Orange and Azure plugins.
  • host indicates the address of the access point to the cloud provider. In case of EGI connector it indicates the site name. This field is not used in IM, GCE, Azure, Orange, Linode, and EC2 credentials.
  • proxy indicates the content of the proxy file associated to the credential. To refer to a file you must use the function “file(/tmp/proxyfile.pem)” as shown in the example. This field is used in the OCCI and OpenStack plugins.
  • project indicates the project name associated to the credential. This field is only used in the GCE or OCCI (from version 1.6.3) plugins.
  • public_key indicates the content of the public key file associated to the credential. To refer to a file you must use the function “file(cert.pem)” as shown in the example. This field is used in the Docker plugin.
  • private_key indicates the content of the private key file associated to the credential. To refer to a file you must use the function “file(key.pem)” as shown in the example. This field is used in the Docker plugin.
  • id associates an identifier to the credential. The identifier should be used as the label in the deploy section in the RADL. The id field MUST start by a letter (not a number).
  • subscription_id indicates the subscription_id associated to the credential. This field is only used in the Azure plugin. To create a user to use the Azure plugin check the documentation of the Azure python SDK: here
  • client_id indicates the client ID associated to the credential. This field is only used in the Azure plugin. To create a user to use the Azure plugin check the documentation of the Azure python SDK: here
  • secret indicates the client secret associated to the credential. This field is only used in the Azure plugin. To create a user to use the Azure plugin check the documentation of the Azure python SDK: here
  • token indicates the OpenID token associated to the credential. This field is used in the EGI, OCCI plugins and also to authenticate with the InfrastructureManager. To refer to the output of a command you must use the function “command(command)” as shown in the examples. It can be also used in the EC2 connector to specify the security token associated with temporary credentials issued by STS.
  • vo indicates the VO name associated to the credential. This field is used in the EGI plugin.
  • path indicates the Vault path to read user credentials credential. This field is used in the Vault type. This field is optional with default value credentials/.
  • role indicates the Vault role to read user credentials credential. This field is used in the Vault and Lambda types. In case of Vault this field is optional with default value im. In case of Lambda is mandatory and it indicates the arn of the IAM role created to correcly execute Lambda functions (see here how to configure it).

Vault Credentials support

The IM also supports to read user credentials from a Vault server instead of passing all the information in the authorization file. See Vault Configuration to configure the Vault support to the IM server.

OpenStack additional fields

OpenStack has a set of additional fields to access a cloud site:

  • domain the domain name associated to the credential. The default value is: Default.
  • auth_version the auth version used to connect with the Keystone server. The possible values are: 2.0_password, 2.0_voms, 3.x_password, 3.x_appcred or 3.x_oidc_access_token. The default value is 2.0_password.
  • api_version the api version used to connect with nova endpoint. The possible values are: 1.0, 1.1, 2.0`, ``2.1 or 2.2. The default value is 2.0.
  • base_url base URL to the OpenStack API nova endpoint. By default, the connector obtains API endpoint URL from the server catalog, but if this argument is provided, this step is skipped and the provided value is used directly. The value is: http://cloud_server.com:8774/v2/<tenant_id>.
  • network_url base URL to the OpenStack API neutron endpoint. By default, the connector obtains API endpoint URL from the server catalog, but if this argument is provided, this step is skipped and the provided value is used directly. The value is: http://cloud_server.com:9696.
  • image_url base URL to the OpenStack API glance endpoint. By default, the connector obtains API endpoint URL from the server catalog, but if this argument is provided, this step is skipped and the provided value is used directly. The value is: http://cloud_server.com:9292.
  • volume_url base URL to the OpenStack API cinder endpoint. By default, the connector obtains API endpoint URL from the server catalog, but if this argument is provided, this step is skipped and the provided value is used directly. The value is: http://cloud_server.com:8776/v2/<tenant_id>.
  • service_region the region of the cloud site (case sensitive). It is used to obtain the API endpoint URL. The default value is: RegionOne.
  • service_name the service name used to obtain the API endpoint URL. The default value is: Compute. From version 1.5.3 a special name None can be used to use a Null\None value as the service name as it is used for example in the Open Telekom Cloud.
  • auth_token token which is used for authentication. If this argument is provided, normal authentication flow is skipped and the OpenStack API endpoint is directly hit with the provided token. Normal authentication flow involves hitting the auth service (Keystone) with the provided username and password and requesting an authentication token.
  • tenant_domain_id tenant domain id to set to the identity service. Some cloud providers require the tenant domain id to be provided at authentication time. Others will use a default tenant domain id if none is provided.
  • microversion set the microversion of the API to interact with OpenStack. Only valid in case of api_version >= 2.0.

OpenID Connect OpenStack sites

To connect with OpenStack sites that supports OpenID Connect some of the previous parameters has a diferent meaning:

  • username: Specifies the identity provider.
  • tenant: Specifies the authentication protocol to use (tipically oidc or openid).
  • password: Specifies the OpenID access token.

So the auth line will be like that:

id = ost; type = OpenStack; host = https://ostserver:5000; username = indentity_provider; tenant = oidc; password = access_token_value; auth_version = 3.x_oidc_access_token

Application Credentials OpenStack sites

To connect with OpenStack sites that supports Application Credentials some of the previous parameters has a diferent meaning:

  • username: Specifies the application credential ID.
  • password: Specifies the application credential secret.

So the auth line will be like that:

id = ost; type = OpenStack; host = https://ostserver:5000; username = application_credential_id; password = application_credential_secret; auth_version = 3.x_appcred
INDIGO specific parameters

To use the INDIGO IAM to authenticate with a Keystone server properly configured following this guidelines. In this case the OpenID parameters are the following:

  • username: indigo-dc.
  • tenant: oidc.
  • password: Specifies the INDIGO IAM access token.

So the auth line will be like that:

id = ost; type = OpenStack; host = https://ostserver:5000; username = indigo-dc; tenant = oidc; password = iam_token_value; auth_version = 3.x_oidc_access_token
EGI FedCloud specific parameters

To use the EGI CheckIn to authenticate with a Keystone server properly configured the parameters are the following (see more info at EGI Documentation):

  • username: egi.eu.
  • tenant: openid.
  • password: Specifies the EGI CheckIn access token.
  • domain: Specifies the OpenStack project to use. This parameter is optional. If not set the first project returned by Keystone will be selected.

So the auth line will be like that:

id = ost; type = OpenStack; host = https://ostserver:5000; username = egi.eu; tenant = openid; password = egi_aai_token_value; auth_version = 3.x_oidc_access_token; domain = project_name

From IM version 1.10.2 the EGI connector is available and you can also use this kind of auth line:

id = egi; type = EGI; host = CESGA; vo = vo.access.egi.eu; token = egi_aai_token_value

In this case the information needed to access the OpenStack API of the EGI FedCloud site will be obtained from AppDB REST API). This connector is recommended for non advanced users. If you can get the data to access the OpenStack API directly it is recommened to use it.

Open Telekom Cloud

The Open Telekom Cloud (OTC) is the cloud provided by T-Systems. It is based on OpenStack and it can be accessed using the OpenStack IM connector using an authorization line similar to the following example:

id = otc; type = OpenStack; host = https://iam.eu-de.otc.t-systems.com:443 ; username = user; password = pass; tenant = tenant; domain = domain; auth_version = 3.x_password; service_name = None; service_region = eu-de

You can get the username, password, tenant and domain values from the My Credentials section of your OTC access.

Examples

An example of the auth file:

# InfrastructureManager auth
type = InfrastructureManager; username = user; password: pass
type = InfrastructureManager: token = access_token_value
# Having at least one of the two lines above is mandatory for all auth files.
# The lines below are concrete examples for each infrastructure. Please add only the ones that are relevant to you.
# Vault auth
type = Vault; host = https://vault.com:8200; token = access_token_value; role = role; path = path
# OpenNebula site
id = one; type = OpenNebula; host = osenserver:2633; username = user; password = pass
# OpenStack site using standard user, password, tenant format
id = ost; type = OpenStack; host = https://ostserver:5000; username = user; password = pass; tenant = tenant
# OpenStack site using VOMS proxy authentication
id = ostvoms; type = OpenStack; proxy = file(/tmp/proxy.pem); host = https://keystone:5000; tenant = tname
# OpenStack site using OIDC authentication for EGI Sites
id = ost; type = OpenStack; host = https://ostserver:5000; username = egi.eu; tenant = openid; password = command(oidc-token OIDC_ACCOUNT); auth_version = 3.x_oidc_access_token; domain = project_name_or_id
#  OpenStack site using OpenID authentication
id = ost; type = OpenStack; host = https://ostserver:5000; username = indentity_provider; tenant = oidc; password = access_token_value; auth_version = 3.x_oidc_access_token
# IM auth data
id = im; type = InfrastructureManager; username = user; password = pass
# IM auth data with OIDC token
id = im; type = InfrastructureManager; token = access_token_value
# VMRC auth data
id = vmrc; type = VMRC; host = http://server:8080/vmrc; username = user; password = pass
# EC2 auth data
id = ec2; type = EC2; username = ACCESS_KEY; password = SECRET_KEY
# Google compute auth data
id = gce; type = GCE; username = username.apps.googleusercontent.com; password = pass; project = projectname
# Docker site with certificates
id = docker; type = Docker; host = http://host:2375; public_key = file(/tmp/cert.pem); private_key = file(/tmp/key.pem)
# Docker site without SSL security
id = docker; type = Docker; host = http://host:2375
# OCCI VOMS site auth data
id = occi; type = OCCI; proxy = file(/tmp/proxy.pem); host = https://server.com:11443
# OCCI OIDC site auth data
id = occi; type = OCCI; token = token; host = https://server.com:11443
# Azure site userpass auth data (old method)
id = azure_upo; type = Azure; subscription_id = subscription-id; username = user@domain.com; password = pass
# Azure site userpass auth data
id = azure_up; type = Azure; subscription_id = subscription-id; username = user@domain.com; password = pass; client_id=clientid
# Azure site site credential auth data
id = azure_sc; type = Azure; subscription_id = subscription-id; client_id=clientid; secret=client_secret; tenant=tenant_id
# Kubernetes site auth data
id = kub; type = Kubernetes; host = http://server:8080; token = auth_token
# FogBow auth data
id = fog; type = FogBow; host = http://server:8182; proxy = file(/tmp/proxy.pem)
# vSphere site auth data
id = vsphere; type = vSphere; host = http://server; username = user; password = pass
# CloudStack site auth data
id = cloudstack; type = CloudStack; host = http://server; username = apikey; password = secret
# Linode auth data
id = linode; type = Linode; username = apikey
# Orange Flexible Cloud auth data
id = orange; type = Orange; username = usern; password = pass; domain = DOMAIN; region = region; tenant = tenant
#  EGI auth data
id = egi; type = EGI; host = SITE_NAME; vo = vo_name; token = egi_aai_token_value
#  EGI auth data command
id = egi; type = EGI; host = SITE_NAME; vo = vo_name; token = command(oidc-token OIDC_ACCOUNT)
#  OSCAR auth data command
id = oscar; type = OSCAR; host = http://oscar.com; username = oscar; password = oscar123
# Lambda auth data
id = lambda; type = Lambda; username = ACCESS_KEY; password = SECRET_KEY; role = arn:aws:iam::000000000000:role/lambda-role-name

IM Server does not store the credentials used in the creation of infrastructures. Then the user has to provide them in every call of im_client.