Aria Automation 8.12.2
Aria Automation 8.12.1
Aria Automation 8.12.0

curl -X PUT \
  https://consume_host:consumeport/catalog/v3/providers/vra \
  -H 'apikey: xxxxxxxxxxxxxxxxxxxxx' \
  -H 'content-type: application/json' \
  -H 'username: [email protected]' \
  -d '{ "adapter": "http://cb-catalog-int-api:3959/catalog/content/vra/v1", "provider": "VRA", "discoverContent": true }'

Navigate to
User Access
. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
Select the Team that you want to add the user to and click
Assign
.

Navigate to
User Access
. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
Click
Teams
if needed.
Click the
Actions
icon for the team that you want to add roles to and select
Edit
.
Click the
Roles
tab.
Click
Assign Roles
.
In the
Role Name
, select
Catalog Administrator
. You can enter search terms in the field to narrow down the options.
Select the entity type that you want to add the role to from the
Choose Entity
menu.
For each entity type that you select, select the proper group from the
Select Team or Organization
menu.
Repeat steps 6 and 7 for every entity that you want to add.
Click
Save
when you are finished.

Method name:
GET
URL:
https://consume_host:consumeport/cb-credential-service/api/v2.0/serviceProviders
Headers:
Accept:
application/json
Cache-Control:
no-cache
Content-Type:
application/json
apikey:
API key for the system
username:
Name of the user that you are logged in as

On your tenant, navigate to
Catalog Admin
. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
Click
Start Catalog Discovery
.

{
"customProperty" : {
      "configTemplate": [{
            "selector" : [ "templateList.param2"] -- selector must be applied to generate config as per the following template.  Selector must be applied to name of the custom Property and must support regular expression. More than one selector can be specified.
            "inputType": "freetext/selectOne/numberInput",
            "values" : [   -- this is required if inputType=selectOne
                  { "valueId": "", "value": ""}
             ],

             "range" : { . -- it is required only if inputType=number input
                    "min": 0,
                    "max": n,
                    "step": i
              }
            "configEditable": true,
            "configGroupCode": ""
      } ],
      "binding" : [{  
           "urn": "" , --could  be present if generateConfigForParams is set to false .  This will take the urn to refer to different contextual values during runtime
          "selector": [ "templateList.param1"]

      } ]
}
}

Import the catalog using the policy.
Get the config of the catalog by using the following API:
URL:
https://<host>/catalog/content/<providerCode>/<version>/services/<serviceId>/config
Method:
GET
Headers:
username, password (for Enterprise Marketplace)
Select the specific config that needs to be loaded dynamically at runtime and make a PUT request to update the config with the following values:
URL:
https://<host>/catalog/content/admin/<providerCode>/<version>/services/<serviceId>/config/<config Id of dynamic loaded config>
Method:
PUT
Headers:
username, password (for Enterprise Marketplace)
Body:
The config object that you retrieved along with the following parameters:
allowedValues:{
"type": "on-demand",
"params":< The query parameters that needs to be passed to the request>(Should be a JSON)
"resource-path": <resource-path of the URL to fetch data>,
    "baseurl": <base URL of the provider>,
    "method": <which type of api it is >(Supported methods: GET  & POST),
    "return": {
        "id": <Json path for provision Value>,
        "label": <Json path for label that is displayed to the user>
    },
    "body": <Only required when the method is post>,
"tokenURL": <If authentication required token for calling the api, Provide the token URL to fetch the token>,
    "authentication": {
        "module": <basic || vra>
    },
"handleByAdapter": <If specified true api call happens through adapter, If specified false the api call to fetch the data happens through adapter.
}

If config is not dependent on any other config, having allowed values with the previously specified format will be good enough to fetch values dynamically.
If config is dependent (in a parent-child relationship) on any other config, you must complete the following additional steps:
Pass an additional attribute called
derivedFrom
that consists of an array of all the parent configs that this child config is dependent on (this is at the
allowedValues
level).
Reference the parent config as
${parentConfigID}
in the allowed values body if the method is POST, or as
${parentConfigID}
in the allowed values params section if the method is GET.

{
      "id": "1",
      "name": "SELECT TEMPLATE",
      "description": "SELECT TEMPLATE",
      "default": "Centos6.6-7.3-5GB-WithAgent",
      "binding": "$.data.CentOS.data.cloneFrom",
      "required": true,
      "sequence": 2,
      "editable": true,
      "hidden": false,
      "inputType": "selectOne",
      "group": "Group1",
      "derivedFrom":["2"],
      "allowedValues": {
          "type": "on-demand",
          "resource-path": "/properties-service/api/propertydefinitions/cloneFrom/values",
          "baseurl": "https://10.154.23.177",
          "method": "POST",
          "return": {
              "id": "$.values..underlyingValue.value",
              "label": "$.values..underlyingValue.value"
          },
          "body": {
  "id": ${2},   // Here the keyname can be anything which the actual rest call expects and value should be ${ parentConfigId}
              "tenantId": "vsphere.local",
              "dependencyValues": {
                  "entries": []
              },
              "associateValue": null
          },
          "tokenURL": "https://10.154.23.177/identity/api/tokens",
          "authentication": {
              "module": "vra"
          },
          "handleByAdapter": true
      },
      "errorMessage": "string"
  }

VMware Aria Automation integration
VMware catalog creation

Navigate to the Catalog page at
https://consumehost:consumeport/catalogAdmin
.
Click
Start Catalog Discovery
.
Select the provider that you want to add, in this case
Private Cloud
.
The
Started Catalog Discovery Successfully
window is displayed. After the discovery is complete, the message
Last Discovered <timestamp>
is displayed in the
Catalog Admin
window.
Verify that the VMware blueprints defined on your Aria Automation instance appear on the page. The blueprints will be visible in Draft state.
There are three stages of an onboarded catalog’s lifecycle:
Draft:
The catalog was just discovered.
Work in Progress:
The catalog has been edited.
Published:
The catalog has been made available to users in Enterprise Marketplace.
Do not publish a catalog without uploading pricing for it first.
Edit an offering to publish it.
Confirm that all blueprint attributes are listed in the
Select Configurable Attributes
section.
The
Catalog Admin
edit page for the catalog displays the same attributes that are defined in the VMware blueprint.
Select the appropriate category from the drop-down menu.
Upload the pricing file.
Click
Enable support for multi-quantity
.
Select the maximum quantity that the user is allowed to select by moving the slider.
Select the attributes that will be displayed in the Enterprise Marketplace.
Attributes that are defined as mandatory on the VMware blueprint will be set to Display in Enterprise Marketplace automatically. You must add any other attributes manually.
Click
Save
to change the status of the catalog to Work in Progress.
Verify that the status of the catalog is Work in Progress and that the draft version is not listed in the table.
Complete further configuration and click
Publish
.
The
Publish Successful
window is displayed.
Verify that the new catalog appears as available to order from the
Catalog
page in Enterprise Marketplace.

Upload the config value domains used in the catalog configs. Config value domains are the values that appear in the drop-down menu of config where the corresponding ids are used.

POST https://<consumehost:consumeport>/catalog/content/admin/vra/v1/configvaluedomain

Use the POST command with the following JSON file:

[
 {
   "id": "CPU-1-CENTOS",
   "value": "1",
   "provisionValue": "1"
  },
 {
   "id": "CPU-2-CENTOS",
   "value": "2",
   "provisionValue": "2"
 },

 {
   "id":"MEM-512-CENTOS",
   "value": "512",
   "provisionValue": "512"
 },
 {
   "id":"MEM-1024-CENTOS",
   "value": "1024",
   "provisionValue": "1024"
 },
 {
   "id":"MEM-2048-CENTOS",
   "value": "2048",
   "provisionValue": "2048"
 },
 {
   "id":"MEM-3072-CENTOS",
   "value": "3072",
   "provisionValue": "3072"
 },
 {
   "id":"MEM-4096-CENTOS",
   "value": "4096",
   "provisionValue": "4096"
 },
 {
   "id": "HD-8-CENTOS",
   "value": "8",
   "provisionValue": "8"

}

]

