×
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
 
 
BMC TrueSight Capacity Optimization 11.5 ... Developing Using Public APIs Reservation API

Reservation API - Using Custom resource instances

This page contains configuration information necessary to use Reservations with Custom resource instances. For more information about the Reservation API, see Reservation API.

Method

URI pattern

Samples
Reservations

POST

rsv/reservations

Sample

GET
rsv/reservations/{reservation-id}

Sample

PUT
rsv/reservations/{reservation-id}

Sample

Reservation items
GETrsv/reservations/{reservation-id}/items/{item-id}Sample
PUTrsv/reservations/{reservation-id}/items/{item-id}Sample
Onboardings
POSTrsv/onboardingsSample
GETrsv/onboardings/{onboarding-id}Sample
PUTrsv/onboardings/{onboarding-id}Sample
Offboardings
POST
rsv/offboardings
Sample
GETrsv/offboardings/{offboarding-id}Sample
PUT
rsv/offboardings/{offboarding-id}
Sample

Sample request and response files

The following examples describe the type of searches that can be conducted using the Reservations API:

Reservations

Creating a Reservation

 Click here to view/hide the sample request file for adding a Reservation with resources...
{
    "name": "my_rsv",
    "startDate": "17/12/2014",
    "description": "Reserve resources for POC",
    "owner": "alan",
    "externalId": "co_user",
    "priority": "MEDIUM",
    "probability": 56,
    "realizationMode": "AUTOMATIC", 
	"highAvailability": "NO",
    "resources": {
        "resourceSpecs": [
            {
                "numItems": 2,
                "name": "DB_Server",
                "enttypenm": "gm:vmw"
                "cpuCores": 8,
                "cpuTotalMHz": 20000,
                "memTotal": 10737418240,
                "storageTotal": 42949672960,
                "os": "UNIX",
                "cpuEntitledCapacity": 4,
                "cpuUtilization": 0.1,
                "memUtilization": 0.9,
                "storageUtilization": 0.6
            }
        ]
    },
    "capacityPools": [
        {
            "id": "2176"
        }
    ]
}
 Click here to view/hide the sample request file for adding a Reservation with items...
{
    "name": "my_rsv",
    "startDate": "17/12/2014",
    "description": "Reserve resources for POC",
    "owner": "alan",
    "externalId": "co_user",
    "priority": "MEDIUM",
    "probability": 56,
    "realizationMode": "AUTOMATIC",
    "items": [
        {   "name": "DB_Server",
            "resourceSpec": {
                "enttypenm": "gm:vmw"
                "cpuCores": 8,
                "cpuTotalMHz": 20000,
                "memTotal": 10737418240,
                "storageTotal": 42949672960,
                "os": "UNIX",
                "cpuEntitledCapacity": 4,
                "cpuUtilization": 0.1,
                "memUtilization": 0.9,
                "storageUtilization": 0.6
            }
        }
    ],
    "capacityPools": [
        {
            "id": "2211"
        }
    ]
}
 Click here to view/hide the sample response file for adding a Reservation with resources...
{
"status": "OK",
"message": "The reservation has been successfully created",
"reservation": 
	{
	"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10163",
	"id": 10163,
	"name": "reservation_with_resource_spec",
	"startDate": "14/04/2015",
	"status": "PENDING",
	"priority": "MEDIUM",
	"probability": 100,
	"realizationMode": "MANUAL",
	"highAvailability": "NO",
	"resourceRequirementSummary": 
		{
		"numItems": 1,
		"cpuTotalMHz": 4000,
		"memTotal": 10737418240,
		"storageTotal": 42949672960,
		"cpuTotalMHzUsed": 2640,
		"memTotalUsed": 9771050598.4,
		"storageTotalUsed": 14173392076.800001
		},
	"resources": 
		{
		"resourceSpecs": [
			{
			"name": "VmwareVM.large.spec",
			"numItems": 1,
			"enttypenm": "gm:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 4000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuUtilization": 0.66,
			"memUtilization": 0.91,
			"storageUtilization": 0.33
			}
						]
		},
		"items": 		[
		{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10163/items/537",
		"id": 537,
		"name": "VmwareVM.large.spec",
		"resourceSpec": 
			{
			"enttypenm": "gm:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 4000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuUtilization": 0.66,
			"memUtilization": 0.91,
			"storageUtilization": 0.33
			}
		}
						],
		"capacityPools":	[
		{
		"capacityPool": 
			{
			"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
			"id": 2172,
			"name": "VMware Capacity Pool"
			}
		}
							]
		}
}
 Click here to view/hide the sample response file for adding a Reservation with items...
{
"status": "OK",
"message": "The reservation has been successfully created",
"reservation": 
	{
	"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10164",
	"id": 10164,
	"name": " reservation_with_item_resource_spec",
	"startDate": "14/04/2015",
	"status": "PENDING",
	"priority": "MEDIUM",
	"probability": 100,
	"realizationMode": "MANUAL",
	"highAvailability": "NO",
	"resourceRequirementSummary": 
		{
		"numItems": 2,
		"cpuTotalMHz": 8000,
		"memTotal": 21474836480,
		"storageTotal": 85899345920,
		"cpuTotalMHzUsed": 4640,
		"memTotalUsed": 15139759718.4,
		"storageTotalUsed": 35648228556.8
		},
	"resources": 
		{
		"resourceSpecs": [
			{
			"name": "my item-1",
			"numItems": 1,
			"enttypenm": "gm:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 4000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuUtilization": 0.66,
			"memUtilization": 0.91,
			"storageUtilization": 0.33
			},
			{
			"name": "my item-2",
			"numItems": 1,
			"enttypenm": "gm:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 4000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuUtilization": 0.5,
			"memUtilization": 0.5,
			"storageUtilization": 0.5
			}
						]
		},
		"items": [
		{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10164/items/538",
		"id": 538,
		"name": "my item-1",
		"resourceSpec": 
			{
			"enttypenm": "gm:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 4000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuUtilization": 0.66,
			"memUtilization": 0.91,
			"storageUtilization": 0.33
			}
		},
		{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10164/items/539",
		"id": 539,
		"name": "my item-2",
		"resourceSpec": 
			{
			"enttypenm": "gm:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 4000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuUtilization": 0.5,
			"memUtilization": 0.5,
			"storageUtilization": 0.5
			}
		}
		],
	"capacityPools": 
		[
		{
		"capacityPool": 
			{
			"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
			"id": 2172,
			"name": "VMware Capacity Pool"
			}
		}
		]
	}
}

