pycons3rtapi

Python API for CONS3RT

pip install pycons3rtapi

pip install pycons3rtapi==0.0.3

git clone https://github.com/cons3rt/pycons3rtapi
cd pycons3rtapi
python setup.py install

./scripts/make-assets.sh

./build/asset-pycons3rtapi-linux.zip
./build/asset-pycons3rtapi-windows.zip

cons3rt config

Sample Code

In your python code:

from pycons3rtapi.cons3rtapi import Cons3rtApi, Cons3rtApiError

c5t = Cons3rtApi()

# list scenarios
scenarios = c5t.list_scenarios()

# retrieve active deployment runs
active_drs = c5t.list_deployment_runs_in_virtualization_realm(
    vr_id=10,
    search_type='SEARCH_ACTIVE'
)

# retrieve deployment run details
active_dr_details = c5t.retrieve_deployment_run_details(dr_id='12345')

# For some calls you can store a JSON file on the local file system and call
# with the path to the JSON file

# Launch a deployment from a JSON file
# Note: edit the deployment_id and virtualizationRealmId in the JSON file
dr_id = c5t.launch_deployment_run_from_json(
    deployment_id='12345',
    json_file='/path/to/json/file.json'
)

# Create a simple Red Hat 7 system
system_id = c5t.create_system(
    name='Hello World System',
    operatingSystem='RHEL_7_X64',
    minNumCpus=2,
    minRam=2000,
    minBootDiskCapacity=102400,
    subtype='virtualHost'
)

# Build scenario hosts data, a list of systems to be launched together in a scenario
scenario_hosts = [
    {
        'systemRole': 'helloWorldSystem1',
        'buildOrder': 1,
        'systemModule':
        {
            'subtype': 'virtualHost',
            'id': system_id
        }
    },
    {
        'systemRole': 'helloWorldSystem2',
        'buildOrder': 2,
        'systemModule':
        {
            'subtype': 'virtualHost',
            'id': system_id
        }
    }
]

# Create a scenario from the scenario hosts
scenario_id = c5t.create_scenario(
    name='Hello World Scenario',
    scenario_hosts=scenario_hosts
)

# Add the scenario to a deployment
deployment_id = c5t.create_deployment(
    name='Hello World Deployment',
    scenario_id=scenario_id
)

# Create run options for the deployment
# Note: replace the virtualizationRealmId
run_options = {
    'deploymentRunName': 'Hello World',
    'virtualizationRealmId': 12345,
    'username': 'my_username',
    'password': 'TMEroot!!abc123',
    'endState': 'TESTS_EXECUTED_RESOURCES_RESERVED'
}

# Run the deployment
run_id = c5t.run_deployment(
    deployment_id=deployment_id,
    run_options=run_options
)

# You have successfully build and launched a deployment run!!

Here is a sample file.json for launch_deployment_run_from_json, replace the virtualizationRealmId with yours:

{
  "deploymentRunName": "ReST Test",
  "endState": "TESTS_EXECUTED_RESOURCES_RESERVED",
  "virtualizationRealmId": "12345",
  "username": "myuser",
  "password": "mypassword",
  "retainOnError": "true"
}

CONS3RT CLI

The “cons3rt” command line interface (CLI) gives you a convenience way to make ReST API calls by typing simple commands. If you have followed the instructions this far you are already set up to run CLI commands. If not, see the installation section.

Run cons3rt CLI command as follows:

cons3rt <command> <options>

Commands and various options are described below:

cons3rt cloudspace --release_active_runs --delete_inactive_runs --ids=288,432,648

Asset Documentation