The corresponding

curl

command is as follows:

curl -X POST \
 https://<consumehost:consumeport>/catalog/content/admin/vra/v1/configvaluedomain \
 -H 'apikey:xxxxxxxxxxxxxxxx' \
 -H 'content-type: application/json' \
 -H 'username: xxxxxxxxxxxxxxx' \
 -d '[
 {
   "id": "CPU-1-CENTOS",
   "value": "1",
   "provisionValue": "1"
  },
 {
   "id": "CPU-2-CENTOS",
   "value": "2",
   "provisionValue": "2"
 },

 {
   "id":"MEM-512-CENTOS",
   "value": "512",
   "provisionValue": "512"
 },
 {
   "id":"MEM-1024-CENTOS",
   "value": "1024",
   "provisionValue": "1024"
 },
 {
   "id":"MEM-2048-CENTOS",
   "value": "2048",
   "provisionValue": "2048"
 },
 {
   "id":"MEM-3072-CENTOS",
   "value": "3072",
   "provisionValue": "3072"
 },
 {
   "id":"MEM-4096-CENTOS",
   "value": "4096",
   "provisionValue": "4096"
 },
 {
   "id": "HD-8-CENTOS",
   "value": "8",
   "provisionValue": "8"

}

]
 

Execute the following REST API to onboard the service.

POST https://<consumehost:port>/catalog/content/admin/vra/v1/services

Use the following request body:

[
 {
   "id": "SingleVM-CentOS",
   "refid": "f98f1cf1-8633-4a59-9a38-4daadef9ae09",
   "name": "SingleVM-CentOS",
   "description": "SingleVM-CentOS",
   "descriptionHTML": "SingleVM-CentOS",
   "isEditable":true,
   "tenantId": "vsphere.local",
   "serviceType": "Composite Blueprint",
   "labels": [
   "vsphere.local",
   "Deployment"
   ],
   "version": 0,
   "status": "PUBLISHED",
   "updatedAt": "2017-09-14T07:24:53.639Z",
   "serviceCategory": [
     {
       "id": "compute",
       "name": "Compute",
       "description" : "Compute"

    }
   ],
   "provider": {"name":"vra","code":"vra"},
   "terms": "string"
 }

]

The corresponding

curl

command looks like the following:

curl -X POST \
 https://<consumehost:consumeport>/catalog/content/admin/vra/v1/services \
 -H 'apikey: xxxxxxxxxx' \
 -H 'content-type: application/json' \
 -H 'username: xxxxxxxxxxxxxxxxxxxx' \
 -d '
[
 {
   "id": "SingleVM-CentOS",
   "refid": "f98f1cf1-8633-4a59-9a38-4daadef9ae09",
   "name": "SingleVM-CentOS",
   "description": "SingleVM-CentOS",
   "descriptionHTML": "SingleVM-CentOS",
   "facets": [
     {
       "key": "location",
       "values": [
         "London"
       ]
     }
   ],
   "isEditable":true,
   "tenantId": "vsphere.local",
   "serviceType": "Composite Blueprint",
   "labels": [
   "vsphere.local",
   "Deployment"
   ],
   "version": 0,
   "status": "PUBLISHED",
   "updatedAt": "2017-09-14T07:24:53.639Z",
   "serviceCategory": [
     {
       "id": "compute",
       "name": "Compute",
       "description" : "Compute"

    }
   ],
   "provider": {"name":"vra","code":"vra"},
   "terms": "string"
 }

]
 

Upload the configs by using the static drop-down menu or the on-demand API:

To upload configs with the static drop-down menu, execute the following REST API. Configs are the corresponding attributes in VMware blueprints.

POST https://<consumehost:consumeport>/catalog/content/admin/vra/v1/services/<serviceid>/config

The service ID is the ID used in the body of upload service REST API. Execute the API with the following request body:

[
{
"id": "1",
"name": "CPU",
"description": "CPU",
"default": "1",
"binding": "$.data.CentOS70.data.cpu",
"required": true,
"editable": true,
"hidden": false,
"inputType": "selectOne",
"group": "string",
"domainValueIds": [
  "CPU-1-CENTOS",
  "CPU-2-CENTOS"
],

"errorMessage": "string"
},
{
"id": "2",
"name": "Memory (MB)",
"description": "Memory (MB)",
"default": "512",
"binding": "$.data.CentOS70.data.memory",
"required": true,
"editable": true,
"hidden": false,
"inputType": "selectOne",
"group": "string",
"domainValueIds": [
  "MEM-512-CENTOS",
  "MEM-1024-CENTOS",
  "MEM-2048-CENTOS",
  "MEM-3072-CENTOS",
  "MEM-4096-CENTOS"
],
"errorMessage": "string"
},
{
"id": "3",
"name": "Storage (GB)",
"description": "Storage (GB)",
"default": "8",
"binding": "$.data.CentOS70.data.storage",
"required": true,
"editable": true,
"hidden": false,
"inputType": "selectOne",
"group": "string",
"domainValueIds": [
  "HD-8-CENTOS"
],
"errorMessage": "string"
}
]

The corresponding

curl

command is the following:

curl -X POST \
https://<consumehost:consumeport>/catalog/content/admin/vra/v1/services/SingleVM-CentOS/config \
-H 'apikey: xxxxxxxxxxxxxxxxxxxxxx' \
-H 'content-type: application/json' \
-H 'username: xxxxxxxxxxxxxxx' \
-d '[
{
"id": "1",
"name": "CPU",
"description": "CPU",
"default": "1",
"binding": "$.data.CentOS70.data.cpu",
"required": true,
"editable": true,
"hidden": false,
"inputType": "selectOne",
"group": "string",
"domainValueIds": [
  "CPU-1-CENTOS",
  "CPU-2-CENTOS"
],

"errorMessage": "string"
},
{
"id": "2",
"name": "Memory (MB)",
"description": "Memory (MB)",
"default": "512",
"binding": "$.data.CentOS70.data.memory",
"required": true,
"editable": true,
"hidden": false,
"inputType": "selectOne",
"group": "string",
"domainValueIds": [
  "MEM-512-CENTOS",
  "MEM-1024-CENTOS",
  "MEM-2048-CENTOS",
  "MEM-3072-CENTOS",
  "MEM-4096-CENTOS"
],
"errorMessage": "string"
},
{
"id": "3",
"name": "Storage (GB)",
"description": "Storage (GB)",
"default": "8",
"binding": "$.data.CentOS70.data.storage",
"required": true,
"editable": true,
"hidden": false,
"inputType": "selectOne",
"group": "string",
"domainValueIds": [
  "HD-8-CENTOS"
],
"errorMessage": "string"
}
]
 

You can also upload config values by using the

on-demand-api

, which is an external API that you can call to fetch the possible value for the config. The following is an example dynamic pricing JSON.

{
"id":"data-inCatalogItemName",
"name":"Select Template",
"description":"Select Template",
"required":true,
"default":"",
"editable":true,
"group":"Dynamic",
"binding":"$.data.inCatalogItemName",
"pattern":" ",
"isSelected":true,
"hidden":false,
"inputType":"freetext",
"derives":[
],
"allowedValues":{
"type":"on-demand",
"resource-path":"/properties-service/api/propertydefinitions/cloneFrom/values",
"baseurl":"https://10.154.23.177",
"method":"POST",
"return":{
"id":"$.values..underlyingValue.value",
"label":"$.values..underlyingValue.value"
},
"body":{
"tenantId":"vsphere.local",
"dependencyValues":{
"entries":[
]
},
"associateValue":null
},
"tokenURL":"https://10.154.23.177/identity/api/tokens",
"authentication":{
"module":"vra"
},
"handleByAdapter":true
},
"errorMessage":"string"
}