Getting information for an existing Reservation

 Click here to view/hide the sample request file...
http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10028
 Click here to view/hide the sample response file...
{
    "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10155",
    "id": 10155,
    "name": "my_rsv",
    "startDate": "15/01/2015",
    "description": "Reserve resources for POC",
    "status": "PENDING",
    "owner": "alan",
    "priority": "HIGH",
    "probability": 45,
    "realizationMode": "AUTOMATIC",
    "resourceRequirementSummary": {
        "vcpuNum": 24,
        "cpuTotalMHz": 54.264,
        "memTotal": 51539607552,
        "storageTotal": 310696008228
    },
    "resources": {
        "resourceTemplates": [
            {
                "enttypenm": "svc",
                "numItems": 1,
                "serviceTemplate": {
                    "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/servicetemplates/2222",
                    "id": 2222,
                    "name": "CMDBService"
                }
            },
            {
                "enttypenm": "gm:vmw",
                "numItems": 1,
                "systemTemplate": {
                    "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/695",
                    "id": 695,
                    "name": "VMware.medium"
                }
            }
        ]
    },
    "items": [
        {
            "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10155/items/354",
            "id": 354,
            "name": "VMware.small-0",
            "systemTemplate": {
                "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/2213",
                "id": 2213,
                "name": "VMware.small"
            },
            "serviceTemplate": {
                "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/servicetemplates/2222",
                "id": 2222,
                "name": "CMDBService"
            }
        },
        {
            "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10155/items/355",
            "id": 355,
            "name": "VMware.small-1",
            "systemTemplate": {
                "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/2213",
                "id": 2213,
                "name": "VMware.small"
            },
            "serviceTemplate": {
                "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/servicetemplates/2222",
                "id": 2222,
                "name": "CMDBService"
            }
        },
        {
            "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10155/items/356",
            "id": 356,
            "name": "VMware.medium-0",
            "systemTemplate": {
                "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/695",
                "id": 695,
                "name": "VMware.medium"
            }
        }
    ],
    "capacityPools": [
        {
            "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2211",
            "id": 2211,
            "name": "NY capacity pool "
        }
    ]
}

