`api.iso.base`¶

/iso¶

api.iso.base.views.iso_list(*args, **kwargs)¶

List (GET) all ISO images.

GET /iso¶

DC-bound?:	✗
Permissions:	IsoAdmin
Asynchronous?:	✗
Parameters:	data.full (boolean) – Return list of objects with all ISO image details (default: false) data.extended (boolean) – Return list of objects with extended ISO image details (default: false) data.order_by (string) – Available fields for sorting: `name`, `created` (default: `name`)
Status Codes:	200 OK – SUCCESS 403 Forbidden – Forbidden

es example:

es get /iso

{
    "url": "https://my.erigones.com/api/iso/",
    "status": 200,
    "method": "GET",
    "text": {
        "status": "SUCCESS",
        "result": [
            "os-install.iso",
            "rescuecd.iso"
        ],
        "task_id": "1e1d1-6f75849b-0fbe-4295-9df3"
    }
}

/iso/(name)¶

api.iso.base.views.iso_manage(*args, **kwargs)¶

Show (GET), create (POST update (PUT) or delete (DELETE) an ISO image.

Note

All operations are currently performed only at the database level. ISO images need to be manually distributed across all compute nodes.

GET /iso/(name)¶

DC-bound?:	✓ - `dc_bound=true` ✗ - `dc_bound=false`
Permissions:	IsoAdmin - `dc_bound=true` SuperAdmin - `dc_bound=false`
Asynchronous?:	✗
Parameters:	name (string) – required - ISO image name data.extended (boolean) – Display extended ISO image details (default: false)
Status Codes:	200 OK – SUCCESS 403 Forbidden – Forbidden 404 Not Found – ISO image not found

POST /iso/(name)¶

DC-bound?:	✓ - `dc_bound=true` ✗ - `dc_bound=false`
Permissions:	IsoAdmin - `dc_bound=true` SuperAdmin - `dc_bound=false`
Asynchronous?:	✗ - Will be asynchronous in future
Parameters:	name (string) – required - ISO image file name data.alias (string) – Short ISO image name (default: `name` without “.iso”) data.access (integer) – Access type (1 - Public, 3 - Private) (default: 3) data.owner (string) – User that owns the ISO image (default: logged in user) data.desc (string) – ISO image description data.ostype (integer) – Operating system type (null - all OS types, 1 - Linux VM, 2 - SunOS VM, 3 - BSD VM, 4 - Windows VM) (default: null) data.dc_bound (boolean) – Whether the ISO image is bound to a datacenter (requires SuperAdmin permission) (default: true) data.dc (string) – Name of the datacenter the ISO image will be attached to (required if DC-bound)
Status Codes:	201 Created – SUCCESS 400 Bad Request – FAILURE 403 Forbidden – Forbidden 404 Not Found – Datacenter not found 406 Not Acceptable – ISO image already exists

PUT /iso/(name)¶

DC-bound?:	✓ - `dc_bound=true` ✗ - `dc_bound=false`
Permissions:	IsoAdmin - `dc_bound=true` SuperAdmin - `dc_bound=false`
Asynchronous?:	✗
Parameters:	name (string) – required - ISO image name data.alias (string) – Short ISO image name data.access (integer) – Access type (1 - Public, 3 - Private) data.owner (string) – User that owns the ISO image data.desc (string) – ISO image description data.ostype (integer) – Operating system type (null - all OS types, 1 - Linux VM, 2 - SunOS VM, 3 - BSD VM, 4 - Windows VM) data.dc_bound (boolean) – Whether the ISO image is bound to a datacenter (requires SuperAdmin permission)
Status Codes:	200 OK – SUCCESS 400 Bad Request – FAILURE 403 Forbidden – Forbidden 404 Not Found – ISO image not found

DELETE /iso/(name)¶

DC-bound?:	✓ - `dc_bound=true` ✗ - `dc_bound=false`
Permissions:	IsoAdmin - `dc_bound=true` SuperAdmin - `dc_bound=false`
Asynchronous?:	✗ - Will be asynchronous in future
Parameters:	name (string) – required - ISO image name
Status Codes:	200 OK – SUCCESS 400 Bad Request – FAILURE 403 Forbidden – Forbidden 404 Not Found – ISO image not found

es example:

es create /iso/os-install.iso -ostype 1

{
    "url": "https://my.erigones.com/api/iso/os-install.iso/",
    "status": 200,
    "method": "POST",
    "text": {
        "status": "SUCCESS",
        "result": {
            "name": "os-install.iso",
            "access": 3,
            "alias": "os-install",
            "ostype": "1",
            "owner": "admin",
            "dc_bound": false,
            "desc": ""
        },
        "task_id": "1e1d23-6f75849b-2018-4919-8164"
    }
}

api.iso.base¶

/iso¶

/iso/(name)¶

`api.iso.base`¶