The
"baseurl"
and
"resource-path"
together form the API to be called.
The
"method"
is generally GET/POST.
"return"
is the JSON path of the property from the response JSON.
The field
"type"
should be
"on-demand-api"
URL also supports query parameters with fields called
"params"
, which can be only key value pairs.
The field
"authentication"
contains
"module"
and
"providerAccountId"
for authentication purposes.
If the field
"handleByAdapter"
is set to true, then the external API call is handled by the adapter itself.

Price calculation based on configuration:
In this pricing model, the price is calculated based on a Base Price and chargeAdd prices based on the amount of CPU, memory, and storage that your customers use during a specific time period. For example, the chargeAdd prices could be calculated based on the following rates:
Compute Rate per vCPU Daily ($)
Compute Rate per GB RAM Daily ($)
Storage Rate per GB daily ($)
The Estimated Cost is calculated based on the customer’s user of CPU, Memory, and Storage as monthly Recurring charges (chargeAdd) plus any One-time charges (Base Price).
Service Offering based pricing:
In this pricing model, the blueprint price is a static charge, encoded as the Base Price, that is charged at a specific interval. The Estimated Cost is calculated using the Base Price plus any One-time charges.
RU based pricing:
In this pricing model, the cost of each blueprint is based on a Request Unit (RU), which is a standardized size of deployment. Each blueprint can have multiple RUs, such as S, M, L, and XL. The cost for each blueprint is calculated based on the amount of each resource as defined by the RU and the price for that resource. Because the RUs are standardized, this amount can be pre-calculated.
Leased based pricing for RUs:
In this pricing model, the pricing is based on standardized RUs that are charged at a set interval, such as per day, per month, or per year. There can be multiple levels of RUs for a blueprint. Compute the estimated cost based on the end date of the catalog configured with the leased price plus any One-Time charge. This is supported with Custom Pricing using an External Pricing API.
RU Based Pricing - Complex Yearly:
In this pricing model, each catalog is constructed using one or multiple RUs. For example, user can order Cloud Technology Stacks (CTS) on vRealize provider (CTS = VMware blueprint), or user can order multiple RUs on traditional IT provider like mainframe CPU, network device, middleware, and so on. All the RUs have prices defined for one year. For example, the price for a mainframe CPU is defined for 2017, 2018, 2019, and so on. These prices reduce every year for a component, taking inflation into account. There are two charges defined for every RU:
Additional Resource Charges (ARC):
For utilization of any Resource Type above the relevant Resource Baseline (Additional RU), an additional resource unit charge (ARC) is charged for each Additional RU.
Reducing Resource Charges (RRC):
For utilization of any Resource Type below the relevant Resource Baseline (Reduced RU), a reduced RRC is issued by the supplier for each Reduced RU.
This is supported with Custom Pricing using an External Pricing API.

[
{
"id": "CentOS65-00SSAS3",
"pricingPlan": "Monthly",
"serviceId": "SystemConfig_QA74",
"offer": {
"name": "CPU",
"description": "Pricing for CPU",
"fareStrategy": "RATE",
"configValues": [
{ "configId": "1", "uom":true, "value": "1" }

]
},
"price": {
"oneTimeCharge": 10,
"description": "CPU Price",

"usageCharge": {
"uom":
{ "value": 1, "code": "SIZE" }

,
"frequency":
{ "value": 1, "code": "MONTH" }

,
"value": 20
},
"currencyCode": "USD"
},
"basePrice": true
},
{
"id": "CentOS65-00SSMQ2",
"pricingPlan": "Monthly",
"serviceId": "SystemConfig_QA74",
"offer": {
"name": "MEMORY",
"description": "Pricing for Memory",
"fareStrategy": "RATE",
"configValues": [
{ "configId": "2", "uom":true, "value": "512" }

]
},
"price": {
"oneTimeCharge": 10,
"description": "RAM Price",

"usageCharge": {
"uom":
{ "value": 512, "code": "SIZE" }

,
"frequency":
{ "value": 512, "code": "MONTH" }

,
"value": 0.5
},
"currencyCode": "USD"
},
"basePrice": false
},

{
"id": "CentOS65-00SSMQ1",
"pricingPlan": "Monthly",
"serviceId": "SystemConfig_QA74",
"offer": {
"name": "Storage",
"description": "Pricing for Storage",
"fareStrategy": "RATE",
"configValues": [
{ "configId": "3", "uom":true, "value": "5" }

]
},
"price": {
"oneTimeCharge": 10,
"description": "Storage Price",

"usageCharge": {
"uom":
{ "value": 5, "code": "SIZE" }

,
"frequency":
{ "value": 5, "code": "MONTH" }

,
"value": 10
},
"currencyCode": "USD"
},
"basePrice": false
}
]

Upload the pricing JSON for your catalog using a
curl
command or Postman using the following parameters:
Method:
POST
API:
https://consumehost:consumeport/catalog/content/admin/vra/v1/services/<serviceId>/offeredservices
Headers:
Content-Type:
application/json
username:
[email protected]
apikey:
XXXXX-XXXX-XX-XXXXXX-XXXXXXXXXX
Accept:
application/json
The following example shows the sample
curl
command:
Curl -X POST \
https://myminikube.info:300913/catalog/content/admin/vra/v1/services/SystemConfig_QA74/offeredservices \
-H ‘accept: applications/json’ \
-H ‘apikey: XXXXX-XXXX-XX-XXXXXX-XXXXXXXXXX’ \
-H ‘username: [email protected]’ \
-d ‘<name of JSON file>’
If you are using Postman, click the
Body
tab. The pane should show the contents of your pricing JSON. Select
Raw
and click
Send
.
Refresh your Enterprise Marketplace window and make sure that the base price is visible.