Updating an existing Reservation

 Click here to view/hide the sample request file...
{
    "name": "my_rsv",
    "startDate": "17/12/2014",
    "description": "Reserve resources for POC",
    "owner": "alan",
    "externalId": "co_user",
    "priority": "MEDIUM",
    "probability": 56,
    "realizationMode": "AUTOMATIC",
    "highAvailability": "NO",
	"resources": {
"resourceSpecs": [
            {
                "numItems": 2,
                "name": "DB_Server",
                "enttypenm": "gm:vmw"
                "cpuCores": 8,
                "cpuTotalMHz": 20000,
                "memTotal": 10737418240,
                "storageTotal": 42949672960,
                "os": "UNIX",
                "cpuEntitledCapacity": 4,
                "cpuUtilization": 0.1,
                "memUtilization": 0.9,
                "storageUtilization": 0.6
            }
        ]
    },
    "capacityPools": [
        {
            "id": "2176"
        }
    ]
}
 Click here to view/hide the sample response file...
{
	"status": "OK",
	"message": "The reservation has been successfully updated",
	"reservation": 
	{
	"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10164",
	"id": 10164,
	"name": " reservation_with_item_resource_spec",
	"startDate": "14/04/2015",
	"status": "PENDING",
	"priority": "MEDIUM",
	"probability": 100,
	"realizationMode": "MANUAL",
	"highAvailability": "NO",
	"resourceRequirementSummary": 
		{
		"numItems": 1,
		"cpuTotalMHz": 4000,
		"memTotal": 10737418240,
		"storageTotal": 42949672960,
		"cpuTotalMHzUsed": 2640,
		"memTotalUsed": 9771050598.4,
		"storageTotalUsed": 14173392076.800001
		},
	"resources": 
		{
		"resourceSpecs": [
			{
			"name": "my item-1",
			"numItems": 1,
			"enttypenm": "gm:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 4000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuUtilization": 0.66,
			"memUtilization": 0.91,
			"storageUtilization": 0.33
			}
						]
		},
	"items": [
		{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10164/items/538",
		"id": 538,
		"name": "my item-1",
		"resourceSpec": 
			{
			"enttypenm": "gm:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 4000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuUtilization": 0.66,
			"memUtilization": 0.91,
			"storageUtilization": 0.33
			}
		}
			],
		"capacityPools": [
			{
			"capacityPool": 
				{
				"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
				"id": 2172,
				"name": "VMware Capacity Pool"
				}
			}
		]
	}
}

Reservation items

