bds
=======

Description
-----------
REST CLI for Oracle Big Data Service. Use this CLI to build, deploy, and manage fully elastic Big Data Service clusters. Build on Hadoop, Spark and Data Science distributions, which can be fully integrated with existing enterprise data in Oracle Database and Oracle applications.

Available Commands
------------------
* :doc:`auto-scale-config </cmdref/bds/auto-scale-config>`

  * :doc:`create </cmdref/bds/auto-scale-config/create>`
  * :doc:`delete </cmdref/bds/auto-scale-config/delete>`
  * :doc:`edit </cmdref/bds/auto-scale-config/edit>`
  * :doc:`get </cmdref/bds/auto-scale-config/get>`
  * :doc:`list </cmdref/bds/auto-scale-config/list>`

* :doc:`bds-api-key </cmdref/bds/bds-api-key>`

  * :doc:`create </cmdref/bds/bds-api-key/create>`
  * :doc:`delete </cmdref/bds/bds-api-key/delete>`
  * :doc:`get </cmdref/bds/bds-api-key/get>`
  * :doc:`list </cmdref/bds/bds-api-key/list>`
  * :doc:`test-bds-object-storage-connection </cmdref/bds/bds-api-key/test-bds-object-storage-connection>`

* :doc:`bds-cluster-version </cmdref/bds/bds-cluster-version>`

  * :doc:`list </cmdref/bds/bds-cluster-version/list>`

* :doc:`bds-metastore-configuration </cmdref/bds/bds-metastore-configuration>`

  * :doc:`activate </cmdref/bds/bds-metastore-configuration/activate>`
  * :doc:`create </cmdref/bds/bds-metastore-configuration/create>`
  * :doc:`delete </cmdref/bds/bds-metastore-configuration/delete>`
  * :doc:`get </cmdref/bds/bds-metastore-configuration/get>`
  * :doc:`list </cmdref/bds/bds-metastore-configuration/list>`
  * :doc:`test </cmdref/bds/bds-metastore-configuration/test>`
  * :doc:`update </cmdref/bds/bds-metastore-configuration/update>`

* :doc:`block-storage </cmdref/bds/block-storage>`

  * :doc:`add </cmdref/bds/block-storage/add>`

* :doc:`cloudsql </cmdref/bds/cloudsql>`

  * :doc:`add </cmdref/bds/cloudsql/add>`
  * :doc:`remove </cmdref/bds/cloudsql/remove>`

* :doc:`identity-configuration </cmdref/bds/identity-configuration>`

  * :doc:`activate-iam-user-sync-configuration </cmdref/bds/identity-configuration/activate-iam-user-sync-configuration>`
  * :doc:`activate-upst-configuration </cmdref/bds/identity-configuration/activate-upst-configuration>`
  * :doc:`create </cmdref/bds/identity-configuration/create>`
  * :doc:`deactivate-iam-user-sync-configuration </cmdref/bds/identity-configuration/deactivate-iam-user-sync-configuration>`
  * :doc:`deactivate-upst-configuration </cmdref/bds/identity-configuration/deactivate-upst-configuration>`
  * :doc:`delete </cmdref/bds/identity-configuration/delete>`
  * :doc:`get </cmdref/bds/identity-configuration/get>`
  * :doc:`list </cmdref/bds/identity-configuration/list>`
  * :doc:`refresh-confidential-application </cmdref/bds/identity-configuration/refresh-confidential-application>`
  * :doc:`refresh-upst-token-exchange-keytab </cmdref/bds/identity-configuration/refresh-upst-token-exchange-keytab>`
  * :doc:`update </cmdref/bds/identity-configuration/update>`