Discover where the catalog is by invoking the following API and finding the ID of your catalog in the output:
Method:
GET
API:
https://consumehost:consumeport/catalog/content/vra/v1/services?status=draft
Headers:
'apikey: XXXXXXXXXXXXXXXXXXX'
'username: [email protected]'
The following is a sample of the
curl
command:
curl -X GET \ 'https://cb-customer1-api.gravitant.net/catalog/content/vra/v1/services?status=draft'
-H 'apikey: XXXXXXXXXXXXXXXXXX'
-H 'username: [email protected]'
Use the ID from the last step to call the following API to fetch the config for your service:
Method:
GET
API:
https://consumehost:consumeport/catalog/content/vra/v1/services/<id>/config
Headers:
apikey:
XXXXXXXXXXXXXXXXXXX
username:
[email protected]
The following example is a sample response from this API:
{ "configs":[ { "id":"data-CentOS65-data-memory", "name":"Memory (MB)", "description":"The amount of RAM allocated to the machine in megabytes.", "required":false, "default":1024, "editable":true, "group":"CentOS65", "binding":"$.data.CentOS65.data.memory", "pattern":null, "isSelected":false, "hidden":false, "inputType":"integer", "derives":[ ], "allowedValues":[ ] }, { "id":"data-CentOS65-data-description", "name":"Description", "description":"Description", "required":false, "default":"Testing vRealize 7.2 with vRA 1.1 build", "editable":true, "group":"CentOS65", "binding":"$.data.CentOS65.data.description", "pattern":null, "isSelected":false, "hidden":false, "inputType":"freetext", "derives":[ ], "allowedValues":[ ] }, { "id":"data-CentOS65-data-storage", "name":"Storage (GB)", "description":"Amount of total storage in gigabytes.", "required":false, "default":7, "editable":true, "group":"CentOS65", "binding":"$.data.CentOS65.data.storage", "pattern":null, "isSelected":false, "hidden":false, "inputType":"integer", "derives":[ ], "allowedValues":[ ] }, { "id":"data-CentOS65-data-_hasChildren", "name":"Has Children", "description":"Indicates if current component is serving as a container to other components in the blueprint.", "required":false, "default":false, "editable":true, "group":"CentOS65", "binding":"$.data.CentOS65.data._hasChildren", "pattern":null, "isSelected":false, "hidden":false, "inputType":"boolean", "derives":[ ], "allowedValues":[ ] }, { "id":"data-CentOS65-data-image", "name":"Image", "description":"Configure build information for vSphere machine components in the blueprint.", "required":true, "default":"ValueSet.CentOS66", "editable":true, "group":"CentOS65", "binding":"$.data.CentOS65.data.image", "pattern":null, "isSelected":true, "hidden":false, "inputType":"selectOne", "derives":[ ], "allowedValues":[ { "id":"ValueSet.CentOS66", "value":"CentOS65", "provisionValue":"ValueSet.CentOS66" } ] }, { "id":"data-CentOS65-data-cpu", "name":"CPUs", "description":"Number of virtual CPUs.", "required":false, "default":3, "editable":true, "group":"CentOS65", "binding":"$.data.CentOS65.data.cpu", "pattern":null, "isSelected":false, "hidden":false, "inputType":"integer", "derives":[ ], "allowedValues":[ ] }, { "id":"data-CentOS65-data-_cluster", "name":"_cluster", "description":null, "required":false, "default":1, "editable":true, "group":"CentOS65", "binding":"$.data.CentOS65.data._cluster", "pattern":null, "isSelected":false, "range":{ "min":1, "max":5 }, "hidden":false, "inputType":"numberinput", "derives":[ ], "allowedValues":[ ] }, { "id":"data-CentOS65-data-size", "name":"Size", "description":"Configure CPU, memory, and storage sizing for vSphere machine components in the blueprint.", "required":true, "default":"ValueSet.large", "editable":true, "group":"CentOS65", "binding":"$.data.CentOS65.data.size", "pattern":null, "isSelected":true, "hidden":false, "inputType":"selectOne", "derives":[ ], "allowedValues":[ { "id":"ValueSet.large", "value":"large", "provisionValue":"ValueSet.large" }, { "id":"ValueSet.medium", "value":"medium", "provisionValue":"ValueSet.medium" }, { "id":"ValueSet.small", "value":"small", "provisionValue":"ValueSet.small" } ] }, { "id":"data-_leaseDays", "name":"Lease days", "description":"Indicates for how many days the deployed blueprint will be leased.", "required":false, "default":1, "editable":true, "group":null, "binding":"$.data._leaseDays", "pattern":null, "isSelected":false, "range":{ "min":1, "max":1 }, "hidden":false, "inputType":"numberinput", "derives":[ ], "allowedValues":[ ] } ] }
In the pricing JSON file that you created, update the configId in each configuration with the ID value you discovered in the previous step. Keep serviceId as "" (empty string) and ensure that each ID inside your JSON is unique so you link the pricing to the correct config. Incorrect configId pricing will not be displayed in the Enterprise Marketplace Catalog.
The following example shows the updated sample pricing:
[{ "id": "CentOS65-00SSAS3", "pricingPlan": "Monthly", "serviceId": "", "offer": { "name": "CPU", "description": "Pricing for CPU", "fareStrategy": "RATE", "configValues": [ { "configId": "data-CentOS65-data-cpu", "uom":true, "value": "1" } ] }, "price": { "oneTimeCharge": 10, "description": "CPU Price", "usageCharge": { "uom": { "value": 1, "code": "SIZE" } , "frequency": { "value": 1, "code": "MONTH" } , "value": 20 }, "currencyCode": "USD" }, "basePrice": true }, { "id": "CentOS65-00SSMQ2", "pricingPlan": "Monthly", "serviceId": "", "offer": { "name": "MEMORY", "description": "Pricing for Memory", "fareStrategy": "RATE", "configValues": [ { "configId": "data-CentOS65-data-memory", "uom":true, "value": "512" } ] }, "price": { "oneTimeCharge": 10, "description": "RAM Price", "usageCharge": { "uom": { "value": 512, "code": "SIZE" } , "frequency": { "value": 512, "code": "MONTH" } , "value": 0.5 }, "currencyCode": "USD" }, "basePrice": false }, { "id": "CentOS65-00SSMQ1", "pricingPlan": "Monthly", "serviceId": "", "offer": { "name": "Storage", "description": "Pricing for Storage", "fareStrategy": "RATE", "configValues": [ { "configId": "data-CentOS65-data-storage", "uom":true, "value": "5" } ] }, "price": { "oneTimeCharge": 10, "description": "Storage Price", "usageCharge": { "uom": { "value": 5, "code": "SIZE" } , "frequency": { "value": 5, "code": "MONTH" } , "value": 10 }, "currencyCode": "USD" }, "basePrice": false } ]
Click the
Actions
icon for your catalog and select
Edit
.
Select the appropriate category for your catalog and click
Upload
.
Browse to the file you just saved and upload your pricing file, ensuring that the file is JSON and saved with a .json extension.
Click the
Actions
icon for each config for which you have uploaded the price and select
Display in Enterprise Marketplace
.
Click
Save
.
After you save the catalog, the status will change to Work in Progress.
Click the
Actions
icon and select
Publish
.

