Tanzu Ops Manager API Reference Operations Index
All available Tanzu Ops Manager API Reference Operations
This endpoint will delete all of the currently configured overrides for the BOSH Director.
This endpoint will list the currently configured overrides for the BOSH Director. Overrides will be applied in order, so the last override will be applied last.
This endpoint will replace the currently configured overrides for the BOSH Director. These overrides will be merged into the BOSH Director manifest. No validation is done on the data provided, other than checking that the data payload is a hash.
Only job properties of the bosh instance group and networks can be overridden.
Given the following overrides:
{
"overrides": [
{
"section": "instance_groups",
"data": {
"director": {
"remove_dev_tools": false
}
}
},
{
"section": "networks",
"data": {
"first-network": {
"type": "dynamic"
}
}
}
]
}
This will result in the following director manifest:
name: p-bosh
....
networks:
- name: first-network
type: dynamic # overridden value
.... # other values not affected
....
instance_groups:
0:
name: bosh
....
properties:
...
director:
.... # other values are not affected
remove_dev_tools: false # overridden value
This endpoint will delete all of the currently configured runtime config overrides for the BOSH Director.
This endpoint will list the currently configured runtime config overrides for the BOSH Director. Overrides will be applied in order, so the last override will be applied last.
This endpoint will replace the currently configured runtime config overrides for the BOSH Director. These overrides will be merged into the BOSH Director runtime configs. No validation is done on the value provided in the data key, other than checking that the data payload is a hash.
The following runtime configs can have overrides applied to their listed addons:
ops_manager_dns_runtime
bosh-dns: This deploys the bosh-dns job to all Linux VMs created by BOSH which provides DNS resolution to other BOSH deployed VMs.bosh-dns-windows: This deploys the bosh-dns-windows job to all Windows VMs created by BOSH which provides DNS resolution to other BOSH deployed VMs.
ops_manager_system_metrics_runtime
system_metrics_agent: This deploys the system_metrics_agent job to all Linux VMs created by BOSH which provides VM system metrics via a prometheus-scrapable endpoint.system_metrics_agent_windows: This deploys the system_metrics_agent_windows job to all Windows VMs created by BOSH which provides VM system metrics via a prometheus-scrapable endpoint.
Given the following overrides:
{
"overrides": [
{
"runtime_config_name": "ops_manager_dns_runtime",
"addon_name": "bosh-dns",
"data": {
"log_level": "ERROR"
}
}
]
}
This will result in the following runtime config:
name: ops_manager_dns_runtime
manifest:
addons:
- name: bosh-dns
jobs:
- release: bosh-dns
name: bosh-dns
properties:
log_level: ERROR
... # existing properties
This endpoint will delete all of the currently configured overrides for the given Product.
This endpoint will list the currently configured overrides for the given Product. Overrides will be applied in order, so the last override will be applied last.
This endpoint will replace the currently configured overrides for the given Product. These overrides will be merged into the Product's BOSH manifest. No validation is done on the data provided, other than checking that the data payload is a hash.
Only the features and update block of the manifest can be updated.
Given the following overrides:
{
"overrides": [
{
"section": "features",
"data": {
"use_dns_addresses": true
}
},
{
"section": "update",
"data": {
"canaries": 4
}
}
]
}
This will result in the following director manifest:
name: my-product
....
features:
use_dns_addresses: true
.... # other values not affected
....
update:
canaries: 4
.... # other values are not affected
Activate/Deactivate Advanced Mode
Determines whether you are in Advanced Mode or not
Saves installation state as though the deployment was triggered with the "Apply Changes" button, without actually deploying. This prepares the installation manifest, but does not invoke BOSH.
After commit, each product's manifest can fetched using the
/api/v0/deployed/product/{product_guid}/manifest endpoint.
If you see the commit endpoint return the following error:
This endpoint is currently deactivated because one or more of the products
you are trying to upgrade have credentials to migrate to credhub.
See the Migrating Credentials to Credhub section of the API docs to activate this endpoint again.
This endpoint can be activated again by following the steps described in the Migrating Credentials to Credhub section.
If there is no currently running Apply Changes then it returns 200 with
an exit event of type no install in progress.
This endpoint streams the logs of the currently running Apply Changes using the Server Sent Events format.
It starts by streaming an event named step_info which includes
an array of JSON data with the name and descriptions of each
ordered install step. Next, it will stream all of the log which has
already happened during this Apply Changes.
Then, it will stream realtime events and logs as they happen.
Mixed in with lines of logs, it will send events for steps called
step_started and step_finished, and an exit event at the end.
The step_started and step_finished events have JSON data,
that include an id key corresponding to the JSON sent in the step_info event.
The exit event has JSON data which includes the exit code of the last
command from the Apply Changes.
A exit code of 0 means success, and any other exit code indicates failure.
When the Apply Changes ends, the server closes the client's connection.
Note: The example response included in this documentation has been abbreviated for the sake of brevity.
Returns the status of an Apply Change
Returns a list of products deployed in each Apply Change All products which are deployed as part of an Apply Change will be listed in one of the following groups:
additions: newly installed productsupdates: settings were changed or the product was upgradeddeletions: the product was deletedunchanged: none of the above, but the product was still redeployed
Transmits pending changes to BOSH.
Submitting a POST request to this endpoint is equivalent to triggering the Apply Changes button in the GUI.
When deploy_products is an array of product guids ["my-guid", "another-guid"],
it will deploy the director tile and all passed-in products.
If there are any tiles being deployed,
which are dependent on tiles with staged changes not being deployed,
there will be validation errors and the deploy will not occur.
List of products and errands, and any pending changes that might be applied.
Products will be listed in deployment order.
Getting the authentication settings
Update the authentication settings
Setting up with an internal userstore, SAML, LDAP or OIDC
Deletes the availability zone. If the IaaS does not support availability zones an error will be returned.
Availability zones that are already on a deployed product cannot be deleted.
Fetches the availability zone.
iaas_configuration_guid is optional if you only have a single IaaS configuration. Multiple IaaS configurations are only supported on vSphere at this time.
If the IaaS does not support availability zones an error will be returned.
Update an availability zone.
There are different fields for availability zones per IaaS. Look at the examples to see the valid fields for each IaaS.
iaas_configuration_guid is optional if you only have a single IaaS configuration. Multiple IaaS configurations are only supported on vSphere at this time.
Availability zones cannot be updated on Azure.
Availability zones that are already on a deployed product cannot be updated.
Fetches the collection of availability zones.
iaas_configuration_guid is optional if you only have a single IaaS configuration. Multiple IaaS configurations are only supported on vSphere at this time.
If the IaaS does not support availability zones an error will be returned.
Creates an availability zone.
iaas_configuration_guid is optional if you only have a single IaaS configuration. Multiple IaaS configurations are only supported on vSphere at this time.
Modifying availability zones is not supported on Azure
Use of this endpoint is not recommended. Please use create, update, or delete.
If you are using the multi-datacenter feature on vSphere, this endpoint is not available. On all other IaaS, the iaas_configuration_guid property of availability zones will be ignored and automatically set to the default configuration.
This endpoint allows you to completely replace the collection of availability zones. OpsManager uses GUIDs to match existing objects in the collection. Unmatched availability zones will be added, matched availability zones will be updated, and omitted availability zones will be deleted.
There are different fields for availability zones per IaaS. Look at the examples to see the valid fields for each IaaS. Availability zones cannot be updated or replaced on Azure.
Availability zones that are already on a deployed product cannot be updated or deleted.
Resets to the default specified in the product template.
Light tiles contain pointers to installation binaries and these pointers can be changed in circumstances where the default location is inaccessible (e.g. in an airgapped or firewalled network).
When base_releases_url is set, the default pointers are ignored and
BOSH attempts to download releases from the location specified.
Returns all of the root certificate authorities for OpsManager.
The active certificate will be used for generating all certs which OpsManager generates.
Rotates all of the non-configurable leaf certificates.
The regenerated certificates will be signed by the current active CA. An Apply Changes is necessary to distribute the certificates to any deployed VMs.
This is used during both a non-configurable leaf certificate rotation and during a Certificate Authority rotation.
- If you are doing a non-configurable leaf certificate rotation, see Rotating Non-Configurable Leaf Certificates for more details.
- If you are doing a CA rotation, see Step 4 of Rotating CAs and Leaf Certificates for more details.
This returns a new RSA public/private certificate signed by Ops Manager's root CA certificate.
The returned certificate is not stored by Tanzu Ops Manager.
This endpoint returns information about all certificates for the deployed BOSH Director and the other deployed products.
Learn more about certificates managed by Ops Manager by visiting the documentation for Certificates and credentials in Tanzu Operations Manager
Improvements over the /api/v0/deployed/certificates endpoint:
- Lists the current rotation state for each certificate. This makes it easier to see what the next step to run during a certificate rotation procedure.
- Lists certificates associated with multiple deployments a single time with a deployments array, instead of listing the full certificate details multiple times
- Lists which deployments are "outdated" after generating new versions of a certificate. This makes it easy to determine which tiles, service instances, and non-tile deployments still need to be redeployed to consume the new certificate.
- Leaf certificates are nested under the CA certificate that signs them, if any. This makes it easier to determine which certificates are affected when the parent CA is rotated or expires
This returns information about all of the RSA and CA certificates for the deployed BOSH Director and the other deployed products.
This includes any product properties of type rsa_cert_credentials or ca_certificate as well as credhub-generated certificates for BOSH DNS.
The location will indicate where the certificate was generated (either ops_manager or credhub).
Certificate authorities tracked by Ops Manager are returned in the list and are marked as "is_ca": true.
Learn more about certificates managed by Ops Manager by visiting the documentation for Certificates and credentials in Tanzu Operations Manager
Returns a product's cloud configs for a given Apply Change
Use /api/v0/installations/{installation_id}/products/director/cloud_config to get the
director cloud config.
You can use GET /api/v0/installations to list the IDs and products guids of each historical Apply Change.
The deployed BOSH director's cloud config
The staged BOSH director's cloud config
Retrieve a core consumption data about your products deployed with Tanzu Ops Manager.
Returns the BOSH CPI configs for a given installation id.
You can use GET /api/v0/installations to list the IDs and products guids of each historical installation.
Returns most recently deployed CPI configs.
Returns CPI configs generated based on your current settings. The generated CPI configs are used during Apply Changes.
Single deployed director credential
All deployed director credentials
Returns the credentials for a specified credential reference as a hash.
Returns a list of references for credential properties for the given deployed product, except for VM credentials. These references can be used to get the credentials themselves using the credentials endpoint.
If you are using Tanzu Ops Manager solely as a manifest generator, after you download the list of credentials for all products using /api/v0/staged/products/credhub_credentials and load them into your CredHub yourself with the CredHub CLI.
You can use this endpoint to delete staged variable migrations when upgrading products that have credentials to migrate into Credhub before you can use the /api/v0/staged/installations/commit endpoint.
Tanzu Ops Manager will migrate credentials to CredHub for you.
However, if you are using Tanzu Ops Manager solely as a manifest generator, using /api/v0/staged/installations/commit, then you need to download the list of credentials for all products from this endpoint and load them into your CredHub yourself with the CredHub CLI, before you can use the /api/v0/staged/installations/commit endpoint.
Get the current value of the custom banner text.
The ui_banner_contents text will be shown in a banner in the Operations Manager web UI on every page.
By default this is null which means that no banner will be shown.
The ssh_banner_contents text will be shown as the SSH banner whenever a user connects to an OpsManager over SSH.
By default this is null which means that no banner will be shown.
Set the values of custom banners.
Delete an individual add_job_to_instance_group operation which was previously added to the BOSH Director tile
Get a list of all add_job_to_instance_group type operations which were previously added to the BOSH Director tile
Add an arbitrary job to the BOSH Director VM. For example, this could be used to run your favorite anti-virus software on the Director VM, assuming that the anti-virus software has already been packaged as a BOSH release.
Note that if you delete the BOSH Director tile, and then install the BOSH Director tile again, your manifest operations which were bound to the original BOSH Director tile will no longer apply. However, you can use this endpoint to add them again.
Remove the custom SSL certificate for OpsManager and revert to the provided self-signed SSL certificate.
Get the current custom SSL certificate for OpsManager.
Set the values for the custom SSL certificate for OpsManager.
Get the current Syslog configuration for OpsManager.
Set the Syslog configuration for OpsManager.
Will not have any valuable information unless you have configured a Tanzu API Token from the Customer Support Portal.
Check the status of a download for Customer Support Portal
You must have an Tanzu API Token set for this endpoint to work. You must also have accepted the EULA for the provided version of the product.
You can delete your Tanzu API Token to deactivate Tanzu Ops Manager's integration with Customer Support Portal.
This also removes the current list of product and stemcell upgrades from Customer Support Portal on the Tanzu Ops Manager dashboard.
You can add a Tanzu API Token from Customer Support Portal to use Ops Manager's Customer Support Portal integration. This features automatically finds updates to products and stemcells from Customer Support Portal which you can then stage and install.
You can find your Tanzu API Token under your profile settings in Customer Support Portal.
Note that currently there are two API tokens listed.
Ops Manager only works with one listed as legacy API token.
This endpoint will search a local cache of all stemcells versions available on Customer Support Portal (including ubuntu-trusty, ubuntu-xenial, windows2019, windows1803, windows2016, and windows2012R2).
If a product is already assigned the latest stemcell, this endpoint will not return anything for that product.
Changing the Decryption Passphrase
When the application reboots after initial setup, it requires an operator to enter the decryption passphrase once to decrypt its internal datastore.
This will show a list of all managed (tile/broker) and unmanaged (user) deployments present on the director.
Note: This value is extremely expensive to fetch and is hence cached (subject to change).
Retrieve a diagnostic report with general information about the state of your Tanzu Ops Manager.
Returns the diff of the manifest, cloud config, CPI configs, and runtime configs between the staged state and last successful deployment of the BOSH director.
Returns the diff of the manifest and runtime configs between the staged state and last successful deployment of a product.
Reverts available disk types to the default list
When overridden by custom types, this endpoint returns the custom types and the response will include the dates that the custom disk types were created and modified.
When overridden, the default types will be replaced by operator provided sizes.
Operators can repeatedly update the list of available sizes,
and any jobs using no-longer-available-sizes will be returned to the default of automatic.
Errands allowed to run as post_deploy or pre_delete are determined by the product template.
The presence of the 'post_deploy' or 'pre_delete' key in the response indicates the product author's intent.
The boolean value indicates whether the errand is enabled for that lifecycle event by the operator.
Set activated or deactivated list of errands to run.
Exporting a Tanzu Ops Manager
Tanzu Ops Manager is now protected by Cloud Foundry UAA for security and multi-user support.
When upgrading from a pre 1.7 version of Tanzu Ops Manager, a username is automatically created for you, and is set to “admin”. Your password is unchanged.
If you are importing a 1.7 or newer installation of Tanzu Ops Manager, both the username and the password are carried over to the new installation.
In addition to usernames and passwords, Tanzu Ops Manager will prompt users for a common decryption passphrase upon reboot. The decryption passphrase is currently the same as your password. Change the decryption passphrase before sharing it with other users.
Reset your Tanzu Ops Manager to its initial state. All products and BOSH configuration settings will be lost. Files uploaded or downloaded to the "Available Products" namespace will continue to be available. Hitting this endpoint does not reset your UAA login server and only affects Tanzu Ops Manager, BOSH, and products installed on them.
This feature is only enabled for the vSphere and Openstack IaaS. All other IaaSes will receive a 501.
Fetch single iaas configuration by guid
Update an iaas configuration
Creates a new IaaS configuration. Only supported on vSphere and OpenStack.
Fetch list of all iaas configurations
Returns base64-encoded icon of the product.
Returns information of the Tanzu Ops Manager itself.
Deactivate / activate a verifier for the director during Apply Changes.
Returns a list of install-time verifiers for the director and whether or not each is activated/deactivated.
Deactivate / activate a verifier for a particular product during Apply Changes.
Returns a list of verifiers associated with the product and if those verifiers are activated or deactivated
Returns the compute and disk configuration for a job.
Sets the compute and disk configuration for a job.
Returns a list of the compute and disk configuration for all jobs on the product.
Returns an array of the jobs on a staged product by name and guid.
The information returned is based on the output of the bosh vms command, with some additional data added.
VM credentials for a deployed product's jobs
Returns an array of the jobs on a staged product by name and guid.
The session information for the current API user can be retrieved from this endpoint.
This information includes the current username and permissions.
Only one user can be active in Tanzu Ops Manager at a time. For API users, we consider a user to be active during the period between their last request and when their token expires.
This endpoint will make inactive all API users and log out all UI users, including yourself, allowing a new user to log in or make API requests.
ZIP files for tasks in the 'downloaded' stage are available at /api/v0/deployed/director/logs/{task_guid}
This returns a task identifier for the async operation that performs log downloading from BOSH.
To track log download status, call GET /api/v0/deployed/director/logs
Downloads the corresponding logs for the given task_id.
ZIP files for tasks in the 'downloaded' stage are available at /api/v0/deployed/products/{product_guid}/jobs/{job_guid}/logs/{task_guid}
This returns a task identifier for the async operation that performs log downloading from BOSH.
To track log download status, call GET /api/v0/deployed/products/{product_guid}/jobs/{job_guid}/logs
Download deployed product job log
Returns BOSH logs for a given Apply Changes.
To view the deployed product BOSH manifest
To view the deployed product BOSH manifest
Returns the BOSH manifest that was used for deploying a given product for a given Apply Change.
Use /api/v0/installations/{installation_id}/products/director/manifest to get the
director manifest.
To view the director BOSH manifest
To view the product BOSH manifest for a staged product
Returns a list of the max_in_flight setting for all of the product's jobs.
Configures max_in_flight settings for jobs on a product. This overrides product defaults.
Values can be a either a percentage, or an absolute count of configured instances. Example: In order to set max_in_flight to 2, given a job with 10 instances, set max_in_flight as 2 or "20%".
To reset the max_in_flight value for a job to its default, use the string "default" as the value.
Migrating metadata
Fetches the collection of networks and subnets.
Replace the collection of networks and subnets.
OpsManager uses GUIDs to match existing objects in the collection. Unmatched networks will be added, matched networks will be updated, and omitted networks will be deleted.
Set the network and singleton availability zone for the bosh director. You cannot use this endpoint if the director is already deployed.
The parameters must match the names of an already created network and availability zone. The network must have at least one subnet on the singleton availability zone and cannot be a service network.
On Azure, when the Availability Mode is Sets, the singleton_availability_zone key is not required,
and will be ignored.
The current network and AZ assignment for a staged product.
Assigns AZs and networks for a staged product.
Subnets in the specified network must align with the specified availability zones.
On Azure, when the Availability Mode is Sets, the singleton_availability_zone and
other_availability_zones keys are not required, and will be ignored.
The network name must match the name of an already created network.
Returns granular information about whether the staged BOSH Director is ready to be deployed. It lists the following:
- network assignment
- availability zone assignment
- stemcell assignment
- properties that have errors
- invalid resource configuration for jobs (Note: this can only occur on non-BOSH products but is documented here for consistency)
- verifiers that failed
Returns granular information about whether the specified product is ready to be deployed. It lists the following:
- network assignment
- availability zone assignment
- stemcell assignment
- properties that have errors
- invalid resource configuration for jobs
- verifiers that failed
Deletes all unused products, and any stemcells and releases used only by it.
When product_name and version is specified, only that product version will be deleted.
Listing all available products
Uploading a product
Viewing a single deployed product
Returns the tile metadata associated with a deployed product. This metadata corresponds to the metadata YAML file inside the original tile, after tile migrations have been run.
Returns the UAA client name and secret generated for products that have requested UAA credentials
All deployed products
Removing a staged product
Viewing a single staged product
Upgrading a staged product
Returns the tile metadata associated with a staged product. This metadata corresponds to the metadata YAML file inside the original tile, after tile migrations have been run.
Adding an available product
All staged products
Fetch director, IaaS, and security properties.
Note: The property address field under syslog_configuration can be either a hostname or an IP address.
Note: The property opentsdb_ip field under director_configuration maps to the Bosh Health Monitor IP Address.
Note: If there are multiple Iaas Configurations, the iaas_configuration key is omitted from the response.
When redact is true the following properties are omitted from the response:
- director_configuration.s3_blobstore_options.access_key
- director_configuration.s3_blobstore_options.secret_key
- director_configuration.gcs_blobstore_options.service_account_key
- director_configuration.external_database_options.password
- director_configuration.hm_pager_duty_options.service_key
- director_configuration.hm_emailer_options.smtp_password
- director_configuration.providers[*].partition_password
- director_configuration.providers[*].client_key
Set director, IaaS, and security properties.
Note: Once a director is deployed, in the s3_blobstore_options section, only access_key and secret_key are
editable. If you do modify these, make sure to set bosh_recreate_on_next_deploy to true during the deploy of
the credentials change. You can unset this once the deploy is complete.
Returns a list of all of the product's properties, along with currently set values.
Update a product's properties
Get the current proxy settings
Update the current proxy settings
Get the current pruning settings
Set the Pruning Config values
Enable Role-Based Access Controls (RBAC) for Tanzu Ops Manager. Once Role Based Access Control has been enabled, the action cannot be undone. After enabling RBAC, only the Tanzu Ops Manager's Admin user will be able to log in. The admin user can then configure the access controls for other users.
This endpoint is only available when you are using SAML or LDAP authentication. You can use this API to configure these settings before enabling RBAC, and also to update these settings for an RBAC-enabled OpsManager.
Reverts all staged changes to the last deployed state.
This returns the public key of the Root CA Certificate
Returns a list of the runtime configs included globally when deploying the director product.
Returns a list of the runtime configs included globally when the specified product was last deployed.
Returns a product's runtime configs for a given installation id
Use /api/v0/installations/{installation_id}/products/director/runtime_config to get the
director runtime configs.
You can use GET /api/v0/installations to list the IDs and products guids of each historical installation.
The example OpsManager DNS runtime config returned has been intentionally truncated and is not valid.
Returns a list of the runtime configs included globally when deploying the director product.
This endpoint returns a list of the runtime configs included globally when deploying the specified product.
Deprecated: This exists for compatibility. Serial Numbers are no longer supported or configurable.
Deprecated: This exists for compatibility. Serial Numbers are no longer supported or configurable.
Deprecated: This exists for compatibility. Serial Numbers are no longer supported or configurable.
Listing static IP assignments for a deployed product
Returns information regarding which stemcells are staged, deployed, required, and available for assignment for each product.
Associating one or more stemcells with products. Note that this endpoint cannot be used to unassign stemcells. Stemcell assignments can only be replaced or added.
Uploads the stemcell to OpsManager and ensures the stemcell is valid.
Downloads the generated support bundle. When the check_only parameter is set to true, then status of the generation process is returned without downloading the file.
Downloads a ZIP file containing various diagnostic files including:
- A diagnostic report of Tanzu Ops Manager's current state
- The contents of the Tanzu Ops Manager log directory
- The BOSH logs and install metadata for the last five Apply Changes
- The output of
bosh instances --psandbosh vms --vitalsif BOSH has been deployed - The manifests and runtime configs for each deployed product
Generates a ZIP file containing various diagnostic files including:
- A diagnostic report of Tanzu Ops Manager's current state
- The contents of the Tanzu Ops Manager log directory
- The BOSH logs and install metadata for the last five Apply Changes
- The output of
bosh instances --psandbosh vms --vitalsif BOSH has been deployed - The manifests and runtime configs for each deployed product
Returns the syslog configuration for a deployed product.
Returns the syslog configuration for a product.
Updating a product's sylog configuration
View the currently set password policy settings for UAA. These settings only apply when configured to use Internal authentication.
Updates the password policy settings for UAA. These settings only apply when configured to use Internal authentication.
Sets the secret for the precreated-client in OpsManager's UAA configuration
View the currently set expiration times for UAA access and refresh tokens.
Changes the current access & refresh token expirations for Tanzu Ops Manager UAA and restarts the UAA
Get the current value of UI Feature settings.
The enable_foundation_core_ops_manager_ui boolean controls whether or not the Foundation Core UI will be enabled.
By default this is true which means that the Foundation Core UI will be enabled.
Set the values of UI features.
Returns the list of variables that BOSH director knows about for a product.
When name query parameter is present, this returns the current value for a specified variable stored in credhub instead.
Note that some variables may not be stored in credhub.
Removes all custom vm_types that have been created as long as none are in use by a deployed VM.
When not overridden by custom types, this endpoint returns all the default VM types for your IaaS
If you are on AWS, you will see an additional boolean field raw_instance_storage per vm_type.
If you are on GCP, you will see an additional string field machine_type if it has been specified for the vm_type.
When overridden, the default types will be replaced by operator provided sizes.
Operators can repeatedly update the list of available sizes,
and any jobs using no-longer-available-sizes will be returned to the default of automatic.
AWS vm_types also have a raw_instance_storage boolean field.
If you are on AWS, you can optionally provide one under each vm_type in your request body.
If you do not supply it, it defaults to false.
GCP vm_types also have a machine_type string field.
This allows you to use a predefined GCP machine type for a given VM type, instead of using a "custom" GCP machine type.