CInP API Documentation for Contractor API¶
Namespace - root¶
URL: /api/v1/
API Version: 0.9
Namespace - root.AMT¶
URL: /api/v1/AMT/
API Version: 0.1
Model - AMTFoundation¶
URL: /api/v1/AMT/AMTFoundation
AMTFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, amt_username, amt_password, amt_ip_address, plot)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
amt_username |
String |
16 |
admin |
RW |
||||
amt_password |
String |
16 |
None |
RW |
||||
amt_ip_address |
String |
30 |
None |
RW |
||||
plot |
Model (/api/v1/Survey/Plot) |
None |
RW |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |
Namespace - root.Auth¶
URL: /api/v1/Auth/
API Version: 2.0
Model - User¶
URL: /api/v1/Auth/User
Action - login¶
URL: /api/v1/Auth/User(login)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
String |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
username |
String |
|||||
password |
String |
Action - logout¶
URL: /api/v1/Auth/User(logout)
Static: True
Action - whoami¶
URL: /api/v1/Auth/User(whoami)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
String |
Action - change_password¶
URL: /api/v1/Auth/User(change_password)
Static: True
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
password |
String |
Namespace - root.Azure¶
URL: /api/v1/Azure/
API Version: 0.1
Model - AzureComplex¶
URL: /api/v1/Azure/AzureComplex
AzureComplex(name, site, description, built_percentage, updated, created, complex_ptr, azure_subscription_id, azure_location, azure_resource_group, azure_client_id, azure_password, azure_tenant_id)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
description |
String |
200 |
None |
RW |
||||
built_percentage |
Integer |
90 |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
azure_subscription_id |
String |
36 |
None |
RW |
||||
azure_location |
String |
20 |
None |
RW |
||||
azure_resource_group |
String |
90 |
None |
RW |
||||
azure_client_id |
String |
36 |
None |
RW |
also called App Id |
|||
azure_password |
String |
36 |
None |
RW |
||||
azure_tenant_id |
String |
36 |
None |
RW |
||||
members |
Model (/api/v1/Building/ComplexStructure) |
[] |
RO |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
Model - AzureFoundation¶
URL: /api/v1/Azure/AzureFoundation
AzureFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, azure_complex, azure_resource_name)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
azure_complex |
Model (/api/v1/Azure/AzureComplex) |
None |
RW |
|||||
azure_resource_name |
String |
64 |
None |
RW |
||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |
Namespace - root.BluePrint¶
URL: /api/v1/BluePrint/
API Version: 0.1
Model - BluePrint¶
URL: /api/v1/BluePrint/BluePrint
BluePrint(name, description, config_values, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
description |
String |
200 |
None |
RW |
||||
config_values |
Map |
<callable “defaultdict”> |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
scripts |
Model (/api/v1/BluePrint/BluePrintScript) |
[] |
RO |
Action - getConfig¶
URL: /api/v1/BluePrint/BluePrint(getConfig)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Model - BluePrintScript¶
URL: /api/v1/BluePrint/BluePrintScript
BluePrintScript(id, blueprint, script, name, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
blueprint |
Model (/api/v1/BluePrint/BluePrint) |
None |
RW |
|||||
script |
Model (/api/v1/BluePrint/Script) |
None |
RW |
|||||
name |
String |
50 |
None |
RW |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Model - FoundationBluePrint¶
URL: /api/v1/BluePrint/FoundationBluePrint
FoundationBluePrint(name, description, config_values, updated, created, blueprint_ptr, foundation_type_list, template, physical_interface_names)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
description |
String |
200 |
None |
RW |
||||
config_values |
Map |
<callable “defaultdict”> |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
foundation_type_list |
String |
200 |
<callable “list”> |
RW |
||||
template |
Map |
<callable “defaultdict”> |
RW |
|||||
physical_interface_names |
String |
200 |
<callable “list”> |
RW |
||||
scripts |
Model (/api/v1/BluePrint/BluePrintScript) |
[] |
RO |
|||||
parent_list |
Model (/api/v1/BluePrint/FoundationBluePrint) |
[] |
RW |
Action - getConfig¶
URL: /api/v1/BluePrint/FoundationBluePrint(getConfig)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Model - PXE¶
URL: /api/v1/BluePrint/PXE
PXE(name, boot_script, template, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
50 |
None |
RC |
||||
boot_script |
String |
None |
RW |
|||||
template |
String |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Model - Script¶
URL: /api/v1/BluePrint/Script
Script(name, description, script, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
description |
String |
200 |
None |
RW |
||||
script |
String |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Model - StructureBluePrint¶
URL: /api/v1/BluePrint/StructureBluePrint
StructureBluePrint(name, description, config_values, updated, created, blueprint_ptr)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
description |
String |
200 |
None |
RW |
||||
config_values |
Map |
<callable “defaultdict”> |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
scripts |
Model (/api/v1/BluePrint/BluePrintScript) |
[] |
RO |
|||||
parent_list |
Model (/api/v1/BluePrint/StructureBluePrint) |
[] |
RW |
|||||
foundation_blueprint_list |
Model (/api/v1/BluePrint/FoundationBluePrint) |
[] |
RW |
Action - getConfig¶
URL: /api/v1/BluePrint/StructureBluePrint(getConfig)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Namespace - root.Building¶
URL: /api/v1/Building/
API Version: 0.1
Model - Complex¶
URL: /api/v1/Building/Complex
Complex(name, site, description, built_percentage, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
description |
String |
200 |
None |
RW |
||||
built_percentage |
Integer |
90 |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
members |
Model (/api/v1/Building/ComplexStructure) |
[] |
RO |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
Action - createFoundation¶
URL: /api/v1/Building/Complex(createFoundation)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Building/Foundation) |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
hostname |
String |
|||||
interface_name_list |
String |
Model - ComplexStructure¶
URL: /api/v1/Building/ComplexStructure
ComplexStructure(id, complex, structure, updated, created)
List Filters¶
complex¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
complex |
Model (/api/v1/Building/Complex) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
complex |
Model (/api/v1/Building/Complex) |
None |
RW |
|||||
structure |
Model (/api/v1/Building/Structure) |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Action - getConfig¶
URL: /api/v1/Building/ComplexStructure(getConfig)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Model - Dependency¶
URL: /api/v1/Building/Dependency
Dependency(id, structure, dependency, foundation, script_structure, link, create_script_name, destroy_script_name, built_at, updated, created)
List Filters¶
foundation¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
foundation |
Model (/api/v1/Building/Foundation) |
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
structure |
Model (/api/v1/Building/Structure) |
None |
RW |
|||||
dependency |
Model (/api/v1/Building/Dependency) |
None |
RW |
|||||
foundation |
Model (/api/v1/Building/Foundation) |
None |
RW |
|||||
script_structure |
Model (/api/v1/Building/Structure) |
None |
RW |
|||||
link |
String |
4 |
None |
[‘soft’, ‘hard’] |
RW |
|||
create_script_name |
String |
40 |
None |
RW |
||||
destroy_script_name |
String |
40 |
None |
RW |
||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
state |
String |
None |
RO |
Action - getJob¶
URL: /api/v1/Building/Dependency(getJob)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Foreman/DependencyJob) |
Model - Foundation¶
URL: /api/v1/Building/Foundation
Foundation(locator, site, blueprint, id_map, located_at, built_at, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
todo¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
|||||
has_dependancies |
Boolean |
|||||
foundation_class |
String |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |
|||||
structure |
Model (/api/v1/Building/Structure) |
None |
RO |
Action - setIdMap¶
URL: /api/v1/Building/Foundation(setIdMap)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
String |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
id_map |
Map |
Action - doCreate¶
URL: /api/v1/Building/Foundation(doCreate)
Static: False
This will submit a job to run the create script.
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Integer |
Action - doDestroy¶
URL: /api/v1/Building/Foundation(doDestroy)
Static: False
This will submit a job to run the destroy script.
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Integer |
Action - doJob¶
URL: /api/v1/Building/Foundation(doJob)
Static: False
This will submit a job to run the specified script.
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Integer |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
name |
String |
Action - getJob¶
URL: /api/v1/Building/Foundation(getJob)
Static: False
Return the Job for this Foundation if there is one
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Foreman/FoundationJob) |
Action - getFoundationTypes¶
URL: /api/v1/Building/Foundation(getFoundationTypes)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
String |
Action - getConfig¶
URL: /api/v1/Building/Foundation(getConfig)
Static: False
returns the computed config for this foundation
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - getInterfaceList¶
URL: /api/v1/Building/Foundation(getInterfaceList)
Static: False
returns the computed config for this foundation
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Model - Structure¶
URL: /api/v1/Building/Structure
Structure(id, hostname, site, networked_ptr, blueprint, foundation, config_uuid, config_values, built_at, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
complex¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
complex |
Model (/api/v1/Building/Complex) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
hostname |
String |
100 |
None |
RW |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/StructureBluePrint) |
None |
RW |
|||||
foundation |
Model (/api/v1/Building/Foundation) |
None |
RW |
|||||
config_uuid |
String |
36 |
<callable “getUUID”> |
RO |
||||
config_values |
Map |
<callable “defaultdict”> |
RW |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
state |
String |
None |
RO |
Action - doCreate¶
URL: /api/v1/Building/Structure(doCreate)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Integer |
Action - doDestroy¶
URL: /api/v1/Building/Structure(doDestroy)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Integer |
Action - doJob¶
URL: /api/v1/Building/Structure(doJob)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Integer |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
name |
String |
Action - getConfig¶
URL: /api/v1/Building/Structure(getConfig)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - getJob¶
URL: /api/v1/Building/Structure(getJob)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Foreman/StructureJob) |
Action - updateConfig¶
URL: /api/v1/Building/Structure(updateConfig)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
config_value_map |
Map |
Namespace - root.Directory¶
URL: /api/v1/Directory/
API Version: 0.1
Model - Entry¶
URL: /api/v1/Directory/Entry
Entry(id, zone, type, name, priority, weight, port, target, updated, created)
List Filters¶
zone¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
zone |
Model (/api/v1/Directory/Zone) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
zone |
Model (/api/v1/Directory/Zone) |
None |
RW |
|||||
type |
String |
20 |
None |
[‘MX’, ‘SRV’, ‘CNAME’, ‘TXT’] |
RW |
|||
name |
String |
255 |
None |
RW |
||||
priority |
Integer |
None |
RW |
|||||
weight |
Integer |
None |
RW |
|||||
port |
Integer |
None |
RW |
|||||
target |
String |
255 |
None |
RW |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Model - Zone¶
URL: /api/v1/Directory/Zone
Zone(name, parent, ttl, refresh, retry, expire, minimum, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
100 |
None |
RC |
||||
parent |
Model (/api/v1/Directory/Zone) |
None |
RW |
|||||
ttl |
Integer |
3600 |
RW |
|||||
refresh |
Integer |
86400 |
RW |
|||||
retry |
Integer |
7200 |
RW |
|||||
expire |
Integer |
36000 |
RW |
|||||
minimum |
Integer |
172800 |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
fqdn |
String |
None |
RO |
Namespace - root.Docker¶
URL: /api/v1/Docker/
API Version: 0.1
Model - DockerComplex¶
URL: /api/v1/Docker/DockerComplex
DockerComplex(name, site, description, built_percentage, updated, created, complex_ptr)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
description |
String |
200 |
None |
RW |
||||
built_percentage |
Integer |
90 |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
members |
Model (/api/v1/Building/ComplexStructure) |
[] |
RO |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
Model - DockerFoundation¶
URL: /api/v1/Docker/DockerFoundation
DockerFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, docker_complex, docker_id)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
docker_complex |
Model (/api/v1/Docker/DockerComplex) |
None |
RW |
|||||
docker_id |
String |
64 |
None |
RO |
||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |
Model - DockerPort¶
URL: /api/v1/Docker/DockerPort
DockerPort(id, complex, port, address_offset, foundation, foundation_index, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
complex |
Model (/api/v1/Docker/DockerComplex) |
None |
RW |
|||||
port |
Integer |
None |
RW |
|||||
address_offset |
Integer |
None |
RW |
|||||
foundation |
Model (/api/v1/Docker/DockerFoundation) |
None |
RW |
|||||
foundation_index |
Integer |
0 |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Namespace - root.Foreman¶
URL: /api/v1/Foreman/
API Version: 0.1
Model - BaseJob¶
URL: /api/v1/Foreman/BaseJob
BaseJob(id, site, state, status, message, script_runner, script_name, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
None |
RO |
|||||
state |
String |
10 |
None |
[‘queued’, ‘waiting’, ‘done’, ‘paused’, ‘error’, ‘aborted’] |
RW |
|||
status |
String |
[] |
RW |
|||||
message |
String |
1024 |
RW |
|||||
script_name |
String |
40 |
False |
RO |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
progress |
String |
None |
RO |
|||||
can_start |
String |
None |
RO |
Action - pause¶
URL: /api/v1/Foreman/BaseJob(pause)
Static: False
Pause a job that is in 'queued' state state.
Errors:
NOT_PAUSEABLE - Job is not in state 'queued'.
Action - resume¶
URL: /api/v1/Foreman/BaseJob(resume)
Static: False
Resume a job that is in 'paused' state state.
Errors:
NOT_PAUSED - Job is not in state 'paused'.
Action - reset¶
URL: /api/v1/Foreman/BaseJob(reset)
Static: False
Resets a job that is in 'error' state, this allows the job to try the failed step again.
Errors:
NOT_ERRORED - Job is not in state 'error'.
Action - rollback¶
URL: /api/v1/Foreman/BaseJob(rollback)
Static: False
Starts the rollback for jobs that are in state 'error'.
Errors:
NOT_ERRORED - Job is not in state 'error'.
Action - clear_dispatched¶
URL: /api/v1/Foreman/BaseJob(clear_dispatched)
Static: False
Resets a job that is in 'queued' state, and subcontractor lost the job. Make
sure to verify that subcontractor has lost the job results before calling this.
Errors:
NOT_ERRORED - Job is not in state 'queued'.
Action - jobStats¶
URL: /api/v1/Foreman/BaseJob(jobStats)
Static: True
Returns the job status
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Action - jobRunnerVariables¶
URL: /api/v1/Foreman/BaseJob(jobRunnerVariables)
Static: False
Returns variables internal to the job script
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - jobRunnerState¶
URL: /api/v1/Foreman/BaseJob(jobRunnerState)
Static: False
Returns the state of the job script
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Model - DependencyJob¶
URL: /api/v1/Foreman/DependencyJob
DependencyJob(id, site, state, status, message, script_runner, script_name, updated, created, basejob_ptr, dependency)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
None |
RO |
|||||
state |
String |
10 |
None |
[‘queued’, ‘waiting’, ‘done’, ‘paused’, ‘error’, ‘aborted’] |
RW |
|||
status |
String |
[] |
RW |
|||||
message |
String |
1024 |
RW |
|||||
script_name |
String |
40 |
False |
RO |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
dependency |
Model (/api/v1/Building/Dependency) |
None |
RO |
|||||
progress |
String |
None |
RO |
|||||
can_start |
String |
None |
RO |
Action - pause¶
URL: /api/v1/Foreman/DependencyJob(pause)
Static: False
See BaseJob.pause
Action - resume¶
URL: /api/v1/Foreman/DependencyJob(resume)
Static: False
See BaseJob.resume
Action - reset¶
URL: /api/v1/Foreman/DependencyJob(reset)
Static: False
See BaseJob.reset
Action - rollback¶
URL: /api/v1/Foreman/DependencyJob(rollback)
Static: False
See BaseJob.rollback
Action - jobRunnerVariables¶
URL: /api/v1/Foreman/DependencyJob(jobRunnerVariables)
Static: False
See BaseJob.jobRunnerVariables
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - jobRunnerState¶
URL: /api/v1/Foreman/DependencyJob(jobRunnerState)
Static: False
See BaseJob.jobRunnerState
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - getDependencyJob¶
URL: /api/v1/Foreman/DependencyJob(getDependencyJob)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Foreman/DependencyJob) |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
dependency |
Model (/api/v1/Building/Dependency) |
Model - FoundationJob¶
URL: /api/v1/Foreman/FoundationJob
FoundationJob(id, site, state, status, message, script_runner, script_name, updated, created, basejob_ptr, foundation)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
None |
RO |
|||||
state |
String |
10 |
None |
[‘queued’, ‘waiting’, ‘done’, ‘paused’, ‘error’, ‘aborted’] |
RW |
|||
status |
String |
[] |
RW |
|||||
message |
String |
1024 |
RW |
|||||
script_name |
String |
40 |
False |
RO |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
foundation |
Model (/api/v1/Building/Foundation) |
None |
RO |
|||||
progress |
String |
None |
RO |
|||||
can_start |
String |
None |
RO |
Action - pause¶
URL: /api/v1/Foreman/FoundationJob(pause)
Static: False
See BaseJob.pause
Action - resume¶
URL: /api/v1/Foreman/FoundationJob(resume)
Static: False
See BaseJob.resume
Action - reset¶
URL: /api/v1/Foreman/FoundationJob(reset)
Static: False
See BaseJob.reset
Action - rollback¶
URL: /api/v1/Foreman/FoundationJob(rollback)
Static: False
See BaseJob.rollback
Action - jobRunnerVariables¶
URL: /api/v1/Foreman/FoundationJob(jobRunnerVariables)
Static: False
See BaseJob.jobRunnerVariables
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - jobRunnerState¶
URL: /api/v1/Foreman/FoundationJob(jobRunnerState)
Static: False
See BaseJob.jobRunnerState
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - getFoundationJob¶
URL: /api/v1/Foreman/FoundationJob(getFoundationJob)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Foreman/FoundationJob) |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
foundation |
Model (/api/v1/Building/Foundation) |
Model - JobLog¶
URL: /api/v1/Foreman/JobLog
JobLog(id, site, job_id, target_class, target_description, script_name, creator, started_at, finished_at, canceled_by, canceled_at, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
job_id |
Integer |
None |
RW |
|||||
target_class |
String |
50 |
None |
RW |
||||
target_description |
String |
120 |
None |
RW |
||||
script_name |
String |
50 |
None |
RW |
||||
creator |
String |
150 |
None |
RW |
||||
started_at |
DateTime |
None |
RW |
|||||
finished_at |
DateTime |
None |
RW |
|||||
canceled_by |
String |
150 |
None |
RW |
||||
canceled_at |
DateTime |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Model - StructureJob¶
URL: /api/v1/Foreman/StructureJob
StructureJob(id, site, state, status, message, script_runner, script_name, updated, created, basejob_ptr, structure)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
None |
RO |
|||||
state |
String |
10 |
None |
[‘queued’, ‘waiting’, ‘done’, ‘paused’, ‘error’, ‘aborted’] |
RW |
|||
status |
String |
[] |
RW |
|||||
message |
String |
1024 |
RW |
|||||
script_name |
String |
40 |
False |
RO |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
structure |
Model (/api/v1/Building/Structure) |
None |
RO |
|||||
progress |
String |
None |
RO |
|||||
can_start |
String |
None |
RO |
Action - pause¶
URL: /api/v1/Foreman/StructureJob(pause)
Static: False
See BaseJob.pause
Action - resume¶
URL: /api/v1/Foreman/StructureJob(resume)
Static: False
See BaseJob.resume
Action - reset¶
URL: /api/v1/Foreman/StructureJob(reset)
Static: False
See BaseJob.reset
Action - rollback¶
URL: /api/v1/Foreman/StructureJob(rollback)
Static: False
See BaseJob.rollback
Action - jobRunnerVariables¶
URL: /api/v1/Foreman/StructureJob(jobRunnerVariables)
Static: False
See BaseJob.jobRunnerVariables
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - jobRunnerState¶
URL: /api/v1/Foreman/StructureJob(jobRunnerState)
Static: False
See BaseJob.jobRunnerState
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - getStructureJob¶
URL: /api/v1/Foreman/StructureJob(getStructureJob)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Foreman/StructureJob) |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
structure |
Model (/api/v1/Building/Structure) |
Namespace - root.IPMI¶
URL: /api/v1/IPMI/
API Version: 0.1
Model - IPMIFoundation¶
URL: /api/v1/IPMI/IPMIFoundation
IPMIFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, ipmi_username, ipmi_password, ipmi_ip_address, plot)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
ipmi_username |
String |
16 |
None |
RW |
||||
ipmi_password |
String |
16 |
None |
RW |
||||
ipmi_ip_address |
String |
30 |
None |
RW |
||||
plot |
Model (/api/v1/Survey/Plot) |
None |
RW |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |
Namespace - root.Manual¶
URL: /api/v1/Manual/
API Version: 0.1
Model - ManualComplex¶
URL: /api/v1/Manual/ManualComplex
ManualComplex(name, site, description, built_percentage, updated, created, complex_ptr)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
description |
String |
200 |
None |
RW |
||||
built_percentage |
Integer |
90 |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
members |
Model (/api/v1/Building/ComplexStructure) |
[] |
RO |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
Model - ManualComplexedFoundation¶
URL: /api/v1/Manual/ManualComplexedFoundation
ManualComplexedFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, complex_host)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
complex_host |
Model (/api/v1/Manual/ManualComplex) |
None |
RW |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |
Model - ManualFoundation¶
URL: /api/v1/Manual/ManualFoundation
ManualFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |
Namespace - root.PostOffice¶
URL: /api/v1/PostOffice/
API Version: 0.1
Model - FoundationBox¶
URL: /api/v1/PostOffice/FoundationBox
FoundationBox(id, url, proxy, type, one_shot, extra_data, expires, updated, created, foundation)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
url |
String |
2048 |
None |
RW |
||||
proxy |
String |
512 |
None |
RW |
||||
type |
String |
4 |
None |
[‘post’, ‘call’] |
RW |
|||
one_shot |
Boolean |
True |
RW |
|||||
extra_data |
Map |
<callable “defaultdict”> |
RW |
|||||
expires |
DateTime |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
foundation |
Model (/api/v1/Building/Foundation) |
None |
RW |
Action - extend¶
URL: /api/v1/PostOffice/FoundationBox(extend)
Static: False
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
additional_hours |
Integer |
Model - FoundationPost¶
URL: /api/v1/PostOffice/FoundationPost
FoundationPost(id, name, updated, created, foundation)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RW |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
foundation |
Model (/api/v1/Building/Foundation) |
None |
RW |
Model - StructureBox¶
URL: /api/v1/PostOffice/StructureBox
StructureBox(id, url, proxy, type, one_shot, extra_data, expires, updated, created, structure)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
url |
String |
2048 |
None |
RW |
||||
proxy |
String |
512 |
None |
RW |
||||
type |
String |
4 |
None |
[‘post’, ‘call’] |
RW |
|||
one_shot |
Boolean |
True |
RW |
|||||
extra_data |
Map |
<callable “defaultdict”> |
RW |
|||||
expires |
DateTime |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
structure |
Model (/api/v1/Building/Structure) |
None |
RW |
Action - extend¶
URL: /api/v1/PostOffice/StructureBox(extend)
Static: False
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
additional_hours |
Integer |
Model - StructurePost¶
URL: /api/v1/PostOffice/StructurePost
StructurePost(id, name, updated, created, structure)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RW |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
structure |
Model (/api/v1/Building/Structure) |
None |
RW |
Namespace - root.Records¶
URL: /api/v1/Records/
API Version: 0.1
Model - Recorder¶
URL: /api/v1/Records/Recorder
Action - query¶
URL: /api/v1/Records/Recorder(query)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
String |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
group |
String |
[‘Site’, ‘BluePrint’, ‘Structure’, ‘Foundation’] |
||||
query |
String |
|||||
fields |
String |
{} |
||||
max_results |
Integer |
100 |
Action - query_objects¶
URL: /api/v1/Records/Recorder(query_objects)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
String |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
group |
String |
[‘Site’, ‘BluePrint’, ‘Structure’, ‘Foundation’] |
||||
query |
String |
|||||
max_results |
Integer |
100 |
Namespace - root.Site¶
URL: /api/v1/Site/
API Version: 0.1
Model - Site¶
URL: /api/v1/Site/Site
Site(name, zone, description, parent, config_values, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
zone |
Model (/api/v1/Directory/Zone) |
None |
RW |
|||||
description |
String |
200 |
None |
RW |
||||
parent |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
config_values |
Map |
<callable “defaultdict”> |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Action - getConfig¶
URL: /api/v1/Site/Site(getConfig)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Action - getDependencyMap¶
URL: /api/v1/Site/Site(getDependencyMap)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Namespace - root.SubContractor¶
URL: /api/v1/SubContractor/
API Version: 0.1
Model - DHCPd¶
URL: /api/v1/SubContractor/DHCPd
Action - getDynamicPools¶
URL: /api/v1/SubContractor/DHCPd(getDynamicPools)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Action - getStaticPools¶
URL: /api/v1/SubContractor/DHCPd(getStaticPools)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Model - Dispatch¶
URL: /api/v1/SubContractor/Dispatch
Action - getJobs¶
URL: /api/v1/SubContractor/Dispatch(getJobs)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
|||||
module_list |
String |
|||||
max_jobs |
Integer |
10 |
Action - jobResults¶
URL: /api/v1/SubContractor/Dispatch(jobResults)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
String |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
job_id |
Integer |
|||||
cookie |
String |
|||||
data |
Map |
Action - jobError¶
URL: /api/v1/SubContractor/Dispatch(jobError)
Static: True
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
job_id |
Integer |
|||||
cookie |
String |
|||||
msg |
String |
Namespace - root.Survey¶
URL: /api/v1/Survey/
API Version: 0.1
Model - Cartographer¶
URL: /api/v1/Survey/Cartographer
Cartographer(identifier, foundation, message, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
identifier |
String |
64 |
None |
RC |
||||
foundation |
Model (/api/v1/Building/Foundation) |
None |
RW |
|||||
message |
String |
200 |
None |
RW |
||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Action - register¶
URL: /api/v1/Survey/Cartographer(register)
Static: True
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
identifier |
String |
Action - lookup¶
URL: /api/v1/Survey/Cartographer(lookup)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
info_map |
Map |
None |
Action - setMessage¶
URL: /api/v1/Survey/Cartographer(setMessage)
Static: False
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
message |
String |
Action - done¶
URL: /api/v1/Survey/Cartographer(done)
Static: False
Model - Plot¶
URL: /api/v1/Survey/Plot
Plot(name, corners, parent, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
corners |
String |
200 |
None |
RW |
||||
parent |
Model (/api/v1/Survey/Plot) |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Namespace - root.Utilities¶
URL: /api/v1/Utilities/
API Version: 0.1
Model - AbstractNetworkInterface¶
URL: /api/v1/Utilities/AbstractNetworkInterface
AbstractNetworkInterface(id, name, is_provisioning, network, updated, created, networkinterface_ptr)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
20 |
None |
RW |
||||
is_provisioning |
Boolean |
False |
RW |
|||||
network |
Model (/api/v1/Utilities/Network) |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Model - Address¶
URL: /api/v1/Utilities/Address
Address(id, address_block, offset, updated, created, baseaddress_ptr, networked, interface_name, sub_interface, pointer, is_primary)
List Filters¶
address_block¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
address_block |
Model (/api/v1/Utilities/AddressBlock) |
structure¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
structure |
Model (/api/v1/Building/Structure) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
address_block |
Model (/api/v1/Utilities/AddressBlock) |
None |
RW |
|||||
offset |
Integer |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
networked |
Model (/api/v1/Utilities/Networked) |
None |
RW |
|||||
interface_name |
String |
20 |
None |
RW |
||||
sub_interface |
Integer |
None |
RW |
|||||
pointer |
Model (/api/v1/Utilities/Address) |
None |
RW |
|||||
is_primary |
Boolean |
False |
RW |
|||||
type |
String |
None |
RO |
|||||
ip_address |
String |
None |
RO |
|||||
subnet |
String |
None |
RO |
|||||
netmask |
String |
None |
RO |
|||||
prefix |
String |
None |
RO |
|||||
gateway |
String |
None |
RO |
Model - AddressBlock¶
URL: /api/v1/Utilities/AddressBlock
AddressBlock(id, name, site, subnet, prefix, gateway_offset, _max_address, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RW |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
subnet |
String |
None |
RW |
|||||
prefix |
Integer |
None |
RW |
|||||
gateway_offset |
Integer |
None |
RW |
|||||
_max_address |
String |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
gateway |
String |
None |
RO |
|||||
netmask |
String |
None |
RO |
|||||
size |
String |
None |
RO |
|||||
isIpV4 |
String |
None |
RO |
Action - nextAddress¶
URL: /api/v1/Utilities/AddressBlock(nextAddress)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Utilities/Address) |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
networked |
Model (/api/v1/Utilities/Networked) |
|||||
interface_name |
String |
|||||
is_primary |
Boolean |
Action - usage¶
URL: /api/v1/Utilities/AddressBlock(usage)
Static: False
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Map |
Model - AggregatedNetworkInterface¶
URL: /api/v1/Utilities/AggregatedNetworkInterface
AggregatedNetworkInterface(id, name, is_provisioning, network, updated, created, networkinterface_ptr, abstractnetworkinterface_ptr, master_interface, paramaters)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
20 |
None |
RW |
||||
is_provisioning |
Boolean |
False |
RW |
|||||
network |
Model (/api/v1/Utilities/Network) |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
master_interface |
Model (/api/v1/Utilities/NetworkInterface) |
None |
RW |
|||||
paramaters |
Map |
<callable “defaultdict”> |
RW |
|||||
slaves |
Model (/api/v1/Utilities/NetworkInterface) |
[] |
RW |
Model - BaseAddress¶
URL: /api/v1/Utilities/BaseAddress
BaseAddress(id, address_block, offset, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
address_block |
Model (/api/v1/Utilities/AddressBlock) |
None |
RW |
|||||
offset |
Integer |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
ip_address |
String |
None |
RO |
|||||
subnet |
String |
None |
RO |
|||||
netmask |
String |
None |
RO |
|||||
prefix |
String |
None |
RO |
|||||
gateway |
String |
None |
RO |
Action - lookup¶
URL: /api/v1/Utilities/BaseAddress(lookup)
Static: True
Return Type:
Type |
Length |
Array |
Doc |
|---|---|---|---|
Model (/api/v1/Utilities/BaseAddress) |
Paramaters:
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
ip_address |
String |
Model - DynamicAddress¶
URL: /api/v1/Utilities/DynamicAddress
DynamicAddress(id, address_block, offset, updated, created, baseaddress_ptr, pxe)
List Filters¶
address_block¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
address_block |
Model (/api/v1/Utilities/AddressBlock) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
address_block |
Model (/api/v1/Utilities/AddressBlock) |
None |
RW |
|||||
offset |
Integer |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
pxe |
Model (/api/v1/BluePrint/PXE) |
None |
RW |
|||||
type |
String |
None |
RO |
|||||
ip_address |
String |
None |
RO |
|||||
subnet |
String |
None |
RO |
|||||
netmask |
String |
None |
RO |
|||||
prefix |
String |
None |
RO |
|||||
gateway |
String |
None |
RO |
Model - Network¶
URL: /api/v1/Utilities/Network
Network(id, name, site, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RW |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
address_block_list |
Model (/api/v1/Utilities/NetworkAddressBlock) |
[] |
RO |
Model - NetworkAddressBlock¶
URL: /api/v1/Utilities/NetworkAddressBlock
NetworkAddressBlock(id, network, address_block, vlan, vlan_tagged, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
network |
Model (/api/v1/Utilities/Network) |
None |
RW |
|||||
address_block |
Model (/api/v1/Utilities/AddressBlock) |
None |
RW |
|||||
vlan |
Integer |
0 |
RW |
|||||
vlan_tagged |
Boolean |
False |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Model - NetworkInterface¶
URL: /api/v1/Utilities/NetworkInterface
NetworkInterface(id, name, is_provisioning, network, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
20 |
None |
RW |
||||
is_provisioning |
Boolean |
False |
RW |
|||||
network |
Model (/api/v1/Utilities/Network) |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
Model - Networked¶
URL: /api/v1/Utilities/Networked
Networked(id, hostname, site)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
hostname |
String |
100 |
None |
RW |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
Model - RealNetworkInterface¶
URL: /api/v1/Utilities/RealNetworkInterface
RealNetworkInterface(id, name, is_provisioning, network, updated, created, networkinterface_ptr, mac, foundation, physical_location, link_name, pxe)
List Filters¶
foundation¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
foundation |
Model (/api/v1/Building/Foundation) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
20 |
None |
RW |
||||
is_provisioning |
Boolean |
False |
RW |
|||||
network |
Model (/api/v1/Utilities/Network) |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
mac |
String |
18 |
None |
RW |
||||
foundation |
Model (/api/v1/Building/Foundation) |
None |
RW |
|||||
physical_location |
String |
100 |
None |
RW |
||||
link_name |
String |
100 |
None |
RW |
||||
pxe |
Model (/api/v1/BluePrint/PXE) |
None |
RW |
Model - ReservedAddress¶
URL: /api/v1/Utilities/ReservedAddress
ReservedAddress(id, address_block, offset, updated, created, baseaddress_ptr, reason)
List Filters¶
address_block¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
address_block |
Model (/api/v1/Utilities/AddressBlock) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
address_block |
Model (/api/v1/Utilities/AddressBlock) |
None |
RW |
|||||
offset |
Integer |
None |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
reason |
String |
50 |
None |
RW |
||||
type |
String |
None |
RO |
|||||
ip_address |
String |
None |
RO |
|||||
subnet |
String |
None |
RO |
|||||
netmask |
String |
None |
RO |
|||||
prefix |
String |
None |
RO |
|||||
gateway |
String |
None |
RO |
Namespace - root.VCenter¶
URL: /api/v1/VCenter/
API Version: 0.1
Model - VCenterComplex¶
URL: /api/v1/VCenter/VCenterComplex
VCenterComplex(name, site, description, built_percentage, updated, created, complex_ptr, vcenter_host, vcenter_username, vcenter_password, vcenter_datacenter, vcenter_cluster)
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
description |
String |
200 |
None |
RW |
||||
built_percentage |
Integer |
90 |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
vcenter_host |
Model (/api/v1/Building/Structure) |
None |
RW |
set to VCenter or the ESX host, if ESX host, leave members empty |
||||
vcenter_username |
String |
50 |
None |
RW |
||||
vcenter_password |
String |
50 |
None |
RW |
||||
vcenter_datacenter |
String |
50 |
None |
RW |
set to “ha-datacenter” for ESX hosts |
|||
vcenter_cluster |
String |
50 |
None |
RW |
set to the hostname (ie: “localhost.”) for ESX hosts |
|||
members |
Model (/api/v1/Building/ComplexStructure) |
[] |
RO |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
Model - VCenterFoundation¶
URL: /api/v1/VCenter/VCenterFoundation
VCenterFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, vcenter_complex, vcenter_uuid)
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
vcenter_complex |
Model (/api/v1/VCenter/VCenterComplex) |
None |
RW |
|||||
vcenter_uuid |
String |
36 |
None |
RW |
||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |
Namespace - root.VirtualBox¶
URL: /api/v1/VirtualBox/
API Version: 0.1
Plugin for VirtualBox.
Model - VirtualBoxComplex¶
URL: /api/v1/VirtualBox/VirtualBoxComplex
Complex for VirtualBox. Only one member is allowed. The ip address
for managing the VirtualBox instance comes from the member's primary ip.
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
description |
String |
200 |
None |
RW |
||||
built_percentage |
Integer |
90 |
RW |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
virtualbox_username |
String |
50 |
None |
RW |
||||
virtualbox_password |
String |
50 |
None |
RW |
||||
members |
Model (/api/v1/Building/ComplexStructure) |
[] |
RO |
|||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
Model - VirtualBoxFoundation¶
URL: /api/v1/VirtualBox/VirtualBoxFoundation
Foundation for use with VirtualBoxComplex. Foundation instances are tracked
by the internal VirtualBox Hardware UUID.
List Filters¶
site¶
Name |
Type |
Length |
Default |
Choices |
Array |
Doc |
|---|---|---|---|---|---|---|
site |
Model (/api/v1/Site/Site) |
Fields¶
Name |
Type |
Length |
Default |
Choices |
Array |
Mode |
Req |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
None |
RC |
||||
site |
Model (/api/v1/Site/Site) |
None |
RW |
|||||
blueprint |
Model (/api/v1/BluePrint/FoundationBluePrint) |
None |
RW |
|||||
id_map |
String |
None |
RW |
|||||
located_at |
DateTime |
None |
RO |
|||||
built_at |
DateTime |
None |
RO |
|||||
updated |
DateTime |
None |
RO |
|||||
created |
DateTime |
None |
RO |
|||||
virtualbox_complex |
Model (/api/v1/VirtualBox/VirtualBoxComplex) |
None |
RW |
|||||
virtualbox_uuid |
String |
36 |
None |
RW |
||||
state |
String |
None |
RO |
|||||
type |
String |
None |
RO |
|||||
class_list |
String |
None |
RO |