Getting information for a Reservation item

 Click here to view/hide the sample request file...
{
"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/312/items/213",
"id": 536,
"name": "VmwareVM.large.spec",
"resourceSpec": 
	{
	"enttypenm": "gm:vmw",
	"cpuCores": 4,
	"cpuTotalMHz": 4000,
	"memTotal": 10737418240,
	"storageTotal": 42949672960,
	"os": "LINUX",
	"cpuUtilization": 0.66,
	"memUtilization": 0.91,
	"storageUtilization": 0.33
	}
}
 Click here to view/hide the sample response file...
{
"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10164",
"id": 10164,
"name": " reservation_with_item_resource_spec",
"startDate": "14/04/2015",
"status": "PENDING",
"priority": "MEDIUM",
"probability": 100,
"realizationMode": "MANUAL",
"highAvailability": "NO",
"resourceRequirementSummary": 
	{
	"numItems": 1,
	"cpuTotalMHz": 4000,
	"memTotal": 10737418240,
	"storageTotal": 42949672960,
	"cpuTotalMHzUsed": 2640,
	"memTotalUsed": 9771050598.4,
	"storageTotalUsed": 14173392076.800001
	},
"resources": 
	{
	"resourceSpecs": [
		{
		"name": "my item-1",
		"numItems": 1,
		"enttypenm": "gm:vmw",
		"cpuCores": 4,
		"cpuTotalMHz": 4000,
		"memTotal": 10737418240,
		"storageTotal": 42949672960,
		"os": "LINUX",
		"cpuUtilization": 0.66,
		"memUtilization": 0.91,
		"storageUtilization": 0.33
		}
					]
	},
"items": [
	{
	"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10164/items/538",
	"id": 538,
	"name": "my item-1",
	"resourceSpec": 
		{
		"enttypenm": "gm:vmw",
		"cpuCores": 4,
		"cpuTotalMHz": 4000,
		"memTotal": 10737418240,
		"storageTotal": 42949672960,
		"os": "LINUX",
		"cpuUtilization": 0.66,
		"memUtilization": 0.91,
		"storageUtilization": 0.33
		}
	}
		],
"capacityPools": [
	{
	"capacityPool": 
		{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
		"id": 2172,
		"name": "VMware Capacity Pool"
		}
	}
				]
}

Updating a Reservation item

 Click here to view/hide the sample request file...
{
"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10162/items/536",
"id": 536,
"name": "VmwareVM.large.spec",
"resourceSpec": 
	{
	"enttypenm": "gm:vmw",
	"cpuCores": 8,
	"cpuTotalMHz": 8000,
	"memTotal": 5737418240,
	"storageTotal": 42949672960,
	"os": "UNIX",
	"cpuUtilization": 0.66,
	"memUtilization": 0.91,
	"storageUtilization": 0.33
	}
}
 Click here to view/hide the sample response file...
{
    "status": "OK",
    "message": "The reservation item has been successfully updated",
    "item": {
        "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservations/10001/items/2",
        "id": 2,
        "name": "VMware.medium-1-custom",
 		"resourceSpec": {
		"enttypenm": "gm:vmw",
		"cpuCores": 8,
		"cpuTotalMHz": 8000,
		"memTotal": 5737418240,
		"storageTotal": 42949672960,
		"os": "UNIX",
		"cpuUtilization": 0.66,
		"memUtilization": 0.91,
		"storageUtilization": 0.33
        }
    }
}

Onboardings

