Tanzu Ops Manager API Reference Operations Index

Provide A new list Of overrides for the BOSH Director

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 ```

Delete all runtime config overrides for the BOSH Director

This endpoint will delete all of the currently configured runtime config overrides for the BOSH Director.

View A list Of all 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.

Provide A new list Of runtime config overrides for the BOSH Director

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 ```

Delete all manifest overrides for the given Product

This endpoint will delete all of the currently configured overrides for the given Product.

View A list Of all manifest overrides for A 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.

Provide A new list Of overrides for the given Product

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 ```

Advanced Mode

Activate/Deactivate Advanced Mode

Are you In Advanced Mode?

Determines whether you are in Advanced Mode or not

Apply Changes

Commit A Staged Installation

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.

Streaming current Apply Change log

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.

Status Of An Apply Change

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 products - `updates`: settings were changed or the product was upgraded - `deletions`: the product was deleted - `unchanged`: none of the above, but the product was still redeployed

List Of Apply Changes

Triggering An Apply Change

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.

View A list Of pending changes

List of products and errands, and any pending changes that might be applied. Products will be listed in deployment order.

Authentication Settings

Getting the authentication settings

Update the authentication settings

Authentication Setup

Setting Up with An internal userstore, SAML, LDAP Or OIDC

Setting up with an internal userstore, SAML, LDAP or OIDC

Availability Zones

Delete A single availability zone

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.

Fetch A single availability zone

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 A single availability zone

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.

Fetching all availability zones

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.

Creating availability zones

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

Updating all availability zones

**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.

Base Release Url

Reset active base releases url

Resets to the default specified in the product template.

Get active base releases url

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).

Update active base releases url

When `base_releases_url` is set, the default pointers are ignored and BOSH attempts to download releases from the location specified.

Certificate Authorities

Activate A Root Certificate Authority

Activate specified root certificate authority and de-activate all others. This is used during Step 2 of the Certificate Authority rotation procedure. See [Rotating CAs and Leaf Certificates](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-rotate-cas-and-leaf-certs.html#activate-new-ca) for more details.

Listing the Root Certificate Authorities

Returns all of the root certificate authorities for OpsManager. The `active` certificate will be used for generating all certs which OpsManager generates.

Create Root Certificate Authorities

Creates a root certificate authority using the provided certificate pem and private key pem. It will be marked as inactive initially. This is used during Step 1 of the Certificate Authority rotation procedure. See [Rotating CAs and Leaf Certificates](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-rotate-cas-and-leaf-certs.html#add-new-ca) for more details.

Deleting A Root Certificate Authority

Delete a specific certificate authority OpsManager. Only "inactive" certificates can be deleted. This is used during Step 5 of the Certificate Authority rotation procedure. See [Rotating CAs and Leaf Certificates](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-rotate-cas-and-leaf-certs.html#delete) for more details.

Generate A Root Certificate Authority

Generates an additional root certificate authority. It will be marked as inactive initially. This is used during Step 1 of the Certificate Authority rotation procedure. See [Rotating CAs and Leaf Certificates](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-rotate-cas-and-leaf-certs.html#add-new-ca) for more details.

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](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-rotate-non-configurable-certs.html) for more details. * If you are doing a CA rotation, see Step 4 of [Rotating CAs and Leaf Certificates](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-rotate-cas-and-leaf-certs.html#regenerate-from-new-root) for more details.

Rotate Certificates

Certificates

Generating New Certificates

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.

Getting Information About Certificates from Products (v1)

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](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-certs-index.html) ### 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

Getting Information About Certificates from Products (v0)

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](https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-certs-index.html)

Cloud Config

Getting BOSH cloud configs from historical installations

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.

Deployed Director cloud config

The deployed BOSH director's cloud config

Staged Director cloud config

The staged BOSH director's cloud config

Core Consumption

View the core consumption data

Retrieve a core consumption data about your products deployed with Tanzu Ops Manager.

Cpi Config

Getting BOSH CPI Config from historical installations

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.

Fetching deployed CPI configs

Returns most recently deployed CPI configs.

Fetching staged CPI configs

Returns CPI configs generated based on your current settings. The generated CPI configs are used during Apply Changes.

Credentials

Single deployed director credential

All deployed director credentials

Single credential for A deployed product

Returns the credentials for a specified credential reference as a hash.

All credentials for A deployed product

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.

Credhub Credentials

Deleting Credentials Migrated To Credhub from Tanzu Ops Manager

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.

Getting Credentials To Migrate To CredHub

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.

Custom Banner Settings

Getting the Custom Banners

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.

Setting the Custom Banners

Set the values of custom banners.

Custom Manifest Operations

Remove A manifest operation

Delete an individual add_job_to_instance_group operation which was previously added to the BOSH Director tile

View A list Of all manifest operations

Get a list of all add_job_to_instance_group type operations which were previously added to the BOSH Director tile

Create A manifest operation

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.

Custom Ssl Certificate Settings

Deleting the SSL Certificate

Remove the custom SSL certificate for OpsManager and revert to the provided self-signed SSL certificate.

Getting the SSL Certificate

Get the current custom SSL certificate for OpsManager.

Updating the SSL Certificate

Set the values for the custom SSL certificate for OpsManager.

Custom Syslog Settings

Get the current Syslog configuration for OpsManager.

Getting the Syslog

Updating the Syslog configuration

Set the Syslog configuration for OpsManager.

Customer Support Portal

Checking for product updates

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

Check the status of a download for Customer Support Portal

Download A given product with version from 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.

Fetching EULA content for A given product

Retrieves the EULA for the version of the requested product

Accepting EULA for A given product

Deprecated: EULAs for a product can only be accepted on https://support.broadcom.com/group/ecx/downloads.

Removing the Tanzu API Token

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.

Adding Or updating the Tanzu API Token

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.`