* :doc:`instance </cmdref/bds/instance>`

  * :doc:`backup-node </cmdref/bds/instance/backup-node>`
  * :doc:`backup-node-node-level-details </cmdref/bds/instance/backup-node-node-level-details>`
  * :doc:`backup-node-node-type-level-details </cmdref/bds/instance/backup-node-node-type-level-details>`
  * :doc:`certificate-service-info </cmdref/bds/instance/certificate-service-info>`
  * :doc:`change-compartment </cmdref/bds/instance/change-compartment>`
  * :doc:`change-shape </cmdref/bds/instance/change-shape>`
  * :doc:`create </cmdref/bds/instance/create>`
  * :doc:`create-node-backup-configuration </cmdref/bds/instance/create-node-backup-configuration>`
  * :doc:`create-node-backup-configuration-node-level-details </cmdref/bds/instance/create-node-backup-configuration-node-level-details>`
  * :doc:`create-node-backup-configuration-node-type-level-details </cmdref/bds/instance/create-node-backup-configuration-node-type-level-details>`
  * :doc:`create-node-replace-configuration </cmdref/bds/instance/create-node-replace-configuration>`
  * :doc:`create-node-replace-configuration-node-level-details </cmdref/bds/instance/create-node-replace-configuration-node-level-details>`
  * :doc:`create-node-replace-configuration-node-type-level-details </cmdref/bds/instance/create-node-replace-configuration-node-type-level-details>`
  * :doc:`create-resource-principal-configuration </cmdref/bds/instance/create-resource-principal-configuration>`
  * :doc:`delete </cmdref/bds/instance/delete>`
  * :doc:`disable-certificate </cmdref/bds/instance/disable-certificate>`
  * :doc:`enable-certificate </cmdref/bds/instance/enable-certificate>`
  * :doc:`execute-bootstrap-script </cmdref/bds/instance/execute-bootstrap-script>`
  * :doc:`force-refresh-resource-principal </cmdref/bds/instance/force-refresh-resource-principal>`
  * :doc:`get </cmdref/bds/instance/get>`
  * :doc:`get-node-backup </cmdref/bds/instance/get-node-backup>`
  * :doc:`get-node-backup-configuration </cmdref/bds/instance/get-node-backup-configuration>`
  * :doc:`get-node-replace-configuration </cmdref/bds/instance/get-node-replace-configuration>`
  * :doc:`get-os-patch-details </cmdref/bds/instance/get-os-patch-details>`
  * :doc:`get-resource-principal-configuration </cmdref/bds/instance/get-resource-principal-configuration>`
  * :doc:`install-os-patch </cmdref/bds/instance/install-os-patch>`
  * :doc:`install-os-patch-batching-based-patching-configs </cmdref/bds/instance/install-os-patch-batching-based-patching-configs>`
  * :doc:`install-os-patch-domain-based-patching-configs </cmdref/bds/instance/install-os-patch-domain-based-patching-configs>`
  * :doc:`install-os-patch-downtime-based-patching-configs </cmdref/bds/instance/install-os-patch-downtime-based-patching-configs>`
  * :doc:`install-patch </cmdref/bds/instance/install-patch>`
  * :doc:`install-patch-batching-based-odh-patching-config </cmdref/bds/instance/install-patch-batching-based-odh-patching-config>`
  * :doc:`install-patch-domain-based-odh-patching-config </cmdref/bds/instance/install-patch-domain-based-odh-patching-config>`
  * :doc:`install-patch-downtime-based-odh-patching-config </cmdref/bds/instance/install-patch-downtime-based-odh-patching-config>`
  * :doc:`list </cmdref/bds/instance/list>`
  * :doc:`list-node-backup-configurations </cmdref/bds/instance/list-node-backup-configurations>`
  * :doc:`list-node-backups </cmdref/bds/instance/list-node-backups>`
  * :doc:`list-node-replace-configurations </cmdref/bds/instance/list-node-replace-configurations>`
  * :doc:`list-os-patches </cmdref/bds/instance/list-os-patches>`
  * :doc:`list-patch-histories </cmdref/bds/instance/list-patch-histories>`
  * :doc:`list-patches </cmdref/bds/instance/list-patches>`
  * :doc:`list-resource-principal-configurations </cmdref/bds/instance/list-resource-principal-configurations>`
  * :doc:`master-nodes </cmdref/bds/instance/master-nodes>`

    * :doc:`add </cmdref/bds/instance/master-nodes/add>`

  * :doc:`remove </cmdref/bds/instance/remove>`
  * :doc:`renew-certificate </cmdref/bds/instance/renew-certificate>`
  * :doc:`replace-node </cmdref/bds/instance/replace-node>`
  * :doc:`restart-node </cmdref/bds/instance/restart-node>`
  * :doc:`start </cmdref/bds/instance/start>`
  * :doc:`stop </cmdref/bds/instance/stop>`
  * :doc:`update </cmdref/bds/instance/update>`
  * :doc:`update-node-backup-configuration </cmdref/bds/instance/update-node-backup-configuration>`
  * :doc:`update-node-backup-configuration-node-level-details </cmdref/bds/instance/update-node-backup-configuration-node-level-details>`
  * :doc:`update-node-backup-configuration-node-type-level-details </cmdref/bds/instance/update-node-backup-configuration-node-type-level-details>`
  * :doc:`update-node-replace-configuration </cmdref/bds/instance/update-node-replace-configuration>`
  * :doc:`update-node-replace-configuration-node-level-details </cmdref/bds/instance/update-node-replace-configuration-node-level-details>`
  * :doc:`update-node-replace-configuration-node-type-level-details </cmdref/bds/instance/update-node-replace-configuration-node-type-level-details>`
  * :doc:`update-resource-principal-configuration </cmdref/bds/instance/update-resource-principal-configuration>`
  * :doc:`utility-nodes </cmdref/bds/instance/utility-nodes>`

    * :doc:`add </cmdref/bds/instance/utility-nodes/add>`

  * :doc:`worker-nodes </cmdref/bds/instance/worker-nodes>`

    * :doc:`add </cmdref/bds/instance/worker-nodes/add>`


