CreateObject Network Components - json

Question

have been referring to the createObject API and as part of my request to order a virtual machine, I would like to configure the machine with both a public and a private interface. Here are the relevant parts of the JSON which works -
{
"parameters":[{
"hostname": "hostname-test",
"domain": "domain-test",
"startCpus": 8,
"maxMemory": 16384,
"hourlyBillingFlag": true,
"operatingSystemReferenceCode": "ubuntu_14_64",
"localDiskFlag": true,
"privateNetworkOnlyFlag": false,
"networkComponents": [
{
"maxSpeed": 1000
}
]
}]
}
However I would like to also set a limited public bandwidth, similar to the options presented on the web interface. Reading the network component structure as well as the above referenced create object call, am unable to decipher the fields for choosing a specific bandwidth.
I also find no mention of the bandwidth options in getCreateObjectOptions. Any help would be great.

Answer 1

all the available options for the createObject method are displayed using this method:
https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions
In regards with the network configuration the method above will return values like this:
"networkComponents": [
{
"itemPrice": {
"hourlyRecurringFee": "0",
"recurringFee": "0",
"item": {
"description": "10 Mbps Public & Private Network Uplinks"
}
},
"template": {
"id": null,
"networkComponents": [
{
"maxSpeed": 10
}
],
"privateNetworkOnlyFlag": false
}
}
In the JSON above you can see the item "10 Mbps Public & Private Network Uplinks" if you want to configure that item in your order you need to follow the "template" configuration in this case it says that you need to add the follow configuration:
"networkComponents": [
{
"maxSpeed": 10
}
],
"privateNetworkOnlyFlag": false
That's it, however the createObject method has a drawback you only can configure the options displayed by the method getCreateObjectOptions, but the portal offers many other options which are not available using the createObject method. In case you need advanced options at the moment to order you need to use the placeOrder method this article could help you to undertand the placeOrder method:
https://sldn.softlayer.com/blog/bpotter/going-further-softlayer-api-python-client-part-3
Regards

Answer 2

Adding this here for posterity.
Here is a JSON template which can be used as a basis to build other configurations :
{
"parameters": [{
"imageTemplateId": null,
"location": "449500",
"packageId": 46,
"prices": [{
"hourlyRecurringFee": ".131",
"id": 30823,
"recurringFee": "87",
"item": {
"description": "8 x 2.0 GHz Cores"
}
}, {
"hourlyRecurringFee": ".153",
"id": 29663,
"recurringFee": "101.5",
"item": {
"description": "16 GB "
}
}, {
"hourlyRecurringFee": "0",
"id": 37204,
"recurringFee": "0",
"item": {
"description": "Ubuntu Linux 14.04 LTS Trusty Tahr - Minimal Install (64 bit)"
}
}, {
"hourlyRecurringFee": ".004",
"id": 26466,
"recurringFee": "2.9",
"item": {
"description": "100 GB (LOCAL)"
}
}, {
"hourlyRecurringFee": "0",
"id": 23070,
"recurringFee": "0",
"item": {
"description": "Reboot / Remote Console"
}
}, {
"hourlyRecurringFee": ".014",
"id": 23777,
"recurringFee": "5",
"item": {
"description": "1 Gbps Private Network Uplink"
}
}, {
"hourlyRecurringFee": "0",
"id": 34183,
"item": {
"description": "0 GB Bandwidth"
}
}, {
"hourlyRecurringFee": "0",
"id": 34807,
"recurringFee": "0",
"item": {
"description": "1 IP Address"
}
}, {
"hourlyRecurringFee": "0",
"id": 27023,
"recurringFee": "0",
"item": {
"description": "Host Ping"
}
}, {
"hourlyRecurringFee": "0",
"id": 32500,
"recurringFee": "0",
"item": {
"description": "Email and Ticket"
}
}, {
"hourlyRecurringFee": "0",
"id": 32627,
"recurringFee": "0",
"item": {
"description": "Automated Notification"
}
}, {
"hourlyRecurringFee": "0",
"id": 33483,
"recurringFee": "0",
"item": {
"description": "Unlimited SSL VPN Users & 1 PPTP VPN User per account"
}
}, {
"hourlyRecurringFee": "0",
"id": 35310,
"recurringFee": "0",
"item": {
"description": "Nessus Vulnerability Assessment & Reporting"
}
}],
"quantity": 1,
"sourceVirtualGuestId": null,
"sshKeys": [{
"sshKeyIds": [
12345
]
}],
"useHourlyPricing": true,
"virtualGuests": [{
"domain": "domain.test",
"hostname": "hostname.test"
}],
"complexType": "SoftLayer_Container_Product_Order_Virtual_Guest"
}]
}
Required ID's:
package id - obtained from SoftLayer_Product_Package->getAllObjects - it is the field "id"
price id - obtained from SoftLayer_Product_Package->getItemPrices - once again it is the field id (note there are several places where the same field name is used). This lists all the possible configurations that can go into a virtual machine. The above JSON selects a few of the options.
Finally with the JSON template, the order can be verified and placed.
(PS: Have tested this only with a virtual machine order. The SSH Key ID is an example and should be replaced with a valid ID.)