[
  {
  "id": "CentOS65-00SSAS3",
  "serviceId": "CentOS65-0a2",
  "offer": {
  "name": "CPU",
  },
  "pricingfn":{
      "resource-path": "/catalog/content/price",
      "method": "POST",
      "baseurl": "http://localhost:3005",
      "body": {
          "1": "${1}",
          "2": "${2}",
          "3": "${3}",
          "4": "${4}",
          "5": "${5}",
          "6": "${6}",
          "config_123457": "${systemConfigs::config_123457}"
      },
      "authentication": {
          "module": "basic",
          "providerAccountId": ""
      },
      "handleByAdapter": false
  }
]

Method:
POST
API:
https://consumehost:consumeport/catalog/content/admin/vra/v1/services/<serviceId>/offeredservices

curl -X POST \ https://consumehost:consumeport/catalog/content/admin/vra/v1/services/<svcid>/offeredservices \ -H 'apikey: consumeapikey' \ -H 'content-type: application/json' \ -H 'username: consumeusername' \ -d '[{ "id": "New External dynamic-pricing", "serviceId": "83bf8d70-cb5f-11e7-86ae-9d02361394c2", "offer": { "name": "Linux Virtual service4" }, "pricingfn": { "resource-path": "/catalog/content/price", "method": "POST", "baseurl": "EndpointofDynamicPriceFunction", "body": { "cpu": "${cpu}", "memory": "${memory}" }, "authentication": { "module": "basic", "providerAccountId": "" }, "handleByAdapter": false } }]'

Standard provider API (available out of the box)
Custom VMware APIs
External API (can invoke a new UI or custom API as needed)
ITSM or MSOP SR details such as ServiceNow SR details

Upload operation definition.
Upload operation template.
Upload operation config definition, if any.
Upload price of operation, if any.
Subscribe the operation endpoint, if fulfillment by any custom adapter or the default VMware adapter installation script is not used.

addDisk

var allVms = VcPlugin.getAllVirtualMachines();
var virtualMachine = "";
System.log("virtualMachineName:"+virtualMachineName);
// Check if the VM match the regexp
for (var i in allVms) {
if (allVms[i].name.equals(virtualMachineName)) {
virtualMachine = allVms[i];
System.log("virtualMachine for given name:"+virtualMachine);
break;
}
}
var vcacHost = Server.findAllForType("vCAC:VCACHost")[0];
System.log("vcacHost:"+vcacHost);
var vcacvm= Server.findAllForType("vCAC:VirtualMachine", "VirtualMachineName eq '"+virtualMachineName+"'")[0];
var vcacEntity = vcacvm.getEntity();
System.log("vcacvm:"+vcacvm);
var datastores = virtualMachine.getDatastore();
var fileName = "";
for each (var datastore in datastores) {
System.log("datastore:"+datastore);
System.log("datastore value:"+datastore.name);
fileName = "["+datastore.name+"]";
}
var devices = virtualMachine.config.hardware.device;
for each (controller in devices) {
var is_scsi = controller instanceof VcVirtualBusLogicController || controller instanceof VcVirtualLsiLogicController
|| controller instanceof VcParaVirtualSCSIController || controller instanceof VcVirtualLsiLogicSASController;
if (!is_scsi) {
continue;
}
var controller_label = controller.deviceInfo.label;
System.log("SCSI controller found: " + controller_label);
for each (device in devices) {
if (device.controllerKey == controller.key) {
var scsi_id = controller.busNumber + ":" + device.unitNumber;
System.log(" device found: '" + device.deviceInfo.label + "' 'SCSI (" + scsi_id + ")'");
System.log("device controllerkey:"+device.controllerKey);
}
}
}
System.log("diskUnitNumber:"+diskUnitNumber);
// Create Disk BackingInfo
var diskBackingInfo = new VcVirtualDiskFlatVer2BackingInfo();
diskBackingInfo.diskMode = "persistent";
System.log("fileName no disk backing:"+fileName);
diskBackingInfo.fileName = fileName;
diskBackingInfo.thinProvisioned = true;
var diskSize = 1048576 * sizeInGB;
// Create VirtualDisk
var disk = new VcVirtualDisk();
disk.backing = diskBackingInfo;
disk.controllerKey = 1000;
disk.unitNumber = diskUnitNumber;
disk.capacityInKB = diskSize;
// Create Disk ConfigSpec
var deviceConfigSpec = new VcVirtualDeviceConfigSpec();
deviceConfigSpec.device = disk;
deviceConfigSpec.fileOperation = VcVirtualDeviceConfigSpecFileOperation.create;
deviceConfigSpec.operation = VcVirtualDeviceConfigSpecOperation.add;
var deviceConfigSpecs = [];
deviceConfigSpecs.push(deviceConfigSpec);
// List of devices
var configSpec = new VcVirtualMachineConfigSpec();
configSpec.deviceChange = deviceConfigSpecs;
return virtualMachine.reconfigVM_Task(configSpec);

waitForTaskAndUpdate

var vcacvm= Server.findAllForType("vCAC:VirtualMachine", "VirtualMachineName eq '"+virtualMachineName+"'")[0];
var vcacEntity = vcacvm.getEntity();
System.log("vcacvm:"+vcacvm);
var hostid = vcacEntity.hostId;
System.log("vcacHost:"+hostid);
System.log("updating entities");
var modelName = 'ManagementModelEntities.svc';
var entitySetName = 'DataCollectionStatuses';
//Read a list of entities
var entities = vCACEntityManager.readModelEntitiesByCustomFilter(hostid, modelName, entitySetName, null, null);
for each (entity in entities) {
var entityKey = entity.keyString;
System.log("Updating entity with key: " + entityKey);
var links = null;
var headers = null;
var updateProperties = {
"LastCollectedTime":null
};
vCACEntityManager.updateModelEntityBySerializedKey(hostid, modelName, entitySetName, entityKey, updateProperties, links, headers);
}
System.sleep(10000);
System.log("Finished updating entities");

API:

https://<host>:<port>/catalog/content/admin/vra/v1/services

<host> here refers to the Consume env host.

Headers:

Content-Type:
application/json
Username:
'consume-username'
Apikey:
'consume-apikey'

Body:

[{
"id": "addingDisktoVMJun19",
"name": "Add Disk to VM",
"providerCode": "vra",
"apiDocVersion": "v3",
"provider":{
"name":"vra"
},
"version": "1.0.0",
"serviceType": "ServiceOperation",
"isPricingEnabled": true,
"isConfigurationEnabled": true,
"associatedTo": {
"type": "SOC",
"serviceOfferingRefs": [
{
"id": "CentOS65_CustomOp",
"providerSOCTypeId": "Virtual Machine"
}
]
},
"context": {
"organization": [ ],
"team": [ ],
"application": [ ],
"environment": [ ]
},
"status": "PUBLISHED",
"isCustom": true,
"operationCode": "addDisktoVM"
}]

In Enterprise Marketplace, click the
Catalog
tab.
In the
Search, Select and Configure
window, click the catalog that you want to link to.
Copy the last part of the URL for that catalog.
In the payload of the operation definition, set this on the “id” line.

virtualMachineName
: This parameter is automatically detected by the system and sent to the vRO.
sizeinGB
: This input is provided by the user.
diskUnitNumber
: This input is provided by the user.

API:

https://<host>:<port>/catalog/content/admin/vra/v1/services/<OPERATION_ID>/config

<host> here refers to the Consume env host.

In the previous URL operation, Id refers to the id ("id":"addingDisktoVMJun19") of the operation definition onboarded in the previous step.

Headers:

Content-Type:
application/json
Username:
'consume-username'
Apikey:
'consume-apikey'

Body:

[{
"id":"diskSize",
"name":"size of the disk",
"description":"Size of the Disk",
"default":"1",
"binding":"diskSize",
"required":true,
"sequence":1,
"configGroupCode":"main",
"configGroupName":"main",
"configGroupSequence":1,
"editable":true,
"hidden":false,
"inputType":"numberinput",
"group":"string",
"range":
{
"min":1,
"max":500
},
"errorMessage":"string"
},
{
"id":"numberOfUnits",
"name":"Number of Disk Units",
"description":"Number of Disk Units",
"default":"1",
"binding":"numberOfUnits",
"required":true,
"sequence":2,
"configGroupCode":"main",
"configGroupName":"main",
"configGroupSequence":1,
"editable":true,
"hidden":false,
"inputType":"numberinput",
"group":"string",
"range":
{
"min":0,
"max":15
},
"errorMessage":"string"
}]

Execution Template:
This template is used to execute the operation or to make a request to the provider for the operation. The basic assumption is that the operation to be executed should expose an API call with a callback ID to retrieve the status of the operation later. For execution templates, the following types of parameters can be passed:
System Parameters:
These system parameters are always available in the runtime context to be used during execution. To use them, explicitly declare them in the template with a fixed name.
_resourceInfo: Contains the identification data related to the resource (stack component) on which the operation is going to be executed.
_configInfo: Contains the configuration information of the operation.
_trackingInfo: Contains the trackingInfo present in the stack associated with the operation.
_additionalInfo: Contains the additionalInfo present in the stack associated with the operation.
User Defined Parameters:
These are the parameters that the user must provide as input during operation execution. These parameters are invariably mapped to configurations of the operation definition. The binding attribute value of the operation config must match with the name of the user defined parameters to use them in the template.
Status Template:
This template is used to retrieve the status of the operation that you executed. Keep in mind the following guidelines when preparing the status template:
The names of the parameters in the status template should be the same as the name of the output variables as declared in the execution template to use the correct values during status template execution. During runtime, the output of the execution template is passed to the status template as is.
The output of the status template must contain a variable called
status
that can have the following values:
Completed
Failed
InProgress
Failure Template:
This template is executed in failure scenarios, and it is optional. If the operation is a multi-step procedure and the operation fails during runtime, this template can be used to compensate the work already done. Keep in mind that the failure template should not contain any input parameters. All the parameters/internal variables of the execution template are passed to the Failure Template during execution. If the variables are not resolved when the failure occurs, then those variable values are passed as UNRESOLVED.

{
"executionTemplate": {
  "$schema": "http://github.kyndryl.net/cb-consume-schema/cs/op-template.json",
  "contentVersion": "1.0",
  "name": "sampletemplate",
  "parameters": {
    "_resourceInfo": {
      "type": "object"
    },
    "_configInfo": {
      "type": "object"
    },
    "_orderId":{
      "type":"string"
    },
    "_trackingInfo":{
      "type":"object"
    }
  },
  "resourceOperations": {
    "vragetXaasTemplate": {
      "catalogItemId": "${catalogItemId}"
    },
    "vrapostXaasTemplate": {
      "catalogItemId": "${catalogItemId}",
      "template": "${template}"
    }
  },
  "variables": {
    "resourceId": "${_resourceInfo}.name",
    "catalogItemId": "'6a20e304-f563-4977-9165-d632df0b2e57'",
    "diskSize": "(function(configInfo){var finalvalue=''; configlist = configInfo[0].config; for(var i in configlist){if(configlist[i].configId == 'diskSize'){if(configlist[i].values[0].value) {finalvalue = configlist[i].values[0].value;}else {finalvalue = configlist[i].values[0].valueId;}}}return finalvalue;})(${_configInfo})",
    "numberOfUnits": "(function(configInfo){var finalvalue=''; configlist = configInfo[0].config; for(var i in configlist){if(configlist[i].configId == 'numberOfUnits'){if(configlist[i].values[0].value) {finalvalue = configlist[i].values[0].value;}else {finalvalue = configlist[i].values[0].valueId;}}}return finalvalue;})(${_configInfo})",
    "template": "(function(template){ template.data.virtualMachineName=${resourceId}; template.data.diskUnitNumber= ${numberOfUnits}; template.data.sizeInGB = ${diskSize}; return template;})(${vragetXaasTemplate})"
  },
  "output": {
    "tracking": "${vrapostXaasTemplate}.id"
  }
},
"statusTemplate": {
  "$schema": "http://github.kyndryl.net/cb-consume-schema/cs/op-template.json",
  "contentVersion": "1.0",
  "name": "sampletemplate",
  "parameters": {
    "tracking": {
      "type": "string"
    }
  },
  "resourceOperations": {
    "vragetResources": {
      "requestId": "${tracking}"
    }
  },
  "output": {
  "status": "function(status){ if(status.phase === 'SUCCESSFUL') {return 'Completed'} else if(status.phase === 'FAILED'){return 'Failed'} else {return 'InProgress'}}(${vragetResources})",
  "comments": "function(status){if(status.phase === 'FAILED'){if(status.requestCompletion.completionDetails){return status.requestCompletion.completionDetails} else {return 'error on vRA side'}}}(${vragetResources})"
}
},
"failureTemplate": {}
}

API:

https://<host>:<port>/catalog/content/admin/vra/v1/services/<OPERATION_ID>/template

<host> here refers to the Consume env host.

In the previous URL "<OPERATION_ID>" refers to the ID ("id":"addingDisktoVMJun19") of the operation definition you onboarded . In addition, the following body contains the reference "<OPERATION_ID>", which means this needs to be replaced by the ID (“addingDisktoVMJun19").

Headers:

Content-Type:
application/json
Username:
'consume-username'
Apikey:
'consume-apikey'

Body:

{
"serviceId": "<OPERATION_ID>",
"refId":"<OPERATION_ID>",
"description": "<<base64 encoded format of the template json>>"
}

The following is the sample payload:

{
"serviceId": "addingDisktoVMJun19",
"refId":"addingDisktoVMJun19",
"description": "<<base64 encoded format of the template json>>"  // in the beginning of the 3rd point, we have the template in json format, we need to encode this to base64 format and put that encoded string in the description field.
}

API:
https://<host>:<port>/apiregistry/providers/vra/v1/apis
<host> here refers to the Enterprise Marketplace env host.
Headers:
Content-Type:
application/json
Username:
'consume-username'
Apikey:
'consume-apikey'
Body:
[
{
"contentVersion": "1.0",
"id": "vragetXaasTemplate",
"providerTypeId": "vra",
"params": {
  "catalogItemId": {
    "type": "string"
  }
},
"resourcepath": "/catalog-service/api/consumer/entitledCatalogItems/${catalogItemId}/requests/template",
"method": "GET"
},
{
"contentVersion": "1.0",
"id": "vrapostXaasTemplate",
"providerTypeId": "vra",
"body": "${template}",
"resourcepath": "/catalog-service/api/consumer/entitledCatalogItems/${catalogItemId}/requests",
"method": "POST"
}
]

API:
https://<host>:<port>/apiregistry/providers/vra/v1/apis

[{
"contentVersion": "1.0",
"id": "vragetResources",
"providerTypeId": "vra",
"resourcepath": "/catalog-service/api/consumer/requests/${requestId}",
"method": "GET"
}]

API:
https://<host>:<port>/catalog/content/admin/vra/v1/services/<OPERATION_ID>/offeredservices
In the previous URL, <OPERATION_ID> refers to the ID ("id":"addingDisktoVMJun19") of the operation definition.
Headers:
Content-Type:
application/json
Username:
'consume-username'
Apikey:
'consume-apikey'

[
{
  "id": "<<uniqueId>>",
  "pricingPlan": "Monthly",
  "serviceId": "addingDisktoVMJun19",
  "offer": {
    "name": "DiskSize",
    "description": "",
    "fareStrategy": "RATE",
    "configValues": [
      {
        "configId": "diskSize",
        "uom": true,
        "value": "1"
      }
    ]
  },
  "price": {
    "oneTimeCharge": 10,
    "description": "Size of the Disk",
    "usageCharge": {
      "uom": {
        "value": 1,
        "code": "GB"
      },
      "frequency": {
        "value": 1,
        "code": "MONTH"
      },
      "value": 50
    },
    "currencyCode": "USD"
  },
  "basePrice": true
}
]

API:
https://<host>:<port>/msgsubscription/v1/subscriber
Headers:
Content-Type:
application/json
Username:
'consume-username'
Apikey:
'consume-apikey'

API:
https://<host>:<port>/msgsubscription/v1/subscriber
Headers:
Content-Type:
application/json
Username:
'consume-username'
Apikey:
'consume-apikey'

{
"name": "operation_fulfillment_vra",
"topicName": "OperationFulfillment",
"queue_name": "operation_fulfillment_vra_queue",
"queue_ttl": 3600000,
"routing_key": [
  "vra"
],
"subscription_type": "Push",
"headers": {
  "adp-user": "{system_userid}",
  "adp-api-key": "{systemapikey}"
},
"callback": {
  "url": "{nginxhost}/vRA/v1/executeOperation",
  "certs": {
    "endpoint_ca_cer": "{certificate_name}",
    "endpoint_cer": "{endpoint_cer_name}",
    "endpoint_key": "{endpoint_key_name}"
  },
  "mutual_auth": "{mutual_auth_string}",
  "connection_protocol": "{connection_protocol}",
  "retry_count": 1,
  "requiredForwardProxy": true
}
}

curl -X POST \
https://dal09vra73.cloudmatrix.local/identity/api/tokens \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'postman-token: 6bd8f4e2-72fd-f7f1-257a-ccfa38a0f4a8' \
-d '{"username":"*********",
"password":"**********",
"tenant":"*****************"
}'

{
"expires": "",
"id": "******************", // id contains the token
"tenant": "vsphere.local"
}

{
          "businessfunction": "API",
          "level": "CRUD"
      }

API:
https://<<consumehost>>:<<consumeport>>/authorization/v2/roles/Service Integrator
Headers:
Username:
<<consume username>>
Apikey:
<<consume apikey>>

{
"role_validations": {
  "mandatoryContextsFieldExtensionAllowed": false,
  "optionalContextsFieldOverrideAllowed": false,
  "contextMetadata": {
    "optionalContexts": {
      "contexts": [

      ],
      "required": 0
    },
    "mandatoryContexts": [
      {
        "contextName": "org",
        "contextValue": [
          "ALL"
        ]
      }
    ]
  }
},
"icbapplication": "core",
"name": "Service Integrator",
"permissions": [
  {
    "businessfunction": "IBUS_MESSAGE",
    "level": "EDIT"
  },
  {
    "businessfunction": "IBUS_SUBSCRIBER",
    "level": "CRUD"
  },
  {
    "businessfunction": "SYSTEM_ACCOUNT_CREDENTIAL",
    "level": "VIEW"
  },
  {
    "businessfunction": "PROVIDER_ACCOUNT_CREDENTIAL",
    "level": "VIEW"
  },
  {
    "businessfunction": "AUDIT_LOG",
    "level": "CREATE"
  },
  {
    "businessfunction": "API",
    "level": "CRUD"
  }
]
}

{ "businessfunction": "API", "level": "CRUD" }

API:

https://<<consumehost>>:<<consumeport>>/authorization/v2/roles/Service Integrator

Headers:

Username:
<<consume username>>
Apikey:
<<consume apikey>>
Content-Type:
application/json

Body:

{
"role_validations": {
"mandatoryContextsFieldExtensionAllowed": false,
"optionalContextsFieldOverrideAllowed": false,
"contextMetadata": {
"optionalContexts": {
"contexts": [

],
"required": 0
},
"mandatoryContexts": [
{
"contextName": "org",
"contextValue": [
"ALL"
]
}
]
}
},
"icbapplication": "core",
"name": "Service Integrator",
"permissions": [
{
"businessfunction": "IBUS_MESSAGE",
"level": "EDIT"
},
{
"businessfunction": "IBUS_SUBSCRIBER",
"level": "CRUD"
},
{
"businessfunction": "SYSTEM_ACCOUNT_CREDENTIAL",
"level": "VIEW"
},
{
"businessfunction": "PROVIDER_ACCOUNT_CREDENTIAL",
"level": "VIEW"
},
{
"businessfunction": "AUDIT_LOG",
"level": "CREATE"
},
{
"businessfunction": "API",
"level": "CRUD"
}
]
}

_resourceInfo

{
"status": "On",
"name": "vm904",
"providerName": "",
"tags": "",
"resourceType": "Virtual Machine",
"parentId": "PYTVY4H94B",
"connectionInstructions": "",
"primaryInfo": [
  {
    "type": null,
    "name": "ip_address",
    "value": "10.155.251.132"
  },
  {
    "type": null,
    "name": "MachineName",
    "value": "vm904"
  }
],
"provider": "PrivateCloud",
"id": "3939ee68-ed01-48b0-acba-a55d69b03781",
"templateOutputProperties": [
  {
    "type": null,
    "name": "MachineDailyCost",
    "value": 0
  },
  {
    "type": null,
    "name": "MachineDestructionDate",
    "value": "2018-06-28T10:24:19.743Z"
  },
  {
    "type": null,
    "name": "NETWORK LIST",
    "value": [
      {
        "classId": "dynamicops.api.model.NetworkViewModel",
        "componentTypeId": "com.vmware.csp.component.iaas.proxy.provider",
        "typeFilter": null,
        "data": {
          "NETWORK_MAC_ADDRESS": "00:50:56:96:d6:13",
          "NETWORK_NAME": "mgmt2",
          "NETWORK_ADDRESS": "10.155.251.132"
        },
        "componentId": null
      }
    ]
  },
  {
    "type": null,
    "name": "MachineReservationName",
    "value": "BFAST"
  },
  {
    "type": null,
    "name": "PowerOff",
    "value": true
  },
  {
    "type": null,
    "name": "IS COMPONENT MACHINE",
    "value": false
  },
  {
    "type": null,
    "name": "Destroy",
    "value": true
  },
  {
    "type": null,
    "name": "MachineStorage",
    "value": 42
  },
  {
    "type": null,
    "name": "MachineType",
    "value": "Virtual"
  },
  {
    "type": null,
    "name": "Component",
    "value": "CentOS65"
  },
  {
    "type": null,
    "name": "ChangeOwner",
    "value": true
  },
  {
    "type": null,
    "name": "Reprovision",
    "value": true
  },
  {
    "type": null,
    "name": "Expire",
    "value": true
  },
  {
    "type": null,
    "name": "SNAPSHOT LIST",
    "value": []
  },
  {
    "type": null,
    "name": "Reconfigure",
    "value": true
  },
  {
    "type": null,
    "name": "ConnectViaVmrc",
    "value": true
  },
  {
    "type": null,
    "name": "MachineInterfaceType",
    "value": "vSphere"
  },
  {
    "type": null,
    "name": "Reset",
    "value": true
  },
  {
    "type": null,
    "name": "EXTERNAL REFERENCE ID",
    "value": "vm-7382"
  },
  {
    "type": null,
    "name": "MachineMemory",
    "value": 1024
  },
  {
    "type": null,
    "name": "MachineGroupName",
    "value": "Configuration Administrators"
  },
  {
    "type": null,
    "name": "Reboot",
    "value": true
  },
  {
    "type": null,
    "name": "InstallTools",
    "value": true
  },
  {
    "type": null,
    "name": "DISK VOLUMES",
    "value": [
      {
        "classId": "dynamicops.api.model.DiskInputModel",
        "componentTypeId": "com.vmware.csp.component.iaas.proxy.provider",
        "typeFilter": null,
        "data": {
          "DISK_CAPACITY": 5,
          "DISK_INPUT_ID": "DISK_INPUT_ID1"
        },
        "componentId": null
      },
      {
        "classId": "dynamicops.api.model.DiskInputModel",
        "componentTypeId": "com.vmware.csp.component.iaas.proxy.provider",
        "typeFilter": null,
        "data": {
          "DISK_CAPACITY": 5,
          "DISK_INPUT_ID": "DISK_INPUT_ID2"
        },
        "componentId": null
      },
      {
        "classId": "dynamicops.api.model.DiskInputModel",
        "componentTypeId": "com.vmware.csp.component.iaas.proxy.provider",
        "typeFilter": null,
        "data": {
          "DISK_CAPACITY": 32,
          "DISK_INPUT_ID": "DISK_INPUT_ID3"
        },
        "componentId": null
      }
    ]
  },
  {
    "type": null,
    "name": "MachineCPU",
    "value": 3
  },
  {
    "type": null,
    "name": "ConnectViaNativeVmrc",
    "value": true
  },
  {
    "type": null,
    "name": "Suspend",
    "value": true
  },
  {
    "type": null,
    "name": "MachineInterfaceDisplayName",
    "value": "vSphere (vCenter)"
  },
  {
    "type": null,
    "name": "MachineBlueprintName",
    "value": "CentOS65"
  },
  {
    "type": null,
    "name": "VirtualMachine Admin UUID",
    "value": "5016af6c-ef57-002e-b301-be85d56fdd5d"
  },
  {
    "type": null,
    "name": "MachineId",
    "value": "730b7215-ffd2-46d3-a7cc-33bfbdc3f892"
  },
  {
    "type": null,
    "name": "MachineGuestOperatingSystem",
    "value": "CentOS 4/5/6/7 (64-bit)"
  },
  {
    "type": null,
    "name": "MachineExpirationDate",
    "value": "2018-06-28T10:24:19.743Z"
  },
  {
    "type": null,
    "name": "Shutdown",
    "value": true
  },
  {
    "type": null,
    "name": "EndpointExternalReferenceId",
    "value": "90aacc2c-0315-4af4-aea2-251fbafa8e4f"
  },
  {
    "type": null,
    "name": "ChangeLease",
    "value": true
  },
  {
    "type": null,
    "name": "GetExpirationReminder",
    "value": true
  },
  {
    "type": null,
    "name": "CreateSnapshot",
    "value": true
  }
]
}

_configInfo

[
{
  "configGroup": "Configure Region",
  "sectionCode": "",
  "config": [
    {
      "description": "Size of the Disk",
      "isChange": "",
      "values": [
        {
          "valueId": "2",
          "binding": "diskSize",
          "value": ""
        }
      ],
      "configId": "diskSize",
      "type": "",
      "uom": "",
      "name": "Size of the disk"
    },
    {
      "description": "Number of Disk Units",
      "isChange": "",
      "values": [
        {
          "valueId": "2",
          "binding": "numberOfUnits",
          "value": ""
        }
      ],
      "configId": "numberOfUnits",
      "type": "",
      "uom": "",
      "name": "Number of Disk Units"
    }
  ],
  "sectionName": ""
}
]

{
"executionTemplate": {
  "$schema": "http:\/\/github.kyndryl.net\/cb-consume-schema\/cs\/op-template.json",
  "contentVersion": "1.0",
  "name": "sampletemplate",
  "parameters": {
    "_resourceInfo": {
      "type": "object"
    }
  },
  "resourceOperations": {
    "vragetActions": {
      "resourceId": "${resourceId}"
    },
    "vragetTemplate": {
      "actionId": "${actionId}",
      "resourceId": "${resourceId}"
    },
    "vrapostTemplate": {
      "actionId": "${actionId}",
      "resourceId": "${resourceId}",
      "vragetTemplate": "${vragetTemplate}"
    }
  },
  "variables": {
    "resourceId": "${_resourceInfo}.id",
    "actionName": "'Reboot'",
    "actionId": "(function(actionName,listOfActions){return listOfActions.actionId[0].filter(word => word.name==actionName)})(${actionName},${vragetActions})[0]['id']",
    "location": "(function(location){return location.location[0].substr(location.location[0].lastIndexOf('\/')+1,location.location[0].length)})(${vrapostTemplate})"
  },
  "output": {
    "tracking": "${location}"
  }
},
"statusTemplate": {
  "$schema": "http:\/\/github.kyndryl.net\/cb-consume-schema\/cs\/op-template.json",
  "contentVersion": "1.0",
  "name": "sampletemplate",
  "parameters": {
    "tracking": {
      "type": "string"
    }
  },
  "resourceOperations": {
    "vragetResources": {
      "requestId": "${tracking}"
    }
  },
  "output": {
    "status": "function(status){ if(status.phase === 'SUCCESSFUL') {return 'Completed'} else if(status.phase === 'FAILED'){return 'Failed'} else {return 'InProgress'}}(${vragetResources})",
    "comments": "function(status){if(status.phase === 'FAILED'){if(status.requestCompletion.completionDetails){return status.requestCompletion.completionDetails} else {return 'error on vRA side'}}}(${vragetResources})"
  }
},
"failureTemplate": {

}
}

[
{
  "contentVersion": "1.0",
  "id": "vragetActions",
  "providerTypeId": "icb",
  "resourcepath": "\/catalog-service\/api\/consumer\/resources\/${resourceId}\/actions",
  "method": "GET",
  "returnPath": {
    "actionId": "$.content"
  }
},
{
  "contentVersion": "1.0",
  "id": "vragetTemplate",
  "providerTypeId": "vra",
  "resourcepath": "\/catalog-service\/api\/consumer\/resources\/${resourceId}\/actions\/${actionId}\/requests\/template",
  "method": "GET"
},
{
  "contentVersion": "1.0",
  "id": "vrapostTemplate",
  "providerTypeId": "vra",
  "body": "${vragetTemplate}",
  "resourcepath": "\/catalog-service\/api\/consumer\/resources\/${resourceId}\/actions\/${actionId}\/requests",
  "method": "POST",
  "returnPath": {
    "location": "responseHeaders:$.location"
  }
},
{
  "schema": "http:\/\/github.kyndryl.net\/cb-consume-schema\/cs\/api.json",
  "contentVersion": "1.0",
  "id": "vragetResources",
  "providerTypeId": "icb",
  "resourcepath": "\/catalog-service\/api\/consumer\/requests\/${requestId}",
  "method": "GET"
}
]

Registering as a private cloud
Uploading the GPD file
Using the cost calculator
Importing data into Cost and Asset Management

Download the extractor from Cost & Asset Management.
Create a new cost plugin by implementing the custom cost calculation in Python and placing it in the rate card directory.
Configure the newly created cost plugin following the directions on the readme file present in the extract and then generate the GPD file.
Upload GPD file.
You can now analyze and view the cost in Cost & Asset Management.

vSphere Portal managing a vCenter Server v5.5 or above
vRealize Suite v7.2 or above
VMware tools are installed on all servers
Statistics Level 1 and Default Collection Intervals in the vCenter Server for performance monitoring
Python Scripts can be run against the vCenter Server
PowerCLI scripts can be run against the vCenter Server

Download the VMware community based API with python bindings called
pyvmomi
from
https://github.com/vmware/pyvmomi
.
Go through the documentation and look up
VirtualMachine.rst
and
PerformanceManager.rst
because those are some of the classes you will be dealing with when bringing back Asset and Utilization Data later.
Download a separate repository called
pyvmomi-community-samples
that contains many more examples of scripts from
https://github.com/vmware/pyvmomi-community-samples
.
Extract the repository and make sure that you can run some test scripts against the server. A typical call would look something like this: (-s for server , -u for username and –p for password).
Python getallvms.py -s 10.154.23.151 -u [email protected] -p Broker@345
Download the
gpd-format
repository and extract it to a folder. This is available at
https://github.kyndryl.net/cloudMatrix-CAM/gpd-format
.

Asset data
Utilization data

Run the
getallvms.py
file to get a list of VMs. After this Python file is edited, you can have it bring back all the resources and output that data to a csv file.
Edit the
getallvms.py
file as shown in the following segment. These changes will allow it to bring back all objects and not just VMs that are mentioned in the file name. You can then build multiple functions that can handle the properties of those objects and output that data. The following is the
getallvms.py
file that allows you to fetch multiple entities:
container = content.rootFolder # starting point to look into
viewType = [vim.ManagedEntity] # object types to look for
recursive = True # whether we should look into it recursively
containerView = content.viewManager.CreateContainerView(container, viewType, recursive)
children = containerView.view
for child in children:
# print_vm_to_csv(child)
item = str(child)
If “Datacenter” in item:
   print_datacenter_info(child)
   continue
elif “Folder” in item:
   print_folder_info(child)
   continue
elif “Cluster” in item:
   print_cluster_info(child)
   continue
elif “ResourcePool” in item:
   print_respool_info(child)
   continue
elif “VirtualMachine” in item:
   print_vm_info(child)
   continue
Make sure that you look at the GPD format for assets and check the GPD asset mapping for vSphere files located in the folder on the repository. Make sure you bring back the relevant details starting with the data that is mandatory. The following example shows sample data pulled through the API using an edited version of
getallvms.py
.
After you have successfully pulled this data and compiled it for a specific time, make sure it is in the sample asset csv format as prescribed in the gpd-format guidelines.

If the client’s private cloud instance has vRealize Business for Cloud as part of the vRealize Suite. There are multiple reports that can be run to bring back the cost data by VM or other managed object type for a certain time. This cost data then might need to be checked with the asset data to provide more information regarding some fields necessary for the data to be in the prescribed gpd-format.
Pull the bill from a managed service provider and then break down that data into the format necessary for GPD upload.
Create the costs file using a rate card approach based on the pricing policies that vRealize Business for Cloud uses. You could then calculate the costs using the asset and utilization data if necessary.

Zip file should contain one
provider_metadata.yml
in the root folder with one or multiple folders per period. The folder names should be in YYYYMM format.
Each "period" folder must have one or multiple folders per billing account.
Each "billing account" folder must have one CSV (cost file) and may have additional folders for asset accounts. Empty billing account folder generate an error.
If a “asset account” folder is present, it should contain an asset CSV, a Util CSV, or both. Empty asset folders generate an error.