* :doc:`kafka </cmdref/bds/kafka>`

  * :doc:`add </cmdref/bds/kafka/add>`
  * :doc:`remove </cmdref/bds/kafka/remove>`

* :doc:`node-backup </cmdref/bds/node-backup>`

  * :doc:`delete </cmdref/bds/node-backup/delete>`

* :doc:`node-backup-configuration </cmdref/bds/node-backup-configuration>`

  * :doc:`delete </cmdref/bds/node-backup-configuration/delete>`

* :doc:`node-replace-configuration </cmdref/bds/node-replace-configuration>`

  * :doc:`remove </cmdref/bds/node-replace-configuration/remove>`

* :doc:`resource-principal-configuration </cmdref/bds/resource-principal-configuration>`

  * :doc:`remove </cmdref/bds/resource-principal-configuration/remove>`

* :doc:`work-request </cmdref/bds/work-request>`

  * :doc:`get </cmdref/bds/work-request/get>`
  * :doc:`list </cmdref/bds/work-request/list>`

* :doc:`work-request-error </cmdref/bds/work-request-error>`

  * :doc:`list </cmdref/bds/work-request-error/list>`

* :doc:`work-request-log-entry </cmdref/bds/work-request-log-entry>`

  * :doc:`list </cmdref/bds/work-request-log-entry/list>`


.. toctree::
    :hidden:

    /cmdref/bds/auto-scale-config
    /cmdref/bds/bds-api-key
    /cmdref/bds/bds-cluster-version
    /cmdref/bds/bds-metastore-configuration
    /cmdref/bds/block-storage
    /cmdref/bds/cloudsql
    /cmdref/bds/identity-configuration
    /cmdref/bds/instance
    /cmdref/bds/kafka
    /cmdref/bds/node-backup
    /cmdref/bds/node-backup-configuration
    /cmdref/bds/node-replace-configuration
    /cmdref/bds/resource-principal-configuration
    /cmdref/bds/work-request
    /cmdref/bds/work-request-error
    /cmdref/bds/work-request-log-entry