×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
BMC Database Automation 20.19 ... Developing Using REST API Provisioning functions

Provisioning Oracle databases

Use the following procedures to provision an Oracle database:

The base URL for the API is:

https://<managerHostName>/bda/rest/api


Creating an Oracle grid infrastructure

Use the following procedure to create an Oracle grid infrastructure.

Syntax

/1.0/oracle/create_grid

Method

POST

Required Parameters

  • display_name—Enter a display name for the new Oracle grid infrastructure.

  • node—Use the fully qualified nodeId.
    Use the value of nodeId from the dstate file of Agent node.

    Note

    The location of the dstate file is /app/clarity/dagent/var/dstate in Linux.

    Example

    A node that resides in the domain LINUX, has the value /LINUX/<node_id>.

  • version—Enter the Oracle version for which you want to create the grid infrastructure.
    Select an appropriate value from the following table:

    Oracle versionValue to be entered
    11gR211.2.0.4
    12cR112.1.0.2
    12cR212.2.0.1
    18c12.2.0.2
    19c12.2.0.3
  • template_id—Use the ID provided in the templates of BDA interface.

Optional Parameter

Use the parameter override_values to override the custom field values in the supplied Provisioning template. You must provide values in this field when the following conditions exist:

  • The custom fields are not defined in the supplied template.
  • You have not provided the default values in the supplied template.

Example API response

{
  "status": "success",
  "status_code": 200,
  "data": {
    "job_id": "479",
    "result": "Please check job '479' for info!!"
  }
}

Example API command

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" –data "display_name=<grid_name>&node=<node_fqn>&version=<oracle_version>&template_id=<template_id>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/create_grid

Example of passing ASM Disk Values through override_values