Creating a new Onboarding

 Click here to view/hide the sample request file to add an onboarding item on a capacity container...
 {
    "name": "test-mixed",
    "description": "",
    "onboardingDate": "12/05/2015",
    "realizationMode": "MANUAL",
    "resourceRequirementSummary": {
        "numSystems": 1,
        "cpuCores": 32,
        "cpuTotalMHz": 70368,
        "memTotal": 103031488512,
        "storageTotal": 2392833654784
    },
    "resources": {
        "resourceSpecs": [
            {
                "numItems": 2,
                "name": "DB_Server",
                "enttypenm": "gm:vmw",
                "cpuCores": 8,
                "cpuTotalMHz": 20000,
                "memTotal": 10737418240,
                "storageTotal": 42949672960,
                "os": "UNIX",
                "cpuEntitledCapacity": 4,
                "cpuUtilization": 0.1,
                "memUtilization": 0.9,
                "storageUtilization": 0.6
            }
        ],
        "resourceTemplates": [
            {
                "numItems": 1,
                "systemTemplate": {
                    "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/2184",
                    "id": 2184,
                    "name": "Dell PowerEdge M820"
                }
            }
        ]
    },
    "reservationTarget": {
        "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservationtargets/2417",
        "id": 2417,
        "name": "ReservationTarget"
    }
}
 Click here to view/hide the sample request file to add an onboarding item on a capacity pool...
 {
    "name": "test-server-template",
    "description": "",
    "onboardingDate": "30/04/2015",
    "resources": {
        "resourceSpecs": [
            {
                "name": "Test Server",
                "numItems": 3,
                "enttypenm": "vh:vmw",
                "cpuCores": 2,
                "cpuTotalMHz": 10000,
                "memTotal": 10737418240,
                "storageTotal": 42949672960,
                "os": "UNIX",
                "cpuEntitledCapacity": 4,
                "cpuUtilization": 0.1,
                "memUtilization": 0.9,
                "storageUtilization": 0.6
            }
        ]
    },
    "capacityPool": {
        "id": 2172
    }
}
 Click here to view/hide the sample response file to a request for adding an onboarding item on a capacity container...
{
	"status": "OK",
	"message": "The onboarding has been successfully created",
	"onboarding": 
	{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/onboardings/10046",
		"id": 10046,
		"name": "test-mixed",
		"description": "",
		"onboardingDate": "12/05/2015",
		"status": "EVALUATING_COMMIT",
		"realizationMode": "MANUAL",
		"resourceRequirementSummary": {"numSystems": 3,
		"cpuCores": 48,
		"cpuTotalMHz": 110368,
		"memTotal": 124506324992,
		"storageTotal": 2478733000704
	},
	"resources": 
	{
		"resourceTemplates": [
		{
		"numItems": 1,
		"systemTemplate": 
			{
			"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/2184",
			"id": 2184,
			"name": "Dell PowerEdge M820"
			}
		}
							],
		"resourceSpecs": [
		{
			"name": "DB_Server",
			"numItems": 2,
			"enttypenm": "gm:vmw",
			"cpuCores": 8,
			"cpuTotalMHz": 20000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "UNIX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"reservationTarget": 
		{
			"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservationtargets/2417",
			"id": 2417,
			"name": "ReservationTarget"
		}
	}
}
 Click here to view/hide the sample response file to a request for adding an onboarding item on a capacity pool...
{
	"status": "OK",
	"message": "The onboarding has been successfully created",
	"onboarding": {"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/onboardings/10045",
	"id": 10045,
	"name": "test-hypo-custom-template",
	"description": "",
	"onboardingDate": "30/04/2015",
	"status": "EVALUATING_COMMIT",
	"realizationMode": "MANUAL",
	"resourceRequirementSummary": 
	{
		"numSystems": 3,
		"cpuCores": 6,
		"cpuTotalMHz": 30000,
		"memTotal": 32212254720,
		"storageTotal": 128849018880
	},
	"resources": 
	{
		"resourceSpecs": [
		{
			"name": "Test server",
			"numItems": 3,
			"enttypenm": "vh:vmw",
			"cpuCores": 2,
			"cpuTotalMHz": 10000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "UNIX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"capacityPool": 
		{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
		"id": 2172,
		"name": "VMware Capacity Pool"
		}
	}
}

Getting information for an Onboarding

 Click here to view/hide the sample request file...
 http://capacity-optimization-datahub:8280/dh-services/rsv/onboardings/34
 Click here to view/hide the sample response file...
{
	"href": "capacity-optimization-datahub:8280/dh-services/rsv/onboardings/10046",
	"id": 10046,
	"name": "test-mixed",
	"description": "",
	"onboardingDate": "12/05/2015",
	"status": "COMMITTED",
	"realizationMode": "MANUAL",
	"resourceRequirementSummary":
	{
		"numSystems": 3,
		"cpuCores": 48,
		"cpuTotalMHz": 110368,
		"memTotal": 124506324992,
		"storageTotal": 2478733000704
	},
	"resources": 
	{
		"resourceTemplates": [
		{
			"numItems": 1,
			"systemTemplate": 
			{
				"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/2184",
				"id": 2184,
				"name": "Dell PowerEdge M820"
			}
		}
							],
		"resourceSpecs": [
		{
			"name": "DB_Server",
			"numItems": 2,
			"enttypenm": "gm:vmw",
			"cpuCores": 8,
			"cpuTotalMHz": 20000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "UNIX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"reservationTarget": 
	{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservationtargets/2417",
		"id": 2417,
		"name": "ReservationTarget"
	}
}

Updating an Onboarding

 Click here to view/hide the sample request file...
{
	"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/onboardings/10045",
	"id": 10045,
	"name": "test-hypo-custom-template",
	"description": "",
	"onboardingDate": "30/04/2015",
	"status": "COMMITTED",
	"realizationMode": "MANUAL",
	"resourceRequirementSummary": 
	{
		"numSystems": 3,
		"cpuCores": 6,
		"cpuTotalMHz": 30000,
		"memTotal": 32212254720,
		"storageTotal": 128849018880
	},
	"resources": 
	{
		"resourceSpecs": [
		{
			"name": "Templ-for-hypo",
			"numItems": 1,
			"enttypenm": "vh:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 50000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"capacityPool": 
	{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
		"id": 2172,
		"name": "CapacityPool"
	}
}
 Click here to view/hide the sample response file...
{
	"status": "OK",
	"message": "The onboarding has been successfully updated",
	"onboarding": 
	{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/onboardings/10045",
		"id": 10045,
		"name": "test-hypo-custom-template",
		"description": "",
		"onboardingDate": "30/04/2015",
		"status": "EVALUATING_COMMIT",
		"realizationMode": "MANUAL",
		"resourceRequirementSummary": {"numSystems": 1,
		"cpuCores": 4,
		"cpuTotalMHz": 50000,
		"memTotal": 10737418240,
		"storageTotal": 42949672960
	},
	"resources": 
	{
		"resourceSpecs": [
		{
			"name": "Templ-for-hypo",
			"numItems": 1,
			"enttypenm": "vh:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 50000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"capacityPool": 
		{
			"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
			"id": 2172,
			"name": "CapacityPool"
		}
	}
}

Offboardings

Creating a new Offboarding

 Click here to view/hide the sample request file...
 {
    "name": "test-mixed",
    "description": "",
    "offboardingDate": "12/05/2015",
    "realizationMode": "MANUAL",
    "resourceRequirementSummary": {
        "numSystems": 1,
        "cpuCores": 32,
        "cpuTotalMHz": 70368,
        "memTotal": 103031488512,
        "storageTotal": 2392833654784
    },
    "resources": {
        "resourceSpecs": [
            {
                "numItems": 2,
                "name": "DB_Server",
                "enttypenm": "gm:vmw",
                "cpuCores": 8,
                "cpuTotalMHz": 20000,
                "memTotal": 10737418240,
                "storageTotal": 42949672960,
                "os": "UNIX",
                "cpuEntitledCapacity": 4,
                "cpuUtilization": 0.1,
                "memUtilization": 0.9,
                "storageUtilization": 0.6
            }
        ],
        "resourceTemplates": [
            {
                "numItems": 1,
                "systemTemplate": {
                    "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/2184",
                    "id": 2184,
                    "name": "Dell PowerEdge M820"
                }
            }
        ]
    },
    "reservationTarget": {
        "href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservationtargets/2417",
        "id": 2417,
        "name": "ReservationTarget"
    }
}
 Click here to view/hide the sample response file...
{
	"status": "OK",
	"message": "The offboarding has been successfully created",
	"offboarding": 
	{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/offboardings/10046",
		"id": 10046,
		"name": "test-mixed",
		"description": "",
		"offboardingDate": "12/05/2015",
		"status": "EVALUATING_COMMIT",
		"realizationMode": "MANUAL",
		"resourceRequirementSummary": {"numSystems": 3,
		"cpuCores": 48,
		"cpuTotalMHz": 110368,
		"memTotal": 124506324992,
		"storageTotal": 2478733000704
	},
	"resources": 
	{
		"resourceTemplates": [
		{
		"numItems": 1,
		"systemTemplate": 
			{
			"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/2184",
			"id": 2184,
			"name": "Dell PowerEdge M820"
			}
		}
							],
		"resourceSpecs": [
		{
			"name": "DB_Server",
			"numItems": 2,
			"enttypenm": "gm:vmw",
			"cpuCores": 8,
			"cpuTotalMHz": 20000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "UNIX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"reservationTarget": 
		{
			"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservationtargets/2417",
			"id": 2417,
			"name": "ReservationTarget"
		}
	}
}

Getting information for an Offboarding

 Click here to view/hide the sample request file...
 http://capacity-optimization-datahub:8280/dh-services/rsv/offboardings/459
 Click here to view/hide the sample response file...
{
	"href": "capacity-optimization-datahub:8280/dh-services/rsv/offboardings/10046",
	"id": 10046,
	"name": "test-mixed",
	"description": "",
	"offboardingDate": "12/05/2015",
	"status": "COMMITTED",
	"realizationMode": "MANUAL",
	"resourceRequirementSummary":
	{
		"numSystems": 3,
		"cpuCores": 48,
		"cpuTotalMHz": 110368,
		"memTotal": 124506324992,
		"storageTotal": 2478733000704
	},
	"resources": 
	{
		"resourceTemplates": [
		{
			"numItems": 1,
			"systemTemplate": 
			{
				"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/systemtemplates/2184",
				"id": 2184,
				"name": "Dell PowerEdge M820"
			}
		}
							],
		"resourceSpecs": [
		{
			"name": "DB_Server",
			"numItems": 2,
			"enttypenm": "gm:vmw",
			"cpuCores": 8,
			"cpuTotalMHz": 20000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "UNIX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"reservationTarget": 
	{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/reservationtargets/2417",
		"id": 2417,
		"name": "ReservationTarget"
	}
}

Updating an Offboarding

 Click here to view/hide the sample request file...
{
	"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/offboardings/10045",
	"id": 10045,
	"name": "test-hypo-custom-template",
	"description": "",
	"offboardingDate": "30/04/2015",
	"status": "COMMITTED",
	"realizationMode": "MANUAL",
	"resourceRequirementSummary": 
	{
		"numSystems": 3,
		"cpuCores": 6,
		"cpuTotalMHz": 30000,
		"memTotal": 32212254720,
		"storageTotal": 128849018880
	},
	"resources": 
	{
		"resourceSpecs": [
		{
			"name": "Templ-for-hypo",
			"numItems": 1,
			"enttypenm": "vh:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 50000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"capacityPool": 
	{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
		"id": 2172,
		"name": "CapacityPool"
	}
}
 Click here to view/hide the sample response file...
{
	"status": "OK",
	"message": "The offboarding has been successfully updated",
	"offboarding": 
	{
		"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/offboardings/10045",
		"id": 10045,
		"name": "test-hypo-custom-template",
		"description": "",
		"offboardingDate": "30/04/2015",
		"status": "EVALUATING_COMMIT",
		"realizationMode": "MANUAL",
		"resourceRequirementSummary": {"numSystems": 1,
		"cpuCores": 4,
		"cpuTotalMHz": 50000,
		"memTotal": 10737418240,
		"storageTotal": 42949672960
	},
	"resources": 
	{
		"resourceSpecs": [
		{
			"name": "Templ-for-hypo",
			"numItems": 1,
			"enttypenm": "vh:vmw",
			"cpuCores": 4,
			"cpuTotalMHz": 50000,
			"memTotal": 10737418240,
			"storageTotal": 42949672960,
			"os": "LINUX",
			"cpuEntitledCapacity": 4,
			"cpuUtilization": 0.1,
			"memUtilization": 0.9,
			"storageUtilization": 0.6
		}
						]
	},
	"capacityPool": 
		{
			"href": "http://capacity-optimization-datahub:8280/dh-services/rsv/capacitypools/2172",
			"id": 2172,
			"name": "CapacityPool"
		}
	}
}
Was this page helpful? Yes No Submitting... Thank you
Last modified by Manisha Moon on Oct 08, 2018
onboarding reservations offboarding

Comments

Reservation API
License Utility API
© Copyright 2014-2019 BMC Software, Inc. © Copyright 2013-2019 BladeLogic, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2021 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.