Checking for stemcell updates

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.

Decrypt

Changing the Decryption Passphrase

Decrypt with the encryption passphrase

When the application reboots after initial setup, it requires an operator to enter the decryption passphrase once to decrypt its internal datastore.

Diagnostic Report

View the diagnostic report

Retrieve a diagnostic report with general information about the state of your Tanzu Ops Manager.

Diff

View A diff Of BOSH Director

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.

View A diff Of A deployed product

Returns the diff of the manifest and runtime configs between the staged state and last successful deployment of a product.

Disk Types

Deleting all custom disk types

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.

Returning all disk types

Overriding defaults with custom disk types

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

Viewing currently selected errands

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.

Configuring errands

Export

Exporting An Tanzu Ops Manager

Exporting an Tanzu Ops Manager

Importing An exported 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.

Resetting An Tanzu Ops Manager

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.

Iaas Configurations

Deleting IaaS Configuration

This feature is only enabled for the vSphere and Openstack IaaS. All other IaaSes will receive a 501.

Fetching single IaaS Configuration

Fetch single iaas configuration by guid

Updating Single IaaS Configuration

Update an iaas configuration

Create A new IaaS Configuration

Creates a new IaaS configuration. Only supported on vSphere and OpenStack.

Fetching IaaS Configurations

Fetch list of all iaas configurations

Icon

Returns base64-encoded icon of the product.

Icon Of A product

Info

View the version Of OpsManager

Returns information of the Tanzu Ops Manager itself. Currently only version is returned.

Install Time Verifiers

Deactivate / activate A verifier for the director

Deactivate / activate a verifier for the director during Apply Changes.

Retrieving A list Of install time verifiers for the director

Returns a list of install-time verifiers for the director and whether or not each is activated/deactivated.

Deactivate / activate A verifier for A product

Deactivate / activate a verifier for a particular product during Apply Changes.

Retrieving A list Of install time verifiers for A product

Returns a list of verifiers associated with the product and if those verifiers are activated or deactivated

Job Resource Configuration

Retrieving resources for A job

Returns the compute and disk configuration for a job.

Configuring resources for A job

Sets the compute and disk configuration for a job.

Resource configuration for A product's jobs

Returns a list of the compute and disk configuration for all jobs on the product.

Jobs

List jobs for A deployed product

Returns an array of the jobs on a staged product by name and guid.

List jobs for A deployed product

Returns an array of the jobs on a staged product by name and guid.

Status Of A deployed product's jobs

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

VM credentials for a deployed product's jobs

Login Session

Fetching the current session

The session information for the current API user can be retrieved from this endpoint. This information includes the current username and permissions.

Logging out all active users

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.

Logs

List downloadable director logs

ZIP files for tasks in the 'downloaded' stage are available at `/api/v0/deployed/director/logs/{task_guid}`

Enqueueing log downloads for the director

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.

Download director logs

List downloadable product job logs

ZIP files for tasks in the 'downloaded' stage are available at `/api/v0/deployed/products/{product_guid}/jobs/{job_guid}/logs/{task_guid}`

Enqueueing log downloads for A given job

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.

Apply Change log

Manifest

Manifest for A deployed director

To view the deployed product BOSH manifest

Retrieving manifest for A deployed product

To view the deployed product BOSH manifest

Getting BOSH manifests from A historical Apply Change

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.

Manifest for A staged director

To view the director BOSH manifest

Manifest for A staged product

To view the product BOSH manifest for a staged product

Max In Flight

Retrieving the max_in_flight settings for A product's jobs

Returns a list of the max_in_flight setting for all of the product's jobs.

Configuring the max_in_flight settings for A 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.

Metadata

Migrating metadata

Networks

Fetching networks for the staged director.

Fetches the collection of networks and subnets.

Updating networks for the staged director

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.

Networks And Azs Assignment