override_values=ASM_DISKSTRING_VALUE=/dev/oracle/post11gR2/*,ASM_DISK_VALUE1=/dev/oracle/post11gR2/GRID1,ASM_DISK_VALUE2=/dev/oracle/post11gR2/GRID2,ASM_DISK_VALUE3=/dev/oracle/post11gR2/GRID3,ASM_DISK_VALUE4=/dev/oracle/post11gR2/GRID4,ASM_DISK_VALUE5=/dev/oracle/post11gR2/GRID5

Creating an Oracle RAC database

Use the following procedure to create an Oracle Real Application Clusters (Oracle RAC) database.

Syntax

/1.0/oracle/create_rac_db

Method

POST

Required parameters

  • db_name—Use the display name of the database.
  • node—Use the fully qualified node name.
  • version—Use the Oracle version that you are using currently.
  • template_id—Use the ID provided in the templates of BDA interface.

Optional parameters

None

Example API response

{
    "status": "success",
    "status_code": 200,
    "data": {
        "job_id": "482",
        "result": "Please check job '482' for info!!"
    }
}

Example API command

To create an Oracle RAC database:

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" --data "db_name=<db_name>&node=<node_fqn>&version=<oracle_version>&template_id=<template_id>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/create_rac_db

Creating an Oracle database on a Linux Single Instance (SI)

Use the following procedure to create an Oracle database on a Linux SI.

Syntax

/1.0/oracle/create_db

Method

POST

Required parameters

  • db_name—Use the display name of the database.
  • node—Use the fully qualified node name.
  • version—Use the Oracle version that you are using currently.
  • template_id—Use the ID provided in the templates of BDA interface.

Optional parameters

None

Example API response

{
    "status": "success",
    "status_code": 200,
    "data": {
        "job_id": "479",
        "result": "Please check job '479' for info!!"
    }
}

Example API command

To create a database on a Linux SI:

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" --data "db_name=<db_name>&node=<node_fqn>&version=<oracle_version>&template_id=<template_id>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/create_db

Creating an Oracle database on Microsoft Windows

Use the following procedure to create an Oracle database on Windows node.

Syntax

/1.0/oracle/create_db_windows

Method

POST

Required Parameters

  • display_name—Enter a display name for the new Oracle database.

  • node—Use the fully qualified nodeId.
    Use the value of nodeId from the dstate.conf file of Agent node.

    Note

    The location of the dstate.conf file is /<agent_install_dir>/dstate.conf in Windows.

    Example

    A node that resides in the domain WINDOWS, has the value /WINDOWS/<node_id>.

  • version—Enter the Oracle version for which you want to create the database.
    Select an appropriate value from the following table:

    Oracle versionValue to be entered
    11gR211.2.0.4
    12cR112.1.0.2
    12cR212.2.0.1
    18c12.2.0.2
    19c12.2.0.3
  • template_id—Use the ID provided in the templates of BDA interface.

Optional Parameter

Use the parameter override_values to override the custom field values in the supplied database template. You must provide values in this field when the following conditions exist:

  • The custom fields are not defined in the supplied template.
  • You have not provided the default values in the supplied template.

Example API response

{
  "status": "success",
  "status_code": 200,
  "data": {
    "job_id": "479",
    "result": "Please check job '479' for info!!"
  }
}

Example API command

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" –data "display_name=<display_name>&node=<node_fqn>&version=<oracle_version>&template_id=<template_id>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/create_db_windows

Creating an Oracle home

Use the following procedure to create an Oracle home.

Syntax

/1.0/oracle/add_home

Method

POST

Required Parameters

  • display_name—Enter a display name for the new Oracle Home.

  • node—Use the fully qualified nodeId.
    Use the value of nodeId from dstate.conf or dsate file of Agent node.

    Note

    The location of the file is:

    • /<agent_install_dir>/dstate.conf, in Windows
    • /app/clarity/dagent/var/dstate, in Linux

    Example

    A node that resides in the domain WINDOWS, has the value /WINDOWS/<node_id>.

  • version—Enter the Oracle version for which you want to create the Oracle home.
    Select an appropriate value from the following table

    Oracle versionValue to be entered
    11gR211.2.0.4
    12cR112.1.0.2
    12cR212.2.0.1
    18c12.2.0.2
    19c12.2.0.3
  • template_id—Use the ID provided in the templates of BDA interface.

Optional Parameter

Use the parameter override_values to override the custom field values in the supplied database template. You must provide values in this field when the following conditions exist:

  • The custom fields are not defined in the supplied template.
  • You have not provided the default values in the supplied template.

Example API response

{
  "status": "success",
  "status_code": 200,
  "data": {
    "job_id": "479",
    "result": "Please check job '479' for info!!"
  }
}

Example API command

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" –data "display_name=<home_name>&node=<node_fqn>&version=<oracle_version>&template_id=<template_id>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/add_home

Creating a Pluggable database (for Windows and Linux)

Use the following procedure to create a Pluggable database.

Syntax

/1.0/oracle/add_pdb

Method

POST

Required Parameters

  • display_name—Enter a display name for the new Pluggable database.

  • node—Use the fully qualified nodeId.
    Use the value of nodeId from dstate.conf or dsate file of Agent node.

    Note

    The location of the file is:

    • /<agent_install_dir>/dstate.conf, in Windows
    • /app/clarity/dagent/var/dstate, in Linux

    Example

    A node that resides in the domain WINDOWS, has the value /WINDOWS/<node_id>.

  • cdb_name—Use the Oracle container database name.

  • template_id—Use the ID provided in the templates of BDA interface.

Optional Parameter

Use the parameter override_values to override the custom field values in the supplied database template. You must provide values in this field when the following conditions exist:

  • The custom fields are not defined in the supplied template.
  • You have not provided the default values in the supplied template.

Example API response

{
  "status": "success",
  "status_code": 200,
  "data": {
    "job_id": "479",
    "result": "Please check job '479' for info!!"
  }
}

Example API command

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" –data "display_name=<display_name>&node=<node_fqn>&cdb_name=<cdb_name>&template_id=<template_id>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/add_pdb

Starting an Oracle database

Use the following procedure to start an Oracle database instance.

Syntax

/1.0/oracle/start

Method

POST

Required parameters

  • db_name—Use the display name of the database.
  • node—Use the fully qualified node name.

Optional parameters

None

Example API response

{
    "status": "success",
    "status_code": 200,
    "data": {
        "job_id": "481",
        "result": "Please check job '481' for info!!"
    }
}

Example API command

To start an Oracle database:

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" --data "db_name=<db_name>&node=<node_fqn>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/start

Stopping an Oracle database

Use the following procedure to stop an Oracle database instance.

Syntax

/1.0/oracle/stop

Method

POST

Required parameters

  • db_name—Use the display name of the database.
  • node—Use the fully qualified node name.

Optional parameters

None

Example API response

{
    "status": "success",
    "status_code": 200,
    "data": {
        "job_id": "480",
        "result": "Please check job '480' for info!!"
    }
}

Example API command

To stop an Oracle database:

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" --data "db_name=<db_name>&node=<node_fqn>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/stop

Removing an Oracle home

Use the following procedure to remove an Oracle home.

Syntax

/1.0/oracle/remove_home

Method

POST

Required Parameters

  • display_name—Use the display name of the Oracle home.

  • node—Use the fully qualified nodeId.
    Use the value of nodeId from dstate.conf or dsate file of Agent node.

    Note

    The location of the file is:

    • /<agent_install_dir>/dstate.conf, in Windows
    • /app/clarity/dagent/var/dstate, in Linux

    Example

    A node that resides in the domain WINDOWS, has the value /WINDOWS/<node_id>.

  • template_id—Use the ID provided in the templates of BDA interface.

Optional Parameter

Use the parameter override_values to override the custom field values in the supplied database template. You must provide values in this field when the following conditions exist:

  • The custom fields are not defined in the supplied template.
  • You have not provided the default values in the supplied template.

Example API response

{
  "status": "success",
  "status_code": 200,
  "data": {
    "job_id": "479",
    "result": "Please check job '479' for info!!"
  }
}

Example API command

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" –data "display_name=<display_name>&node=<node_fqn>&template_id=<template_id>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/remove_home

Removing an Oracle database (Linux)

Use the following procedure to remove an Oracle database from Linux node.

Syntax

/1.0/oracle/remove_db

Method

POST

Required parameters

  • db_name—Use the display name of the database.
  • node—Use the fully qualified node name.
  • template_id—Use the ID provided in the templates of BDA interface.

Optional parameters

None

Example API response

{
    "status": "success",
    "status_code": 200,
    "data": {
        "job_id": "483",
        "result": "Please check job '483' for info!!"
    }
}

Example API command

To remove an Oracle database:

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" --data "db_name=<db_name>&node=<node_fqn>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/remove_db

Removing an Oracle Database (Windows)

Use the following procedure to remove an Oracle database from Windows node.

Syntax

/1.0/oracle/remove_db_windows

Method

POST

Required Parameters

  • display_name—Use the display name of the database.

  • node—Use the fully qualified nodeId.
    Use the value of nodeId from dstate.conf or dsate file of Agent node.

    Note

    The location of the file is:

    • /<agent_install_dir>/dstate.conf, in Windows
    • /app/clarity/dagent/var/dstate, in Linux

    Example

    A node that resides in the domain WINDOWS, has the value /WINDOWS/<node_id>.

  • template_id—Use the ID provided in the templates of BDA interface.

Optional Parameter

Use the parameter override_values to override the custom field values in the supplied database template. You must provide values in this field when the following conditions exist:

  • The custom fields are not defined in the supplied template.
  • You have not provided the default values in the supplied template.

Example API response

{
  "status": "success",
  "status_code": 200,
  "data": {
    "job_id": "479",
    "result": "Please check job '479' for info!!"
  }
}

Example API command

curl -k -H "x-auth-token: ad7aaa89fbf0ef648ddd1607007e819f" –data "display_name=<display_name>&node=<node_fqn>&template_id=<template_id>" https://my.bda.manager.com/bda/rest/api/1.0/oracle/remove_db_windows


Related topic

Provisioning functions


Was this page helpful? Yes No Submitting... Thank you
Last modified by Winner kumar Jaiswal on Dec 23, 2019
developing

Comments

Log in or register to comment.

Provisioning MSSQL databases
Provisioning DB2 databases
© Copyright 2013 - 2019 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

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