|
1 | | -# Sandbox-API-Python |
2 | | -Sandbox API Python wrapper |
| 1 | +CloudShell Sandbox API Wrapper |
| 2 | +============================== |
3 | 3 |
|
4 | | -**Usage:** |
5 | | -```python |
6 | | -from Sandbox import Sandbox |
7 | | -blueprint_name = "Sandbox Python API Test" |
8 | | -sandbox_name = "Sandbox Python API Test" |
9 | | -config_file = "quali_config.json" |
| 4 | +Installation |
| 5 | +************* |
| 6 | +:: |
10 | 7 |
|
11 | | -my_sandbox = Sandbox(config_file=config_file) |
12 | | -my_sandbox.login() |
| 8 | + pip install cloudshell_sandboxapi_wrapper |
13 | 9 |
|
14 | | -my_sandbox.get_blueprints() |
15 | | -blueprint_id = my_sandbox.get_blueprint_id(blueprint_name=blueprint_name) |
16 | | -print "Blueprint Id:", blueprint_id |
17 | | -my_sandbox.get_blueprint_details(blueprint_id=blueprint_id) |
18 | | -my_sandbox.get_blueprint_details_by_name(blueprint_name=blueprint_name) |
| 10 | +Example Usage |
| 11 | +************** |
| 12 | +:: |
19 | 13 |
|
20 | | -my_sandbox.start_sandbox(blueprint_id=blueprint_id, duration='20', sandbox_name='') |
21 | | -my_sandbox.start_sandbox_by_name(blueprint_name=blueprint_name, duration='20', sandbox_name='') |
22 | | -my_sandbox.get_sandboxes() |
23 | | -sandbox_id = my_sandbox.get_sandbox_ids(sandbox_name=sandbox_name) |
24 | | -print "Sandbox Id:", sandbox_id |
25 | | -my_sandbox.get_sandbox_details(sandbox_id=sandbox_id[0]) |
26 | | -my_sandbox.get_sandboxes_details_by_name(sandbox_name=sandbox_name) |
27 | | -my_sandbox.stop_sandbox(sandbox_id=sandbox_id[0]) |
28 | | -my_sandbox.stop_sandboxes_by_name(sandbox_name=sandbox_name) |
29 | | -``` |
| 14 | + from cloudshell_sandboxapi_wrapper.SandboxAPI import SandboxAPI |
| 15 | + sandbox = SandboxAPI(host=SERVER_NAME, username=USERNAME, password=PASSWORD, domain=DOMAIN, port=SERVER_PORT) |
| 16 | + blueprints = sandbox.get_blueprints() |
| 17 | + blueprint_id = sandbox.get_blueprint_details(blueprint_id=BLUEPRINT_NAME)['id'] |
| 18 | + sandbox_id = sandbox.start_sandbox(BLUEPRINT_NAME, PT23H, SANDBOX_NAME) |
| 19 | + sandbox.stop_sandbox(sandbox_id) |
| 20 | + |
| 21 | +| |
| 22 | + |
| 23 | +:Note: |
| 24 | + Tested on cloudshell 9.3 with Python 2.7/3.7/3.8. |
| 25 | + For API details, please refer to CloudShell Sandbox API help: `CloudShell Sandbox API <https://help.quali.com/Online%20Help/9.3/Api-Guide/Content/API/CS-Snbx-API-Topic.htm>`_ |
| 26 | + |
| 27 | +| |
0 commit comments