Configuring the director's networks and azs

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.

Listing currently assigned networks and azs

The current network and AZ assignment for a staged product.

Configuring A product's networks and azs

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.

Predeploy Check

Running A pre-deploy check for the staged BOSH Director

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

Running A pre-deploy check for A staged product

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

Products

Deleting A single unused product

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

Viewing A single deployed product

Viewing a single deployed product

All deployed products

Removing A staged product

Removing a staged product

Viewing A single staged product

Viewing a single staged product

Upgrading A staged product

Upgrading a staged product

Adding An available product

Adding an available product

All staged products

Properties

Getting A staged director's properties

Updating A staged director's properties

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.

Getting A staged product's properties

Returns a list of all of the product's properties, along with currently set values.

Updating A staged product's properties

Update a product's properties

Proxy Settings

Get the current proxy settings

Get the Proxy Settings

Update the Proxy Settings

Update the current proxy settings

Pruning Config Settings

Getting the Pruning Config

Get the current pruning settings

Setting the Pruning Config

Set the Pruning Config values

Rbac Settings

Enabling Role-Based Access Controls (RBAC)

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.

Setting the SAML, LDAP and OIDC RBAC Configuration

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.

Revert

Reverts all staged changes. There is no response body.

Revert staged changes

Root Ca Certificate

Returning the Root CA Certificate

This returns the public key of the Root CA Certificate

Runtime Configs

Deployed director runtime configs

Returns a list of the runtime configs included globally when deploying the director product.

Deployed product runtime configs

Returns a list of the runtime configs included globally when the specified product was last deployed.

Runtime configs from historical Apply Changes

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.

Staged director runtime configs

Returns a list of the runtime configs included globally when deploying the director product.

Fetching staged product runtime configs

This endpoint returns a list of the runtime configs included globally when deploying the specified product.

Serial Numbers

Remove all configured Serial Numbers

Removes all existing Serial Numbers

Getting the configured Serial Numbers

Get the current configured Serial Numbers

All existing Serial Numbers will be replaced with the newly provided Serial Numbers.

Configure Serial Numbers

Static Ips

Listing static IP assignments for A deployed product

Listing static IP assignments for a deployed product

Stemcell Associations For Products

Listing Product Stemcell Assignments

Returns information regarding which stemcells are staged, deployed, required, and available for assignment for each product.

PATCH

Associate one Or more stemcells with products

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.

Stemcells

Uploads the stemcell to OpsManager and ensures the stemcell is valid.

Uploading stemcells

Support Bundle

Downloading the support bundle

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 --ps` and `bosh vms --vitals` if BOSH has been deployed * The manifests and runtime configs for each deployed product

Syslog Configuration

Retrieving syslog configuration for A deployed product

Returns the syslog configuration for a deployed product.

Retrieving syslog configuration for A product

Returns the syslog configuration for a product.

Configuring product syslog

Updating a product's sylog configuration

Uaa Settings

Viewing UAA password policy

View the currently set password policy settings for UAA. These settings only apply when configured to use Internal authentication.

Update UAA password policy

Updates the password policy settings for UAA. These settings only apply when configured to use Internal authentication.

Setting precreated-client secret

Sets the secret for the precreated-client in OpsManager's UAA configuration

Viewing token expiration times

View the currently set expiration times for UAA access and refresh tokens.

Changing token expiration times

Changes the current access & refresh token expirations for Tanzu Ops Manager UAA and restarts the UAA

Variables

Variables for A deployed product

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.

Vm Extensions

Create A staged VM extension

"VM Extensions are used to specify cloud properties specific to your IaaS for selected instance groups. They are detailed in the BOSH documentation: https://bosh.io/docs/cloud-config.html#vm-extensions"

View A list Of staged VM extensions

VM Extensions are used to specify cloud properties specific to your IaaS for selected instance groups. They are detailed in the BOSH documentation: https://bosh.io/docs/cloud-config.html#vm-extensions

Remove A staged VM extension

VM Extensions are used to specify cloud properties specific to your IaaS for selected instance groups. They are detailed in the BOSH documentation: https://bosh.io/docs/cloud-config.html#vm-extensions

View A staged VM extension

VM Extensions are used to specify cloud properties specific to your IaaS for selected instance groups. They are detailed in the BOSH documentation: https://bosh.io/docs/cloud-config.html#vm-extensions

Update A staged VM extension

VM Extensions are used to specify cloud properties specific to your IaaS for selected instance groups. They are detailed in the BOSH documentation: https://bosh.io/docs/cloud-config.html#vm-extensions

View A list Of deployed VM extensions

VM Extensions are used to specify cloud properties specific to your IaaS for selected instance groups. They are detailed in the BOSH documentation: https://bosh.io/docs/cloud-config.html#vm-extensions

Vm Types

Deleting all custom VM types

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.

Returning all VM types