4 OEDA Command Line Interface

When you run the oedacli program, it starts the OEDA command line interface.

4.1 About the OEDA Command Line Interface

The primary goal of oedacli is to assist in completing various Exadata life cycle management tasks.

The OEDA command-line interface is a new interface that allows you to update an existing es.xml file. These updates are called Actions. An Action is a single atomic task. You can use the command line interface to perform any of the following tasks:

  • Add node to or remove node from a Virtual Cluster on Exadata

  • Add database home to or remove database home from physical cluster

  • Add or remove Storage cell

  • Resize Oracle ASM disk groups

  • Add or remove additional Databases

  • Add or remove additional database homes to an Oracle VM cluster

An Action can have many sub commands, however most actions are single commands. Examples of multi-command steps are - CLONE GUEST and CLONE CELL

oedacli has two operating modes:

  • Edit mode

    • Used against an es.xml file before you run the install.sh command steps

    • Used to edit an XML file, for example to add a second Database Home, then save the XML file

    • Can be used as a logical XML editor for the es model prior to deployment

  • Deploy mode

    • Used to edit an es.xml file after you have run the install.sh command steps

    • Can be used to Clone Oracle VM Guests or grow or shrink Oracle ASM Disk groups

    • Has a smaller list of supported changes than Edit mode

    • Can be used as a logical XML editor and deployment tool after the initial deployment

Edit mode workflow

  1. When the command line interface starts, it has no target es.xml file to work on, so you first load an es.xml file.

    LOAD FILE name=es.xml
  2. Modify an in-memory version of the es.xml. Specify the additional actions to perform during deployment. For example, to clone an Oracle VM guest to a new guest:

    clone guest srcname=asd
    set privnet name1='test08adm01-priv1',ip1='192.168.216.102',name2='testadm01-priv2',ip2='192.168.216.103'
    set parent name='test08adm01a'
    set adminnet name='test08adm01vm02',ip='10.128.218.70'
    set clientnet name='test08client01vm02',ip='10.128.196.63'
    set vipnet name='test08client01vm02-vip',ip='10.128.196.71'
  3. After you have provided all the commands for an action, save the action to a list of actions to be processed within the command line interface. At this point, the data in the es.xml file is not yet updated.

    SAVE ACTION
  4. Merge the actions into the main body of the in-memory copy of the es.xml using the FORCE keyword.

    MERGE ACTIONS FORCE
  5. Save the memory copy of the es.xml, overwriting the input file or writing to a new file that you specify.

    SAVE FILE [name=new_es.xml]

Deploy mode workflow

  1. When the command line interface starts, it has no target es.xml file to work on, so you first load an es.xml file.

    LOAD FILE name=es.xml
  2. Modify an in-memory version of the es.xml. Specify the actions to perform.

  3. After you have provided all the commands for an action, save the action to a list of actions to be processed within the command line interface. At this point, the data in the es.xml file is not yet updated.

    SAVE ACTION
  4. Merge the actions into the main body of the in-memory copy of the es.xml.

    MERGE ACTIONS
  5. Deploy the actions into the main body of the es.xml file. This step will perform the specified actions such as creating the new Oracle VM guest.

    DEPLOY ACTIONS
  6. Save the memory copy of the es.xml, overwriting the input file or writing to a new file that you specify.

    SAVE FILE [name=new_es.xml]

4.2 Starting the OEDACLI Utility

Starting with August 2017 Release of Oracle Exadata Deployment Assistant (OEDA), a command-line utility — oedacli — can be used for various routine tasks on Exadata.

Prerequisites

To use oedacli, you must meet the following requirements:

  • Download the August 2017 release or later of OEDA. The August 2017 release of OEDA is only supported on Oracle Linux.

  • Have the original OEDA configuration XML file used for deployment

  • Use the default password on the nodes in the cluster (for the root, oracle and grid users)

Note:

If your environment does not use the default passwords for the specified users, then refer to My Oracle Support Doc ID 2163751.1.

File Path

The directory that contains the unzipped files from the OEDA download. For example /u01/joc/linux-x64.

Syntax

./oedacli

Usage Notes

To display the help output, use one of the following:

  • HELP

  • HELP command name

4.2.1 Displaying Help Output for OEDACLI

You can display syntax help for the OEDACLI utility using the HELP command.

Example 4-1 Help Output for OEDACLI

This example shows the help output listing the available objects and command for the OEDACLI 18c (18.1.0) release:

oedacli> HELP
 HELP [topic]
   Available Objects:
 ACFSVOLUME
        LIST ACFSVOLUMES
 CELL
        LIST CELLS
 CLUSTER
        LIST CLUSTERS
 DISKGROUP
        LIST DISKGROUPS
 DATABASE
        LIST DATABASES
 DATABASEHOME
        LIST DATABASEHOMES
 DOM0
        LIST DOM0S
 GUEST
        CLONE GUEST
        DELETE GUEST
        LIST GUESTS
 ILOM
        LIST ILOMS
 MACHINE
        LIST MACHINES
 NETWORK
        LIST NETWORKS
 SCAN
        LIST SCANS
 SWITCH
        LIST SWITCHES
 VIP
        LIST VIPS
 CLI COMMANDS
        LOAD FILE
        SAVE FILE
        SAVE FILES
        LIST XMLACTIONS
        SAVE ACTION
        MERGE ACTIONS
        DEPLOY ACTIONS

4.2.2 Displaying Help Output for an OEDACLI Command

This example shows the help output listing the OEDACLI ALTER DATABASE command.

Example 4-2 Help Output for the OEDACLI ALTER DATABASE command

This example shows how to display the syntax for the ALTER DATABASE command of OEDACLI. The help output is shown for the 18c (18.1.0) release.

oedacli> HELP ALTER DATABASE
 Usage:
 ALTER DATABASE
  BLOCKSIZE = <blocksize> |
  CHARSET = <characterset> |
  DATADG = <datadg> |
  DBLANG = <dblang> |
  DBNAME = <dbname> |
  DBTEMPLATE = <dbtemplate> |
  DBTYPE = <dbtype> |
  HOSTNAMES = <hostnames> |
  RECODG = <recodg>
 WHERE
  ID = <databaseid> |
  CLUSTERNUMBER = <clusternumber> DATABASENAME = <databasename> |
  CLUSTERNAME = <clustername> DATABASENAME = <databasename> |
  CLUSTERID = <clusterid> DATABASENAME = <databasename>
 
 Purpose:
   Alters an existing database
 Arguments:
   <blocksize>    :  Default: 8192,  not required for PDB
   <characterset> :  Default: AL32UTF8,  not required for PDB
   <datadg>       : *The DATA diskgroup, not required for PDB
   <dblang>       :  Default: all_langs, not required for PDB
   <dbname>       : *Database name
   <dbtemplate>   :  Default: ADMIN, otherwise ADMIN or DW, not required for PDB
   <dbtype>       :  Default: normal DB, otherwise CDB or PDB
   <hostnames>    :  Default:  list of nodes from db home
   <recodg>       : *The RECO diskgroup, not required for PDB
 Where:
   <databaseid>    : The es xml id of the database
   <clusternumber> : The cluster number in the es xml, starting at 1
   <clustername>   : The name of the cluster
   <clusterid>     : The es xml id of the cluster
   <databasename>  : The name of the database in the cluster

4.3 OEDACLI Command Reference

These OEDACLI commands are arranged by the object they act upon.

4.3.1 OEDACLI Commands

These commands are used to interact with OEDACLI, to load and save files, and to merge, save, and deploy actions.

4.3.1.1 LOAD FILE
Use this command to load an engineered system XML file (es.xml) into OEDACLI memory for editing.

Syntax

 LOAD FILE NAME=filename

Arguments

  • NAME : Specifies the name of an existing engineered system XML file

Example 4-3 Loading a File into OEDACLI for Editing

oedacli> LOAD FILE NAME=Oracle-test12.xml 
SUCCESS - file loaded OK 
Customer : testadm01 - Oracle
4.3.1.2 SAVE ACTION
Use this command to save the current action to engineered system XML memory copy.

Syntax

SAVE ACTION [FORCE]

Arguments

Specify FORCE if the action should be auto-merged into the engineered system model.

Note:

The engineered system configuration should be saved as a file using a subsequent SAVE FILE command.
4.3.1.3 MERGE ACTIONS
Use this command to merge the current actions into the other actions in the Engineered System model.

Syntax

MERGE ACTIONS [FORCE]

Arguments

Specify FORCE if you do not want this action to be processed by a DEPLOY ACTIONS command.

4.3.1.4 DEPLOY ACTIONS
Use this command to execute all actions from the Actions section of the engineered systems XML file.

Syntax

DEPLOY ACTIONS

Example 4-4 Deploying the Actions to Add a Database

oedacli> DEPLOY ACTIONS 
Deploying Action ID : 4 add database dbname='testdb' DATADG='DATAC1' RECODG='
RECOC1' where DBHOMEID='c0_databaseHome' 
Deploying ADD DATABASE 
Running datapatch on database 'testdb' 
Done... 
Done
4.3.1.5 SAVE FILE
Use this command to save a current set of actions to a new engineered system XML file.

Syntax

SAVE FILE [ NAME=filename ]

Arguments

The optional argument, NAME, is used to specify the name of a new engineered system XML file. If you do not specify the NAME argument, then this command overwrites the source file.

4.3.1.6 SAVE FILES
Use this command to generate a new set of configuration files from OEDA.

Syntax

SAVE FILES LOCATION = dirname

Arguments

The LOCATION argument specifies the directory in which the new file set will be created.

Usage Notes

If the specified directory does not exist, it will be created.

4.3.1.7 LIST STEPS

This command lists the steps for a given cluster.

Each step is named, for example Create Virtual Machine. Each step also has a one word identifier, for example, CREATEVM. The short name identifier is used when specifying STEPS or SKIPSTEPS for the CREATE CLUSTER command.

The list of valid steps for a cluster depends on the features selected for the cluster. The steps listed are valid for the identified cluster. If the XML file contains only 1 cluster, then there is no need to identify the cluster explicitly.

The step numbers listed may change depending on features implemented for the cluster, but the short name identifier is always the same for a given step.

Syntax

oedacli> LIST STEPS WHERE clustername = Cluster-c1 
{
  "step" : [ {
    "stepName" : "Validate Configuration File",
    "shortName" : "VALIDATE",
    "id" : "1"
  }, {
    "stepName" : "Create Virtual Machine",
    "shortName" : "CREATEVM",
    "id" : "2"
  }, {
    "stepName" : "Create Users",
    "shortName" : "USERS",
    "id" : "3"
  }, {
    "stepName" : "Setup Cell Connectivity",
    "shortName" : "CELLCONN",
    "id" : "4"
  }, {
    "stepName" : "Calibrate Cells",
    "shortName" : "CALIBRATE",
    "id" : "5"
  }, {
    "stepName" : "Create Cell Disks",
    "shortName" : "CELLDISKS",
    "id" : "6"
  }, {
    "stepName" : "Create Grid Disks",
    "shortName" : "GRIDDISKS",
    "id" : "7"
  }, {
    "stepName" : "Install Cluster Software",
    "shortName" : "INSTALLGI",
    "id" : "8"
  }, {
    "stepName" : "Initialize Cluster Software",
    "shortName" : "INITGI",
    "id" : "9"
  }, {
    "stepName" : "Install Database Software",
    "shortName" : "INSTALLDB",
    "id" : "10"
  }, {
    "stepName" : "Relink Database with RDS",
    "shortName" : "RELINK",
    "id" : "11"
  }, {
    "stepName" : "Create ASM Diskgroups",
    "shortName" : "ASMDG",
    "id" : "12"
  }, {
    "stepName" : "Create Databases",
    "shortName" : "DATABASE",
    "id" : "13"
  }, {
    "stepName" : "Apply Security Fixes",
    "shortName" : "APPLYFIXES",
    "id" : "14"
  }, {
    "stepName" : "Install Exachk",
    "shortName" : "EXACHK",
    "id" : "15"
  }, {
    "stepName" : "Create Installation Summary",
    "shortName" : "INSTALLSUMMARY",
    "id" : "16"
  }, {
    "stepName" : "Resecure Machine",
    "shortName" : "RESECURE",
    "id" : "17"
  } ]
}
4.3.1.8 LIST XMLACTIONS
This command lists the current actions created by OEDACLI.

Syntax

LIST XMLACTIONS

4.3.2 ACFSVOLUME

You can add, alter, delete, or list Oracle ACFS volumes.

4.3.2.1 ADD ACFSVOLUME
This command adds Oracle ASM Cluster File System (Oracle ACFS) volumes.

Syntax

ADD ACFSVOLUME
   VOLUMENAME = volume_name |
   VOLUMESIZE = volume_size |
   MOUNTPATH = mountpath 
WHERE
 DISKGROUPID = diskgroup_id |
 CLUSTERNUMBER = cluster_number DISKGROUPNAME = diskgroup_name |
 CLUSTERNAME = cluster_name DISKGROUPNAME diskgroup_name |
 CLUSTERID = cluster_id DISKGROUPNAME = diskgroup_name 

Arguments

You can specify the following attributes for the new Oracle ACFS volume:

  • VOLUMENAME : Specifies a unique name for the new volume

  • VOLUMESIZE : A number that specifies the size of the new volume in GB

  • MOUNTPATH : Specifies the file system mount path for the new volume

The following arguments are available in the WHERE clause:

  • DISKGROUPID : Specifies the es.xml ID for the container disk group

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DISKGROUPNAME : Specifies the name of the container disk group

4.3.2.2 ALTER ACFSVOLUME
This command alters an existing Oracle ASM Cluster File System (Oracle ACFS) volume.

Syntax

ALTER ACFSVOLUME
   VOLUMENAME = volume_name |
   VOLUMESIZE = volume_size |
   MOUNTPATH = mountpath 
WHERE
 ID = acfs_volume_id |
 DISKGROUPID = diskgroup_id VOLUMENAME = volume_name|
 CLUSTERNUMBER = cluster_number DISKGROUPNAME = diskgroup_name VOLUMENAME = volume_name|
 CLUSTERNAME = cluster_name DISKGROUPNAME diskgroup_name VOLUMENAME = volume_name|
 CLUSTERID = cluster_id DISKGROUPNAME = diskgroup_name VOLUMENAME = volume_name

Arguments

You can modify the following attributes of the Oracle ACFS volume:

  • VOLUMENAME : Specifies a new, unique volume name

  • VOLUMESIZE : A number that specifies the new size of the volume in GB

  • MOUNTPATH : Specifies the new file system mount path for the volume

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for an existing Oracle ACFS volume

  • DISKGROUPID : Specifies the es.xml ID for the container disk group

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DISKGROUPNAME : Specifies the name of the container disk group

  • VOLUMENAME : Specifies the name of the existing Oracle ACFS volume

4.3.2.3 DELETE ACFSVOLUME
This command deletes an existing Oracle ASM Cluster File System (Oracle ACFS) volume.

Syntax

DELETE ACFSVOLUME
WHERE
 ID = acfs_volume_id |
 DISKGROUPID = diskgroup_id VOLUMENAME = volume_name|
 CLUSTERNUMBER = cluster_number DISKGROUPNAME = diskgroup_name VOLUMENAME = volume_name|
 CLUSTERNAME = cluster_name DISKGROUPNAME diskgroup_name VOLUMENAME = volume_name|
 CLUSTERID = cluster_id DISKGROUPNAME = diskgroup_name VOLUMENAME = volume_name

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the Oracle ACFS volume

  • DISKGROUPID : Specifies the es.xml ID for the container disk group

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DISKGROUPNAME : Specifies the name of the container disk group

  • VOLUMENAME : Specifies the name of the existing Oracle ACFS volume

4.3.2.4 LIST ACFSVOLUME
This command lists the Oracle ASM Cluster File System (Oracle ACFS) volumes.

Syntax

LIST ACFSVOLUMES
WHERE
 ID = id |
 DISKGROUPID = diskgroup_id |
 CLUSTERNUMBER = cluster_number [DISKGROUPNAME = diskgroup_name] |
 CLUSTERNAME = cluster_name [DISKGROUPNAME diskgroup_name] |
 CLUSTERID = cluster_id [DISKGROUPNAME = diskgroup_name]

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the Oracle ACFS volume

  • DISKGROUPID : Specifies the es.xml ID for the container disk group

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DISKGROUPNAME : Specifies the name of the container disk group

Usage Notes

There is no WHERE clause that will list all the Oracle ACFS volumes in the es.xml file.

4.3.3 CELL

You can clone, delete, or list Oracle Exadata storage cells.

4.3.3.1 CLONE CELL
This command clones an existing storage cell.

Syntax

CLONE CELL SRCNAME = source_cell
  SET ADMINNET NAME=admin_name,IP=IP_admin
  SET PRIVNET NAME1=priv_name_1,IP1=priv_ip1,NAME2=priv_name_2,IP2=priv_ip2
  SET ILOMNET NAME=ilom_name,IP=ilom_ip
  SET RACK NUM=rack_number,ULOC=ulocation

Arguments

SRCNAME is used to specify the name of an existing cell from which the new cell is derived.

The following arguments are available in the SET clauses:

  • ADMINNET : Specifies the DNS name (admin_name) with an optional domain name and the IP address to be used for the admin network.

  • PRIVNET : Specifies the name with an optional domain name and the IP address to be used for the first and second private networks.

  • ILOMNET : Specifies the DNS name with an optional domain name and the IP address to be used for the ILOM network.

  • RACK : Specifies the rack number in a multi-rack configuration, where 1 is the first rack, and the physical Ulocation (slot) of the cell in that rack.

4.3.3.2 DELETE CELL
This command deletes an existing storage cell.

Syntax

DELETE CELL WHERE SRCNAME = cell_host_name

Arguments

SRCNAME is used to specify the host name of an existing cell that you want to remove.

4.3.3.3 LIST CELLS
This command lists the storage cells.

Syntax

LIST CELLS

4.3.4 CLUSTER

You can alter or list the Oracle RAC Clusters on the Oracle Exadata Database Machine.

4.3.4.1 ALTER CLUSTER
This command alters attributes for an existing Oracle RAC Cluster.

Syntax

ALTER CLUSTER { CLUSTERNAME = cluster_name | GIVERSION = grid_version |
   GIHOMELOC = grid_home_location | INVLOC = inventory_location|
   BASEDIR = oracle_base_directory |  PATCHLIST = patch_list }
WHERE
   CLUSTERNUMBER = cluster_number |
   CLUSTERNAME = cluster_name |
   CLUSTERID = cluster_id 

Arguments

You can modify the following attributes of the Oracle RAC Cluster:

  • CLUSTERNAME : Specifies a new, unique name for the cluster

  • GIVERSION : Specifies the clusterware version, including the bundle patch, for example 12.1.0.2.170418

  • GIHOMELOC : Specifies a new path for the Grid home

  • INVLOC : Specifies a new path for the inventory

  • BASEDIR : Specifies a new path for the Oracle base directory

  • PATCHLIST : Specifies a full list of patches separated by commas and enclosed in single quotes. By default, this is derived from the bundle patch specified by GIVERSION.

The following arguments are available in the WHERE clause:

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

4.3.4.2 CREATE CLUSTER

This command is used to run all the steps required to create the virtual guests for a cluster and the following steps to configure and deploy an Oracle RAC database.

Syntax

The simplest form of this command does not require any arguments. However, if the XML file being used by OEDACLI contains more than one cluster, then the WHERE clause is mandatory.

CREATE CLUSTER [WHERE CLUSTERNAME=cluster_name]

There are additional parameters and WHERE clause options for the command that you can use.

CREATE CLUSTER [STEPS='short_names'] [SKIPSTEPS='short_names'] 
 [DELETEDB={true|false}] [WHERE {CLUSTERNAME=cluster_name |
   CLUSTERNUMBER=cluster_number | CLUSTERID=cluster_id }

Arguments

  • STEPS: This parameter allows you to specify which steps to run. Each step in the list is separated by a space and the list is enclosed in single quotes. When you run the CREATE CLUSTER command with this parameter, it performs only the steps listed in the STEPS clause, excluding any steps listed in the SKIPSTEPS clause.

  • SKIPSTEPS: When you run the CREATE CLUSTER command, it performs all the steps listed in LIST STEPS excluding those listed in the SKIPSTEPS clause. Each step in the list is separated by a space and the list is enclosed in single quotes.

  • DELETEDB: If you do not require the database created by OEDA, then the database can be removed upon complete of the CREATE CLUSTER command by specifying the parameter DELETEDB=true. The default value for this parameter is false, which leaves the database in-place.

The following arguments are available in the WHERE clause:

  • CLUSTERNUMBER: Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME: Specifies the name of the cluster

  • CLUSTERID: Specifies the es.xml ID of the cluster

Example 4-5 Using the STEPS Parameter with CREATE CLUSTER

If you only want to create the guest domains for the Cluster-c1 cluster, then you would use the following command:

CREATE CLUSTER STEPS='CREATEVM' WHERE CLUSTERNAME=Cluster-c1 

Example 4-6 Using the SKIPSTEPS and DELETEDB Parameters with CREATE CLUSTER

If there are 17 steps for the CREATE CLUSTER command, and SKIPSTEPS is not specified, then OEDACLI will complete all 17 steps. If you use the following command, then only 13 steps are completed, after which the database is deleted.

CREATE CLUSTER SKIPSTEPS='VALIDATE CALIBRATE EXACHECK RESECURE'
         DELETEDB=true WHERE CLUSTERNAME=Cluster-c1
4.3.4.3 DESTROY CLUSTER

This command is used to cleanly destroy a cluster.

If the XML file contains only 1 cluster there is no need to identify the cluster explicitly. The MERGE step will indicate which machines will be destroyed and which cells will be affected.

Syntax

DESTROY CLUSTER WHERE {CLUSTERNUMBER = cluster_number |
  CLUSTERNAME = cluster_name | CLUSTERID = cluster_id }

Arguments

The following arguments are available in the WHERE clause:

  • CLUSTERNUMBER: Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME: Specifies the name of the cluster

  • CLUSTERID: Specifies the es.xml ID of the cluster

Example 4-7 Using the DESTROY CLUSTER Command

The following example shows the simplest case, where there is only a single cluster in the XML file.

oedacli> DESTROY CLUSTER
oedacli> SAVE ACTION 
oedacli> MERGE ACTIONS
oedacli> DEPLOY ACTIONS
4.3.4.4 LIST CLUSTERS

This command lists the existing Oracle RAC clusters.

Syntax

LIST CLUSTERS
 [ WHERE
   CLUSTERNUMBER = cluster_number |
   CLUSTERNAME = cluster_name |
   CLUSTERID = cluster_id ]

Arguments

The following arguments are available in the WHERE clause:

  • CLUSTERNUMBER: Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME: Specifies the name of the cluster

  • CLUSTERID: Specifies the es.xml ID of the cluster

Usage Notes

The WHERE clause is optional.

Example 4-8 Using the LIST CLUSTERS Command

This example shows how to identify the Oracle RAC clusters on the host.

OEDACLI> LIST CLUSTERS
  version : "CloneInstall"
  clusterName : "DBMclu1"  
  clusterOwner : "grid"
  clusterVersion : "19.3.0.0.190416"
  clusterHome : "/u01/app/19.0.0.0/grid"
  inventoryLocation : "/u01/app/oraInventory"
  asmScopedSecurity : "false"
4.3.4.5 UPGRADE CLUSTER

This command is used to upgrade Oracle Clusterware running on the virtual hosts.

Syntax

UPGRADE CLUSTER {GIVERSION = Grid_relnum | GIHOMELOC = Grid_home_dir }
[WHERE {CLUSTERNAME=cluster_name | CLUSTERNUMBER=cluster_number | 
   CLUSTERID=cluster_id } [STEPNAME = step_name] ]

Arguments

  • GIVERSION: The version of the Oracle Grid Infrastructure software you are upgrading to

  • GIHOMELOC: The target location of the Oracle Grid Infrastructure home directory

The following arguments are available in the WHERE clause:

  • CLUSTERNUMBER: Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME: Specifies the name of the cluster

  • CLUSTERID: Specifies the es.xml ID of the cluster

  • STEPNAME: Specifies the name of the individual upgrade step to be run. If this parameter is not specified, then ADD_HOME and CONFIG_HOME operations are performed.

Usage Notes

  • This option is only available for virtual environments.
  • The RUN_ROOTSCRIPT step runs the rootupgrade.sh script in a rolling mode on all nodes. This step also restarts the database instances on each of the nodes.

Example 4-9 Using the UPGRADE CLUSTER Command

This example shows how to upgrade the Oracle Grid Infrastructure software to release 18.6 for both nodes in the first cluster.

OEDACLI> UPGRADE CLUSTER GIVERSION=18.6.0.0.190416 GIHOMELOC=/u01/app/18.0.0.0/grid 
WHERE CLUSTERNUMBER=1 
deploy actions
Deploying Action ID : 3 UPGRADE CLUSTER GIVERSION=18.6.0.0.190416 GIHOMELOC=/u01/app/18.0.0.0/grid 
 WHERE CLUSTERNUMBER=1 STEPNAME=RUN_ROOTSCRIPT
Deploying UPGRADE CLUSTER
Upgrading Cluster
Running Cluster Verification Utility for upgrade readiness..
Pre-upgrade Validation completed successfully.
Running rootupgrade.sh on node dbm01adm01vm01.example.com
Checking file root_dbm01adm01vm01.example.com_2019-05-02_05-56-08-814110215.log on node
 dbm01adm01vm01.example.com
Checking status of cluster on dbm01adm01vm01.example.com
Running rootupgrade.sh on node dbm01adm02vm0.example.com
Checking file root_dbm01adm02vm01.example.com_2019-05-02_06-14-40-524921970.log on node
  dbm01adm02vm01.example.com
Checking status of cluster on dbm01adm02vm01.example.com
Running Configuration Assistants on dbm01adm01vm01.example.com
Active cluster version after upgrade [18.0.0.0.0]
Done...
Done

4.3.5 COMPUTE

Use these commands to add or delete a physical compute node as a cluster member.

4.3.5.1 CLONE COMPUTE

Use this command to clone an existing physical compute cluster node.

Syntax

CLONE COMPUTE
  SRCNAME = source_compute_node
  TGTNAME = target_compute_node
 WHERE
  [ STEPNAME = stepname ]
SET ADMINNET NAME=admin_name,IP=admin_IP
SET PRIVNET NAME1=priv_name_1,IP1=priv_ip1,NAME2=priv_name_2,IP2=priv_ip2
[ SET INTERCONNECT NAME1=priv_name_1,IP1=priv_ip1, [ NAME2=priv_name_2,IP2=priv_ip2 ]]
SET CLIENTNET NAME=client_name,IP=client_ip
SET VIPNET NAME=vipname,IP=vip_ip
[ SET BACKUP NAME=backup_name,IP=backup_ip ]
  SET ILOMNET NAME=ilom_name,IP=ilom_ip
  SET RACK NUM=rack_number,ULOC=ulocation

Arguments

SRCNAME is used to specify the host name of an existing compute server, from which the new compute node is derived.

TGTNAME is used to specify the host name of the new compute server.

The following arguments are available in the SET clauses:

  • ADMINNET: Specifies the DNS name (admin_name) with an optional domain name and the IP address (admin_IP) to be used for the admin network.

  • PRIVNET: Specifies the name with an optional domain name and the IP address to be used for the first and second private networks.

  • INTERCONNECT: Only required if the compute nodes are configured with InfiniBand security (PKEYS). Specifies the name with an optional domain name and the IP address to be used for the first and second private networks.

  • CLIENTNET: Specifies the DNS name with the domain name and the IP address to be used for the client network.

  • VIPNET: Specifies the DNS name with the domain name and the IP address to be used for the virtual IP (VIP) network.

  • BACKUP: Specifies the DNS name with the domain name and the IP address to be used for the optional backup network.

  • ILOMNET: Specifies the DNS name with an optional domain name and the IP address to be used for the ILOM network.

  • RACK: Specifies the rack number in a multi-rack configuration, where 1 is the first rack, and the physical Ulocation (slot) of the cell in that rack.

Example 4-10 Cloning a Compute Node

This example clones the dbadm03 compute server to a new server, dbadm04.

LOAD FILE NAME=mycluster.xml

CLONE COMPUTE srcname=dbadm03  tgtname=dbadm04
SET ADMINNET name=dbadm04, ip=10.128.161.192
SET PRIVNET name1=dbadm04-priv1, ip1=192.168.161.195,  name2=dbadm04-priv2, ip2=192.168.161.196
SET CLIENTNET name=dbadm04-client,ip=198.51.100.112
SET VIPNET name=dbadm04-vip ,ip=10.128.177.116
SET ILOMNET name=dbadm04-ilom ,ip=10.128.161.203
SET RACK num=1, uloc=17
SAVE ACTION
MERGE ACTIONS
DEPLOY ACTIONS
SAVE FILE  name=mycluster2.xml

Example 4-11 Cloning a Compute Node Using Steps

This example clones the dbadm03 compute server to a new server, dbadm04, running each step individually. This example does not show all the steps involved in cloning the compute node.

CLONE COMPUTE srcname=dbadm03  tgtname=dbadm04
  WHERE STEPNAME=CREATE_USERS
SET ADMINNET name=dbadm04, ip=10.128.161.192
SET PRIVNET name1=dbadm04-priv1, ip1=192.168.161.195,  name2=dbadm04-priv2, ip2=192.168.161.196
SET CLIENTNET name=dbadm04-client,ip=198.51.100.112
SET VIPNET name=dbadm04-vip ,ip=10.128.177.116
SET ILOMNET name=dbadm04-ilom ,ip=10.128.161.203SET RACK num=1, uloc=17
SAVE ACTION
MERGE ACTIONS
DEPLOY ACTIONS

CLONE COMPUTE compute  srcname=dbadm03  tgtname=dbadm04
  WHERE STEPNAME=CELL_CONNECTIVITY
SAVE ACTION
MERGE ACTIONS
DEPLOY ACTIONS

CLONE COMPUTE srcname=dbadm03  tgtname=dbadm04
  WHERE STEPNAME=ADD_NODE
SAVE ACTION
MERGE ACTIONS
DEPLOY ACTIONS

...
4.3.5.2 DELETE COMPUTE

This command deletes an existing compute node, removes the instance, home and clusterware from the cluster.

Syntax

DELETE COMPUTE WHERE SRCNAME = cell_host_name
  [ STEPNAME = stepname ]

Arguments

SRCNAME is used to specify the host name of the guest that you want to remove.

STEPNAME is used to clean up steps from a failed CREATE COMPUTE command. Specify the name of the individual creation step to be reverted. The values for stepname are:

  • ADD_INSTANCE
  • EXTEND_DBHOME
  • ADD_NODE
  • CELL_CONNECTIVITY
  • CREATE_USERS

Example 4-12 Deleting a Compute Node - Simple Case

This example removes the dbadm04 compute node from the cluster.

LOAD FILE NAME=4-4compute.xml
DELETE COMPUTE where srcname=dbadm04
SAVE ACTION
MERGE ACTIONS
DEPLOY  ACTIONS
SAVE FILE name=3-4compute.xml

Example 4-13 Deleting a Compute Node with Individual Steps

This example removes the dbadm04 compute node from the cluster, running each step individually. This example does not show all the steps involved in removing the compute node.

LOAD FILE NAME=4-4compute.xml
DELETE COMPUTE where srcname=dbadm04 stepname=ADD_INSTANCE
SAVE ACTION
MERGE ACTIONS
DEPLOY ACTIONS

DELETE COMPUTE where srcname=dbadm04 stepname=EXTEND_DBHOME
SAVE ACTION
MERGE ACTIONS
DEPLOY ACTIONS

DELETE COMPUTE where srcname=dbadm04 stepname=ADD_NODE
SAVE ACTION
MERGE ACTIONS
DEPLOY ACTIONS
...

4.3.6 DATABASE

You can add, alter, delete, or list the Oracle databases.

4.3.6.1 ADD DATABASE
This command adds an Oracle database, or a CDB or PDB to an existing CDB.

Syntax

ADD DATABASE 
   [ BLOCKSIZE = blocksize ]
   [ CHARSET = database_character_set
   DATADG = data_diskgroup
   [ DBLANG = database_language ]
   DBNAME = database_name
   [ DBTEMPLATE = database_template ] 
   [ DBTYPE = database_type ]
   [ HOSTNAMES = 'host_names' ] 
   RECODG = reco_diskgroup
WHERE
   { DBHOMEID = database_home_id |
   CLUSTERNUMBER = cluster_number DBHOMELOC = database_home_location |
   CLUSTERNAME = cluster_name DBHOMELOC = database_home_location |
   CLUSTERID = cluster_id DBHOMELOC = database_home_location |
   CLUSTERNUMBER = cluster_number CDBNAME = container_database_name |
   CLUSTERNAME = cluster_name CDBNAME = container_database_name |
   CLUSTERID = cluster_id CDBNAME = container_database_name }

Arguments

You can specify the following attributes for the new Oracle database:

  • BLOCKSIZE : Specifies the block size for the new database. The default value is 8192. This argument is not required for pluggable databases.

  • CHARSET : Specifies the character set to use for the new database. The default value is AL32UTF8. This argument is not required for pluggable databases.

  • DATADG : (Mandatory) Specifies the name of the DATA disk group for the new database. This argument is not required for pluggable databases.

  • DBLANG : Specifies the language to use for the new database. The default value is all_langs. This argument is not required for pluggable databases.

  • DBNAME : (Mandatory) Specifies the name of the new database.

  • DBTEMPLATE : Specifies the template to use when creating the new database, ADMIN or DW. The default value is ADMIN. This argument is not required for pluggable databases.

  • DBTYPE : Specifies the type of database to create. The accepted values are normal DB, CDB, or PDB. The default value is normal DB.

  • HOSTNAMES : Specifies a comma-separated list of host names on which the database should run. The default value is the list of nodes registered with the database home.

  • RECODG : (Mandatory) Specifies the name of the RECO disk group for the new database. This argument is not required for pluggable databases.

The following arguments are available in the WHERE clause:

  • DBHOMEID : Specifies the es.xml ID of the database home.

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DBHOMELOCATION : Specifies the path for the target database home.

  • CDBNAME : Specifies the database name for the container database. This argument is required only when DBTYPE is set to PDB.

Example 4-14 Adding a New Oracle Database Using OEDACLI

This example shows how to add a new database to the configuration.

  1. Load the OEDA XML configuration file.

    oedacli> LOAD FILE NAME=Oracle-test.xml 
    SUCCESS - file loaded OK 
    Customer : ora07adm01 - Oracle
  2. Use the command LIST DATABASEHOMES to identify the databasehome_id associated with the target database home. This database home will be used to create the new database.

    oedacli> LIST DATABASEHOMES
    version : "CloneInstall" 
    cluster : 
    id : "c0_clusterHome" 
    databaseHomeName : "c0_DbHome_0" 
    databaseSwOwner : "c0_oracle" 
    databaseVersion : "12.2.0.1.170718" 
    databaseHomeLoc : "/u01/app/oracle/product/12.2.0.1/dbhome_1" 
    inventoryLocation : "/u01/app/oraInventory" 
    language : "all_langs" 
    machines : 
    machine : ... 
    ... 
    patches : 
    patch : 
    patchNumber : "26133434" 
    basedir : "/u01/app/oracle" 
    useZfs : "false" 
    id : "c0_databaseHome1"
  3. Create an action for creating the new database. You must provide a name for the new database, and the names of the DATA and RECO disk groups that the new database should use. Also, use the ID retrieved in the previous step to specify the Oracle Home in which to create this database.

    oedacli> ADD DATABASE DBNAME='testdb' DATADG='DATAC1' RECODG='RECOC1' 
    WHERE DBHOMEID='c0_databaseHome'
  4. Save the action.

    oedacli> SAVE ACTION
  5. Merge all actions.

    oedacli> MERGE ACTIONS
    processMerge 
    processMergeActions 
    Merging Action : add database dbname='testdb' DATADG='DATAC1' RECODG='RECOC1' 
    where DBHOMEID='c0_databaseHome' 
    Merging ADD DATABASE 
    Action Validated and Merged OK
  6. Save the action to a new Engineered Systems XML configuration file.

    oedacli> SAVE FILE NAME ='cli-test-2databases.xml' 
    File : cli-test-2databases.xml saved OK
  7. Deploy the actions.

    oedacli> DEPLOY ACTIONS 
    Deploying Action ID : 4 add database dbname='testdb' DATADG='DATAC1' RECODG='
    RECOC1' where DBHOMEID='c0_databaseHome' 
    Deploying ADD DATABASE 
    Running datapatch on database 'testdb' 
    Done... 
    Done
4.3.6.2 ALTER DATABASE
This command alters an existing Oracle database.

Syntax

ALTER DATABASE 
   [ BLOCKSIZE = blocksize ]
   [ CHARSET = database_character_set
   DATADG = data_diskgroup
   [ DBLANG = database_language ]
   DBNAME = database_name
   [ DBTEMPLATE = database_template ] 
   [ DBTYPE = database_type ]
   [ HOSTNAMES = 'host_names' ] 
   RECODG = reco_diskgroup
WHERE
   ID = database_id |
   CLUSTERNUMBER = cluster_number DATABASENAME = database_name |
   CLUSTERNAME = cluster_name DATABASENAME = database_name |
   CLUSTERID = cluster_id DATABASENAME = database_name 

Arguments

You can modify the following attributes for the Oracle database:

  • BLOCKSIZE : Specifies the new block size for the database. The default value is 8192. This argument is not required for pluggable databases.

  • CHARSET : Specifies the new character set to use for the database. The default value is AL32UTF8. This argument is not required for pluggable databases.

  • DATADG : (Mandatory) Specifies the name of the DATA disk group for the database. This argument is not required for pluggable databases.

  • DBLANG : Specifies the new language to use for the database. The default value is all_langs. This argument is not required for pluggable databases.

  • DBNAME : (Mandatory) Specifies the name of the database.

  • DBTEMPLATE : Specifies the template to use when creating the database, ADMIN or DW. The default value is ADMIN. This argument is not required for pluggable databases.

  • DBTYPE : Specifies the type of database to create. The accepted values are normal DB, CDB, or PDB. The default value is normal DB.

  • HOSTNAMES : Specifies a comma-separated list of host names on which the database should be created. The default value is the list of nodes registered with the database home.

  • RECODG : (Mandatory) Specifies the name of the RECO disk group for the database. This argument is not required for pluggable databases.

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID of the database

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DATABASENAME : Specifies the name of the database in the cluster

4.3.6.3 DELETE DATABASE
This command deletes an existing Oracle database.

Syntax

DELETE DATABASE 
WHERE
   ID = database_id |
   CLUSTERNUMBER = cluster_number DATABASENAME = database_name |
   CLUSTERNAME = cluster_name DATABASENAME = database_name |
   CLUSTERID = cluster_id DATABASENAME = database_name 

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID of the database

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DATABASENAME : Specifies the name of the database in the cluster

Example 4-15 Deleting an Oracle Database Using OEDACLI

This example shows how to delete an existing database from the configuration.

  1. Load the OEDA XML configuration file.

    oedacli> LOAD FILE NAME=Oracle-test.xml  
    SUCCESS - file loaded OK  
    Customer : ora07adm01 - Oracle
  2. List the databases contained in the XML configuration file, so that you can identify the database ID associated with the database you want to delete.

    oedacli> LIST DATABASES
    version : "2" 
    databaseOwner : "c0_oracle" 
    databaseSid : "dbm01" 
    databaseBlockSize : "8192" 
    characterset : "AL32UTF8" 
    databaseHome : 
    id : "c0_databaseHome" 
    machines : 
    machine : 
    ..... 
    ..... 
    diskGroups : 
    diskGroup : 
    id : "c0_datadg" 
    id : "c0_recodg" 
    id : "c0_dbm01" 
    ..... 
    ..... 
    databaseHome : 
    id : "c0_databaseHome3" 
    machines : 
    machine : 
    .... 
    .... 
    databaseTemplate : "OLTP" 
    databaseStyle : "ADMIN" 
    language : "all_langs" 
    diskGroups : 
    diskGroup : 
    id : "c0_datadg" 
    id : "c0_recodg" 
    id : "c0_testdb01" 
  3. Create an action to delete the target database. Use the database id identified in the previous step

    oedacli> delete database where id='c0_testdb01'
  4. Save the action.

    oedacli> SAVE ACTION
  5. Merge all actions.

    oedacli> MERGE ACTIONS 
    processMerge  
    processMergeActions  
    Merging Action : delete database where id='c0_testdb01'  
    Merging DELETE DATABASE  
    Action Validated and Merged OK
  6. Deploy the actions into the current configuration.

    oedacli> DEPLOY ACTIONS 
    Deploying Action ID : 1 delete database where id='c0_testdb01' 
    Deploying DELETE DATABASE 
    Deleting database testdb 
    Done... 
    Done
4.3.6.4 LIST DATABASES
This command lists the existing Oracle databases.

Syntax

LIST DATABASES 
[ WHERE
   ID = database_id |
   CLUSTERNUMBER = cluster_number  |
   CLUSTERNAME = cluster_name  |
   CLUSTERID = cluster_id  ] 

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID of the database

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

4.3.7 DATABASE HOME

You can add, alter, delete, or list the Oracle database homes.

4.3.7.1 ADD DATABASEHOME
This command adds an Oracle database home to an existing cluster.

Syntax

ADD DATABASEHOME 
   OWNER = owner DBVERSION = version
   DBHOMELOC = database_home_path [DBHOMENAME = database_home_name] 
   [INVLOC = inventory_location] [DBLANG = database_language]
   [MACHINELIST = 'machine_list'] [PATCHLIST = 'patch_list']
   [BASEDIR = base_directory] [VOLUMESIZE = volume_size]
WHERE
   { CLUSTERNUMBER = cluster_number | CLUSTERNAME = cluster_name |
     CLUSTERID = cluster_id }

Arguments

You can specify the following attributes for the new Oracle database home:

  • OWNER : (Mandatory) Specifies the operating system user that owns the Oracle home.

  • DBVERSION : (Mandatory) Specifies the version of the software in the database home, including the bundle patch, for example 12.1.0.2.170418.

  • DBHOMELOC : (Mandatory) Specifies the file system path for the new Oracle database home directory.

  • DBHOMENAME : Specifies the name of the new database home. The default value is the standard template name, for example, dbhome_1.

  • INVLOC : Specifies the location of the Oracle inventory directory. The default value is derived from the cluster home.

  • DBLANG : Specifies the language to use with the Oracle home. The default value is all_langs.

  • MACHINELIST : Specifies a list of nodes to create the Oracle home on. The default value is list of nodes registered with the Grid home.

  • PATCHLIST : Specifies a comma-separated list of patches for the database home. The default value is derived from DBVERSION.

  • BASEDIR : Specifies the location of the Oracle Base directory. The default value is derived from OWNER.

  • VOLUMESIZE : Specifies the size of the home directory volume. The default value is 50 GB. This argument is applicable only for database homes for Oracle VM clusters.

The following arguments are available in the WHERE clause:

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

Example 4-16 Adding a Database Home to a Deployment using OEDACLI

This example shows how to add a new Oracle home. dbversion should specify both the base version and the target Bundle Patch version. In this example, we are setting up a new Oracle database home with 12.1.0.2 DBBP 170418. The software will be installed under /u01/app/oracle/product/12.1.0.2/dbhome_2.

./oedacli

oedacli> LOAD FILE NAME=Oracle-test12.xml
SUCCESS - file loaded OK 
Customer : ora07adm01 - Oracle

oedacli> ADD DATABASEHOME OWNER='oracle' DBVERSION='12.1.0.2.170418' DBHOMELOC='/u0
1/app/oracle/product/12.1.0.2/dbhome_2' WHERE CLUSTERNUMBER=1

oedacli> SAVE ACTION

oedacli> MERGE ACTIONS
processMerge 
processMergeActions 
Merging Action : add databasehome owner='oracle' dbversion='12.1.0.2.170418' 
dbhomeloc='/u01/app/oracle/product/12.1.0.2/dbhome_2' where clusternumber=1 
Merging ADD DATABASEHOME 
Action Validated and Merged OK

oedacli> DEPLOY ACTIONS
Deploying Action ID : 1 add databasehome owner='oracle' dbversion='12.1.0.2.170418'
 dbhomeloc='/u01/app/oracle/product/12.1.0.2/dbhome_2' where clusternumber=1 
Deploying ADD DATABASEHOME 
Checking local files.. 
Required files are: 
SUCCESS: Required file /scratch/cpabba/Oeda/main/linux-x64/WorkDir/p26022196_121020
_Linux-x86-64.zip exists... 
SUCCESS: Required file /scratch/cpabba/Oeda/main/linux-x64/WorkDir/p26027162_121020
_Linux-x86-64.zip exists... 
SUCCESS: Required file /scratch/cpabba/Oeda/main/linux-x64/WorkDir/p6880880_122010_
Linux-x86-64.zip exists... 
SUCCESS: Required file /scratch/cpabba/Oeda/main/linux-x64/WorkDir/linuxamd64_12102
_database_2of2.zip exists... 
SUCCESS: Required file /scratch/cpabba/Oeda/main/linux-x64/WorkDir/linuxamd64_12102
_database_1of2.zip exists... 
Copying required files... 
Checking status of remote files... 
Checking status of existing files on remote nodes... 
Getting status of local files... 
Copying file: linuxamd64_12102_database_1of2.zip to node node1adm01.example.com 
Copying file: linuxamd64_12102_database_2of2.zip to node node1adm01.example.com 
Copying file: p26022196_121020_Linux-x86-64.zip to node node1adm01.example.com 
Copying file: p26027162_121020_Linux-x86-64.zip to node node1adm01.example.com 
Copying file: p26022196_121020_Linux-x86-64.zip to node node1adm02.example.com 
Copying file: p26027162_121020_Linux-x86-64.zip to node node1adm02.example.com 
Completed copying files... 
Extracting files... 
Completed extracting files... 
Validating nodes for database readiness... 
Installing database software ... 
Running database installer on node node1adm01.example.com ... Please wait... 
After running database installer... 
Patching... 
Done... 
Done
4.3.7.2 ALTER DATABASEHOME
This command alters an existing Oracle database home.

Syntax

ALTER DATABASEHOME 
   OWNER = owner |
   DBVERSION = version |
   DBHOMELOC = database_home_path | 
   DBHOMENAME = database_home_name |
   INVLOC = inventory_location |
   DBLANG = language |
   MACHINELIST = 'machine_list' |
   PATCHLIST = 'patch_list'  |
   BASEDIR = base_directory 
WHERE
   ID = database_home_id | 
   CLUSTERNUMBER = cluster_number DBHOMELOC = database_home_path |
   CLUSTERNAME = cluster_name DBHOMELOC = database_home_path |
   CLUSTERID = cluster_id DBHOMELOC = database_home_path 

Arguments

You can modify the following attributes for the Oracle database home:

  • OWNER : Specifies the operating system user that owns the Oracle home.

  • DBVERSION : Specifies the version of the software in the database home, including the bundle patch, for example 12.1.0.2.170418.

  • DBHOMELOC : Specifies the file system path for the new Oracle database home directory.

  • DBHOMENAME : Specifies the new name of the database home. The database home name must be unique within a cluster.

  • INVLOC : Specifies the location of the Oracle inventory directory.

  • DBLANG : Specifies the supported languages for the Oracle home.

  • MACHINELIST : Specifies a list of nodes. The nodes must exist within the cluster.

  • PATCHLIST : Specifies a comma-separated, custom list of patches for the database home.

  • BASEDIR : Specifies the location of the Oracle Base directory.

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the database home

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DBHOMELOC : Specifies the path for the database home directory.

4.3.7.3 DELETE DATABASEHOME
This command removes an existing Oracle database home.

Syntax

DELETE DATABASEHOME 
WHERE
   ID = database_home_id | 
   CLUSTERNUMBER = cluster_number DBHOMELOC = database_home_path |
   CLUSTERNAME = cluster_name DBHOMELOC = database_home_path |
   CLUSTERID = cluster_id DBHOMELOC = database_home_path 

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the database home

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DBHOMELOC : Specifies the path for the database home directory.

Usage Notes

The database home you are deleting must not contain any dependent databases.

Example 4-17 Removing an Existing Oracle Database Home

This example shows how to delete an existing Oracle Database home directory.

oedacli> LOAD FILE NAME=Oracle-test12.xml 
SUCCESS - file loaded OK 
Customer : ora07adm01 - Oracle

oedacli> DELETE DATABASEHOME WHERE id='c0_databaseHome1' 

oedacli> SAVE ACTION 

oedacli> MERGE ACTIONS 
processMerge 
processMergeActions 
Merging Action : delete databasehome where id='c0_databaseHome1' 
Merging DELETE DATABASEHOME 
Action Validated and Merged OK 

oedacli> DEPLOY ACTIONS 
Deploying Action ID : 3 delete databasehome where id='c0_databaseHome1' 
Deploying DELETE DATABASEHOME 
Validating Oracle home.. 
Deinstalling database home c0_DbHome_1 
Unmounting file system.. 
Updating /etc/fstab entries... 
Done... 
Done
4.3.7.4 LIST DATABASEHOMES
This command lists the existing Oracle database homes.

Syntax

LIST DATABASEHOMES
[ WHERE
    ID = database_home_id | 
    CLUSTERNUMBER = cluster_number NAME = database_home_name |
    CLUSTERNAME = cluster_name NAME = database_home_name |
    CLUSTERID = cluster_id NAME = database_home_name ]

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the target database home

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • NAME : Specifies the name of the target database home

4.3.8 DISKGROUP

You can add, alter, delete, or list the Oracle ASM disk groups.

4.3.8.1 ADD DISKGROUP
This command adds an Oracle ASM disk group.

Syntax

ADD DISKGROUP 
   [ ACFSNAME=acfs_name ]
   [ ACFSPATH=acfs_path ]
   [ ACFSSIZE=acfs_size ]
   [ CELLLIST='cell_list' ]
   DISKGROUPNAME=diskgroup_name 
   DISKGROUPSIZE=diskgroup_size
   [ OCRVOTE=ocr_voting_disks_included ] 
   [ QUORUMDISK=quorum_disks_included ]
   REDUNDANCY=redundancy_level
   SLICESIZE=slice_size 
   [ SPARSE=sparse ]
   [ SPARSEVIRTUALSIZE=sparse_virtual_size ]
   [ TYPE = diskgroup_type [ DATABASENAME = database_name ]]
WHERE
   CLUSTERNUMBER = cluster_number |
   CLUSTERNAME = cluster_name |
   CLUSTERID = cluster_id 

Arguments

You can specify the following attributes for the new Oracle ASM disk group:

  • ACFSNAME : Specifies the name for the Oracle ACFS volume on this diskgroup

  • ACFSPATH : Specifies the path for the Oracle ACFS file system

  • ACFSSIZE : Specifies the size for the Oracle ACFS volume on this diskgroup

  • CELLLIST : A comma separated list of cells for this disk group, enclosed in single quotes

  • DISKGROUPNAME : (Mandatory) Specifies the name of the disk group

  • DISKGROUPSIZE : (Mandatory) Specifies the size of the disk group

  • OCRVOTE : A boolean variable, where TRUE indicates the disk group should store the OCR and voting disks for the cluster.

  • QUORUMDISK : A boolean variable, where TRUE indicates the disk group requires a quorum

  • REDUNDANCY : (Mandatory) Specifies the redundancy level for the disk group. The accepted values are NORMAL or HIGH.

  • SLICESIZE : (Mandatory) Specifies the slice size on disk for each grid disk for this disk group.

  • SPARSE : A boolean variable, where TRUE indicates this should be sparse disk group.

  • SPARSEVIRTUALSIZE : Specifies the sparse virtual size.

  • TYPE : Specifies the diskgroup type, which can be DATA, RECO, DBFS or OTHER. The default value is OTHER. If you want the database to use this disk group, then the type must be set to DATA or RECO.

  • DATABASENAME : Specifies the name of the target database for disk groups of type DATA or RECO.

The following arguments are available in the WHERE clause:

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

4.3.8.2 ALTER DISKGROUP
This command alters attributes for an existing Oracle ASM disk group.

Syntax

ALTER DISKGROUP {
   ACFSNAME=acfs_name| 
   ACFSPATH=acfs_path |
   ACFSSIZE=acfs_size |
   CELLLIST='cell_list' |
   DISKGROUPNAME=diskgroup_name | 
   DISKGROUPSIZE=diskgroup_size |
   OCRVOTE=ocr_voting_disks_included | 
   QUORUMDISK=quorum_disks_included |
   REDUNDANCY=redundancy_level |
   SLICESIZE=slice_size |
   SPARSE=sparse |
   SPARSEVIRTUALSIZE=sparse_virtual_size }
WHERE {
   ID = diskgroup_id|
   CLUSTERNUMBER = cluster_number DISKGROUPNAME = diskgroup_name|
   CLUSTERNAME = cluster_name DISKGROUPNAME = diskgroup_name|
   CLUSTERID = cluster_id DISKGROUPNAME = diskgroup_name }

Arguments

You can modify the following attributes of an Oracle ASM disk group:

  • ACFSNAME : Specifies a new name for the Oracle ACFS volume on this diskgroup

  • ACFSPATH : Specifies the new path for the Oracle ACFS file system

  • ACFSSIZE : Specifies a new size for the Oracle ACFS volume on this diskgroup

  • CELLLIST : A comma separated list of cells for this disk group, enclosed in single quotes

  • DISKGROUPNAME : Specifies a new name for the disk group

  • DISKGROUPSIZE : Specifies a new size for the disk group

  • OCRVOTE : A boolean variable, where TRUE indicates the disk group should store the OCR and voting disks for the cluster.

  • QUORUMDISK : A boolean variable, where TRUE indicates the disk group requires a quorum

  • REDUNDANCY : Specifies the redundancy level for the disk group. The accepted values are NORMAL or HIGH.

  • SLICESIZE : Specifies the slice size on disk for each grid disk for this disk group.

  • SPARSE : A boolean variable, where TRUE indicates this should be sparse disk group.

  • SPARSEVIRTUALSIZE : Specifies the sparse virtual size.

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the disk group

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DISKGROUPNAME : Specifies the name of the disk group

Usage Notes

If you modify the redundancy, the volume size will be maintained, however the slice size will be recalculated.

Example 4-18 Resizing an Oracle ASM Diskgroup Using OEDACLI

This example shows how to resize an existing Oracle ASM disk group using OEDACLI.

  1. Load the OEDA XML configuration file.

    oedacli> LOAD FILE NAME=Oracle-test.xml 
    SUCCESS - file loaded OK 
    Customer : ora07adm01 - Oracle
  2. Use the command LIST DISKGROUPS to view the disk group details.

    oedacli> LIST DISKGROUPS
    version : "PhysicalLayoutLegacy" 
    diskGroupName : "DBFS_DG" 
    redundancy : "NORMAL" 
    sliceSize : "default" 
    machines : 
    machine : 
    ... 
    ... 
    cellDisks : "ALL" 
    diskGroupSize : "436G" 
    ocrVote : "true" 
    quorumDisk : "false" 
    id : "c0_dbfsdg" 
    version : "PhysicalLayoutLegacy" 
    diskGroupName : "DATAC1" 
    redundancy : "NORMAL" 
    sliceSize : "2953G" 
    machines : 
    .. 
    .. 
    cellDisks : "ALL" 
    diskGroupSize : "53154G" 
    ocrVote : "false" 
    quorumDisk : "false" 
    id : "c0_datadg" 
    version : "PhysicalLayoutLegacy" 
    diskGroupName : "RECOC1" 
    redundancy : "NORMAL" 
    sliceSize : "ALL" 
    machines : 
    .. 
    .. 
    cellDisks : "ALL" 
    diskGroupSize : "13284G" 
    ocrVote : "false" 
    quorumDisk : "false" 
    id : "c0_recodg"
  3. Create an action for resizing the disk group.

    oedacli> ALTER DISKGROUP DISKGROUPSIZE='2500G' WHERE CLUSTERNUMBER=1 DISKGROUPN
    AME='DATAC1'
  4. Save the action.

    oedacli> SAVE ACTION
  5. Merge all actions.

    oedacli> MERGE ACTIONS
    processMerge 
    processMergeActions 
    Merging Action : alter diskgroup diskgroupsize='2500G' where diskgroupname='DAT
    AC1' clusternumber=1 
    Merging ALTER DISKGROUP
    Action Validated and Merged OK
  6. Deploy the actions.

    oedacli> DEPLOY ACTIONS 
    Deploying Action ID : 3 alter diskgroup diskgroupsize='2500G' where diskgroupna
    me='DATAC1' 
    Deploying ALTER DISKGROUP 
    Deploying Action ID : 4 alter diskgroup diskgroupsize='2500G' where diskgroupna
    me='DATAC1' clusternumber=1 
    Deploying ALTER DISKGROUP 
    Validating ASM Disk status.. 
    Disks in ASM Disk Group DATAC1 have valid status 
    Shrinking Disk Group size to 2500 GB 
    Resizing ASM Disk Group.. 
    Checking Reblance operations in disk group DATAC1 
    Rebalance operations completed in disk group DATAC1 
    Original Grid Disk Size 2953 GB, new size 138 GB on node1celadm02.example.com 
    Original Grid Disk Size 2953 GB, new size 138 GB on node1celadm03.example.com 
    Original Grid Disk Size 2953 GB, new size 138 GB on node1celadm01.example.com 
    Updated/New Disk Group size 2484 GB, original size 53154 GB. 
    Done... 
    Done
4.3.8.3 ALTER DISKGROUPS
This command alters disk group sizing attributes for existing Oracle ASM disk groups.

Syntax

ALTER DISKGROUPS 
   DATASPLIT=data_split_percent 
   RECOSPLIT=reco_split_percent
   DATAREDUNDANCY=data_redundancy_level
   RECOREDUNDANCY=reco_redundancy_level 
   SPLITDISK=percent_of_cell_disk
WHERE
   DATADG = data_diskgroup
   RECODG = reco_diskgroup 
   CLUSTERNAME = cluster_name | CLUSTERNUMBER = cluster_number | 
      CLUSTERID = cluster_id 

Arguments

You can modify the following sizing attributes of the DATA and RECO Oracle ASM disk groups:

  • DATASPLIT : Specifies a percentage of the Oracle ASM volume allocated to the DATA disk group

  • RECOSPLIT : Specifies a percentage of the Oracle ASM volume allocated to the RECO disk group

  • DATAREDUNDANCY : Specifies the redundancy level for the DATA disk group. The accepted values are NORMAL or HIGH.

  • RECOREDUNDANCY : Specifies the redundancy level for the RECO disk group. The accepted values are NORMAL or HIGH.

  • SPLITDISK : Specifies the percentage of the cell disk to allocate to the DATA and RECO disk groups. The specified value must be less an integer between 1 and 100.

The following arguments are available in the WHERE clause:

  • DATADG : Specifies the name of the DATA disk group in the cluster

  • RECODG : Specifies the name of the RECO disk group in the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

4.3.8.4 DELETE DISKGROUP
This command deletes an existing Oracle ASM disk group.

Syntax

DELETE DISKGROUP 
WHERE
   ID = diskgroup_id|
   CLUSTERNUMBER = cluster_number DISKGROUPNAME = diskgroup_name|
   CLUSTERNAME = cluster_name DISKGROUPNAME = diskgroup_name|
   CLUSTERID = cluster_id DISKGROUPNAME = diskgroup_name

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the disk group

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DISKGROUPNAME : Specifies the name of the disk group

4.3.8.5 LIST DISKGROUPS
This command lists the existing Oracle ASM disk groups.

Syntax

LIST DISKGROUPS 
[ WHERE
   ID = diskgroup_id|
   CLUSTERNUMBER = cluster_number |
   CLUSTERNAME = cluster_name |
   CLUSTERID = cluster_id ]

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the disk group

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • DISKGROUPNAME : Specifies the name of the disk group

4.3.9 ES

You can discover an engineered system or alter a limited number of attributes of an engineered system.

4.3.9.1 ALTER ES

This command alters the attributes of an engineered system.

Syntax

ALTER ES 
   PAAS = 'pass_mode' |
   CUSTOMERNAME = customer_name |
   CUSTOMERDEPT = customer_dept 

Arguments

You can modify the following attributes for the engineered system:

  • PAAS : A boolean value, TRUE or FALSE, which specifies whether to enable PaaS mode.

  • CUSTOMERNAME : Specifies the customer name.

  • CUSTOMERDEPT : Specifies the customer department.

4.3.9.2 DISCOVER ES

This command discovers an existing configuration of an engineered system.

Syntax

DISCOVER ES 
   HOSTNAMES = host_names 
   LOCATION = directory_name 

Arguments

You can use the following arguments when discovering an engineered system configuration:

  • HOSTNAMES: Specifies the list of nodes to be discovered, with each host name separated by a ',' or a space. The list must be enclosed in quotation marks, for example, 'node1,node2'

  • LOCATION: Specifies the target directory for file creation.

4.3.10 GUEST

You can clone or delete an Oracle VM guest.

4.3.10.1 CLONE GUEST

This command clones an existing Oracle VM guest and creates a fully functional new guest with storage, users, and Oracle RAC instances.

Prerequisites

Before you can clone an Oracle VM node, you must download the appropriate software images from My Oracle Support and extract the files. Place the extracted "klone.zip" files for Oracle Grid Infrastructure and Oracle Database in the /EXAVMIMAGES directory in the management domain (dom0) where the new guest clone will be created.

Note:

Creating more than 8 VMs on Exadata Database Servers is not supported.

Syntax

CLONE GUEST SRCNAME = source_guest
  [TGTNAME = target_guest 
   WHERE STEPNAME = stepname ]
SET PARENT NAME=parent_name 
  [SET ADMINNET NAME=admin_name,IP=admin_ip ]
  [SET BACKUP NAME=backup_name,IP=backup_ip ]
  SET PRIVNET NAME1=priv_name_1,IP1=priv_ip1,
              NAME2=priv_name_2,IP2=priv_ip2 
  [ SET INTERCONNECT NAME1=priv_name_1,IP1=priv_ip1,
                     NAME2=priv_name_2, IP2=priv_ip2]
  SET CLIENTNET NAME=client_name,IP=client_ip 
  SET VIPNET NAME=vip_name,IP=vip_ip

Arguments

  • SRCNAME is used to specify the name of an existing guest VM (DomU) from which the new guest VM is derived.
  • TGTNAME is used to specify the host name of the new guest VM that you are creating with the clone operation. This argument is used with the WHERE STEPNAME clause.
  • The WHERE STEPNAME clause allows you to perform individual steps of the clone operation. The value of stepname can be one of the following:
    • CREATE_GUEST
    • CREATE_USERS
    • CELL_CONNECTIVITY
    • ADD_NODE
    • EXTEND_DBHOME
    • ADD_INSTANCE
  • The SET clauses are used only when specifying CLONE GUEST with the WHERE STEPNAME = CREATE_GUEST clause or when specifying CLONE GUEST without using any WHERE STEPNAME clause. The SET clauses take the following additional arguments:
    • PARENT: Specifies the host name of the Dom0 used to host this new guest
    • ADMINNET: NAME specifies the DNS name (with domain name) and IP specifies the IP address to be used for the admin network
    • BACKUP: NAME specifies the DNS name (with domain name) and IP specifies the IP address to be used for the backup network
    • PRIVNET: NAME1 specifies the DNS name (with domain name) and IP1 specifies the IP address to be used for the first private network. NAME2 specifies the DNS name (with domain name) and IP2 specifies the IP address to be used for the second private network.
    • INTERCONNECT: NAME1 specifies the DNS name (with domain name) and IP1 specifies the IP address to be used for the first private interconnect. NAME2 specifies the DNS name (with domain name) and IP2 specifies the IP address to be used for the second private interconnect.
    • CLIENTNET: NAME specifies the DNS name (with domain name) and IP specifies the IP address to be used for the client network
    • VIPNET: NAME specifies the DNS name (with domain name) and IP specifies the IP address to be used for the VIP network

Usage Notes

  • The SET INTERCONNECT clause is only required if the compute nodes are configured with InfiniBand security (PKEYS).
  • When you load the XML configuration file to use when cloning a guest domain, the XML file should have the management domain (dom0) node of the source VM defined but not allocated to the cluster that is being extended into the guest domain.
  • You should save the modified XML file after the actions are merged so that you have a new XML file that reflects the addition of the new guest domain.

Example 4-19 Cloning a Guest VM

This example shows how to clone a new guest from an existing node in the cluster. In this example, the source node name is exa01adm01vm01.example.com and the new node is exa01adm03vm01.example.com. A series of SET commands are used to specify the configuration for the new guest VM.

The XML file loaded at the beginning of this example has the dom0 node (host01adm01.example.com) defined but not allocated to the cluster that is being extended into the guest.

oedacli> LOAD FILE NAME=exa01-pre-cloning-node3.xml
oedacli> CLONE GUEST SRCNAME='exa01adm01vm01.example.com'
oedacli> SET PARENT NAME='exa01adm03.example.com'
oedacli> SET ADMINNET NAME='exa01adm03vm01.example.com',IP='10.xxx.xx.x'
oedacli> SET CLIENTNET NAME='exa01client03vm01.example.com',IP='10.xxx.xx.x'
oedacli> SET PRIVNET NAME1='exa01adm03vm01-priv', IP1='192.168.16.8'
 NAME2='exa01adm01vm03-priv2', IP2='192.168.16.9'
oedacli> SET VIPNET NAME='exa01client03m01-vip.example.com', IP='10.xxx.xx.x'
oedacli> SAVE ACTION
oedacli> MERGE ACTIONS
oedacli> SAVE FILE NAME='exa01-cloned-node3-rac.xml'
oedacli> DEPLOY ACTIONS
4.3.10.2 DELETE GUEST

This command deletes an existing Oracle VM guest, and removes all of its configuration: instances, software installations, storage, and users from the cluster.

Syntax

DELETE GUEST WHERE SRCNAME = node_name
      [STEPNAME = stepname ]

Arguments

  • SRCNAME is used to specify the host name of an existing DomU that you want to delete.

  • The WHERE STEPNAME clause allows you to undo individual steps of the clone operation.

    The value of stepname can be one of the following:

    • CREATE_GUEST
    • CREATE_USERS
    • CELL_CONNECTIVITY
    • ADD_NODE
    • EXTEND_DBHOME
    • ADD_INSTANCE

    When used with DELETE GUEST, the STEPNAME clauses should be used in the reverse order of CLONE GUEST steps, and you should not skip any steps. For example, if you want to undo the ADD_NODE and ADD_INSTANCE steps, you would use the following commands:

    DELETE GUEST WHERE SRCNAME = node_name STEPNAME=ADD_INSTANCE
    DELETE GUEST WHERE SRCNAME = node_name STEPNAME=EXTEND_DBHOME
    DELETE GUEST WHERE SRCNAME = node_name STEPNAME=ADD_NODE

4.3.11 ILOM

You can alter or list the ILOMS in the loaded es.xml file.

4.3.11.1 ALTER ILOM
This command alters attributes of an ILOM.

Syntax

ALTER ILOM { DNSSERVERS='dns_servers' | NTPSERVERS= 'ntp_servers' |
   TIMEZONE = timezone } 
WHERE { 
   ID = ilom_id | 
   HOSTNAME = hostname |
   ILOMNAME = ilom_hostname } 

Arguments

You can specify the following attributes for the ILOM:

  • DNSSERVERS : Specifies a comma-separated list of DNS servers that is enclosed in single quotes.

  • NTPSERVERS : Specifies a comma-separated list of NTP servers that is enclosed in single quotes.

  • TIMEZONE : Specifies a valid time zone for the ILOM.

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the target ILOM

  • HOSTNAME : Specifies the current host name of the target machine

  • ILOMNAME : Specifies the current host name of the ILOM

4.3.11.2 LIST ILOMS
This command lists the ILOMs in the es.xml file.

Syntax

LIST ILOMS 
[ WHERE { 
   ID = ilom_id | 
   HOSTNAME = hostname |
   ILOMNAME = ilom_hostname } ] 

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the target ILOM

  • HOSTNAME : Specifies the current host name of the target machine

  • ILOMNAME : Specifies the current host name of the ILOM

Usage Notes

If you do not specify a WHERE clause, then this command lists all the ILOMs in the es.xml file.

4.3.12 MACHINE

You can alter or list the machines in the es.xml file.

4.3.12.1 ALTER MACHINE
This command alters attributes of a compute node or storage cell in an engineered system.

Syntax

ALTER MACHINE { DNSSERVERS='dns_servers' | GATEWAYADAPTER=gateway_adapter | 
   HOSTNAMEADAPTER=hostname_adapter | NTPSERVERS= 'ntp_servers' |
   TIMEZONE = timezone } 
WHERE { 
   ID = machine_id | 
   HOSTNAME = hostname |
   CLUSTERNUMBER = cluster_number COMPUTENUMBER = compute_number |
   CLUSTERNUMBER = cluster_number STORAGENUMBER = storage_number |
   CLUSTERNAME = cluster_name COMPUTENUMBER = compute_number |
   CLUSTERNAME = cluster_name STORAGENUMBER = storage_number |
   CLUSTERID = cluster_id COMPUTENUMBER = compute_number |
   CLUSTERID = cluster_id STORAGENUMBER = storage_number } 

Arguments

You can specify the following attributes for the machine:

  • DNSSERVERS : Specifies a comma-separated list of DNS servers that is enclosed in single quotes.

  • GATEWAYADAPTER : Specifies the network adapter to use as the machine gateway. Valid values are ADMIN or CLIENT.

  • HOSTNAMEADAPTER : Specifies the network adapter to use as the host name. Valid values are ADMIN or CLIENT.

  • NTPSERVERS : Specifies a comma-separated list of NTP servers that is enclosed in single quotes.

  • TIMEZONE : Specifies a valid time zone for the machine.

The following arguments are available in the WHERE clause:

  • ID : Specifies the es.xml ID for the target machine

  • HOSTNAME : Specifies the current host name of the target machine

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • COMPUTENUMBER : Specifies the compute node number in the cluster, starting at 1

  • STORAGENUMBER : Specifies the storage cell number in the cluster, starting at 1

4.3.12.2 LIST MACHINES
This command lists the machine available in the es.xml file for an engineered system.

Syntax

LIST MACHINES  
{ WHERE  
   TYPE = type |
   ID = machine_id [ TYPE = type ] | 
   CLUSTERNUMBER = cluster_number [ TYPE = type ] |
   CLUSTERNAME = cluster_name [ TYPE = type ] |
   CLUSTERID = cluster_id [ TYPE = type ] }

Arguments

The following arguments are available in the WHERE clause:

  • TYPE : Specifies the machine type. The valid values are COMPUTE, CELL, STORAGE, DOM0, GUEST, or DOMU.

  • ID : Specifies the es.xml ID for an individual machine

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

Usage Notes

If you do not specify a WHERE clause, then this command lists all the machines defined in the es.xml file.

4.3.13 NETWORK

You can add, alter, delete, or list the networks defined in the XML configuration file.

4.3.13.1 ADD NETWORK
This command adds a network record to a machine in the existing configuration.

Syntax

ADD NETWORK 
   NETWORKTYPE=network_type HOSTNAME=hostname IP=ip_addr 
   NETMASK=netmask DOMAINNAME=domain_name MASTER=master 
   [ GATEWAY=gateway] [ SSHENABLED=ssh_enabled ] [ MAC=mac_addr ]
   [ NICSPEED=nic_speed [ SLAVE='slave'] [ PKEY=pkey ] 
   [ PKEYNAME=pkey_name ] [ STATUS = status ] [ LACP=lacp ]
   [ VLANID=vlan_id ] [ NATHOSTNAME=nat_host_name ] [ NATIP=nat_ip_addr ]
   [ NATDOMAINNAME=nat_domain_name ] [ NATNETMASK=nat_mask ] 
WHERE {
   HOSTNAME = hostname | 
   CLUSTERNAME = cluster_name COMPUTENUMBER=compute_number | 
   CLUSTERNAME = cluster_name STORAGENUMBER=storage_number | 
   CLUSTERNUMBER = cluster_number COMPUTENUMBER=compute_number |
   CLUSTERNUMBER = cluster_number STORAGENUMBER=storage_number }  

Arguments

You can specify the following attributes when adding a network:

  • NETWORKTYPE : (Mandatory) Specifies the type of network, which can be ADMIN, CLIENT, BACKUP, PRIVATE, OTHER, INGESTVIP, REPLICATIONVIP, or ILOM.

  • HOSTNAME : (Mandatory) Specifies the short host name for the network

  • IP : (Mandatory) Specifies the IP address of the network

  • NETMASK : (Mandatory) Specifies the netmask of the network

  • DOMAINNAME : (Mandatory) Specifies the domain name of the network

  • MASTER : (Mandatory) Specifies the master adapter name

  • GATEWAY : Specifies the network subnet gateway

  • SSHENABLED : A Boolean variable where TRUE indicates SSH should be enabled for this adapter

  • MAC : Specifies the MAC address

  • NICSPEED : (Only for X7 2 or later socket compute nodes), either 10000 or 25000

  • SLAVE : Specifies a space-separated list of slave devices for a bonded network, enclosed in single quotes

  • PKEY : (For Private networks only) Specifies the pkey

  • PKEYNAME : (For Private networks only) Specifies the pkey name

  • STATUS : Specifies the status of the network

  • LACP : A Boolean variable where TRUE indicates that LACP should be enabled

  • VLANID : Specifies the VLAN Id if network is a VLAN network and not private

  • NATHOSTNAME : Specifies the NAT host name

  • NATIP : Specifies the NAT IP address

  • NATDOMAINNAME : Specifies the NAT domain name

  • NATNETMASK : Specifies the NAT netmask

The following arguments are available in the WHERE clause:

  • HOSTNAME : Specifies the host name for an existing compute node

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of an existing cluster

  • COMPUTENUMBER : Specifies the number of an existing compute node in the cluster, starting at 1

  • STORAGENUMBER : Specifies the umber of an existing storage cell in the cluster, starting at 1

4.3.13.2 ALTER NETWORK
This command modifies a network record for a machine in the existing configuration.

Syntax

ALTER NETWORK { 
   [ HOSTNAME=hostname ] [ IP=ip_addr ] [ NETMASK=netmask ]
   [ DOMAINNAME=domain_name] [ MASTER=master] [ GATEWAY=gateway] 
   [ SSHENABLED=ssh_enabled ] [ MAC=mac_addr ] [ NICSPEED=nic_speed]
   [ SLAVE='slave'] [ PKEY=pkey ] [ PKEYNAME=pkey_name ]
   [ STATUS = status ] [ LACP=lacp ] [ VLANID=vlan_id ]
   [ NATHOSTNAME=nat_host_name ] [ NATIP=nat_ip_addr ]
   [ NATDOMAINNAME=nat_domain_name ] [ NATNETMASK=nat_mask ] } 
WHERE {
   ID = network_id |  
   NETWORKHOSTNAME = network_hostname | 
   NATHOSTNAME = nat_hostname |
   HOSTNAME = hostname NETWORKTYPE = network_type [PRIVATEID=private_id]|
   CLUSTERNAME = cluster_name { COMPUTENUMBER=compute_number | STORAGENUMBER=storage_number }
     NETWORKTYPE = network_type [PRIVATEID=private_id] | 
   CLUSTERNUMBER = cluster_number { COMPUTENUMBER=compute_number | STORAGENUMBER=storage_number }
     NETWORKTYPE = network_type [PRIVATEID=private_id] }

Arguments

You can specify the following attributes when altering a network:

  • HOSTNAME : Specifies the short host name for the network

  • IP : Specifies the IP address of the network

  • NETMASK : Specifies the netmask of the network

  • DOMAINNAME : Specifies the domain name of the network

  • MASTER : Specifies the master adapter name

  • GATEWAY : Specifies the network subnet gateway

  • SSHENABLED : A Boolean variable where TRUE indicates SSH should be enabled for this adapter

  • MAC : Specifies the MAC address

  • NICSPEED : (Only for X7 2 socket compute nodes), either 10000 or 25000

  • SLAVE : Specifies a space-separated list of slave devices for a bonded network, enclosed in single quotes

  • PKEY : (For Private networks only) Specifies the pkey

  • PKEYNAME : (For Private networks only) Specifies the pkey name

  • STATUS : Specifies the status of the network

  • LACP : A Boolean variable where TRUE indicates that LACP should be enabled

  • VLANID : Specifies the VLAN Id if network is a VLAN network and not private

  • NATHOSTNAME : Specifies the NAT host name

  • NATIP : Specifies the NAT IP address

  • NATDOMAINNAME : Specifies the NAT domain name

  • NATNETMASK : Specifies the NAT netmask

The following arguments are available in the WHERE clause:

  • ID : Specifies the ID for the target network in the XML configuration file.

  • NETWORKHOSTNAME : Specifies the host name for an network object, not the machine host name

  • NATHOSTNAME : Specifies the NAT host name for an existing compute node

  • HOSTNAME : Specifies the host name for an existing compute node

  • NETWORKTYPE : Specifies the type of network, which can be ADMIN, CLIENT, BACKUP, PRIVATE, OTHER, INGESTVIP, REPLICATIONVIP, or ILOM.

  • PRIVATEID : Specifies the ID of the private network

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERNAME : Specifies the name of an existing cluster

  • COMPUTENUMBER : Specifies the number of an existing compute node in the cluster, starting at 1

  • STORAGENUMBER : Specifies the number of an existing storage cell in the cluster, starting at 1

4.3.13.3 DELETE NETWORK
This command removes a network record for a machine.

Syntax

DELETE NETWORK 
WHERE {
   ID = network_id |  
   HOSTNAME = network_hostname NETWORKTYPE = network_type | 
   CLUSTERNAME = cluster_name { COMPUTENUMBER=compute_number | 
     STORAGENUMBER=storage_number } NETWORKTYPE = network_type |
   CLUSTERNUMBER = cluster_number { COMPUTENUMBER=compute_number | 
     STORAGENUMBER=storage_number } NETWORKTYPE = network_type |
   CLUSTERID = cluster_id { COMPUTENUMBER=compute_number | 
     STORAGENUMBER=storage_number } NETWORKTYPE = network_type }

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the ID for the network object in the XML configuration file.

  • HOSTNAME : Specifies the host name for an existing compute node

  • NETWORKTYPE : Specifies the type of network, which can be ADMIN, CLIENT, BACKUP, PRIVATE, OTHER, INGESTVIP, REPLICATIONVIP, or ILOM.

  • CLUSTERNAME : Specifies the name of an existing cluster

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERID : Specifies the cluster ID in the XML configuration file

  • COMPUTENUMBER : Specifies the number of an existing compute node in the cluster, starting at 1

  • STORAGENUMBER : Specifies the number of an existing storage cell in the cluster, starting at 1

4.3.13.4 LIST NETWORKS
This command lists the network details.

Syntax

LIST NETWORKS 
[ WHERE {
   ID = network_id |  
   HOSTNAME = network_hostname [ NETWORKTYPE = network_type ] | 
   CLUSTERNAME = cluster_name { COMPUTENUMBER=compute_number | 
     STORAGENUMBER=storage_number } [ NETWORKTYPE = network_type ] |
   CLUSTERNUMBER = cluster_number { COMPUTENUMBER=compute_number | 
     STORAGENUMBER=storage_number } [ NETWORKTYPE = network_type ] }   CLUSTERID = cluster_ID { COMPUTENUMBER=compute_number | 
     STORAGENUMBER=storage_number } [ NETWORKTYPE = network_type ] } ]

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the ID for the network object in the XML configuration file.

  • HOSTNAME : Specifies the host name for an existing compute node

  • NETWORKTYPE : Specifies the type of network, which can be ADMIN, CLIENT, BACKUP, PRIVATE, or ILOM.

  • CLUSTERNAME : Specifies the name of an existing cluster

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERID : Specifies the cluster ID in the XML configuration file

  • COMPUTENUMBER : Specifies the number of an existing compute node in the cluster, starting at 1

  • STORAGENUMBER : Specifies the number of an existing storage cell in the cluster, starting at 1

4.3.14 SCAN

You can add, alter, delete, or list the SCANs for a cluster.

4.3.14.1 ADD SCAN
This command adds a SCAN to the an individual cluster.

Syntax

ADD SCAN SCANNAME=scan_name [ SCANPORT=scan_port ] SCANIPS='scan_ip_addrs'
WHERE
 {   CLUSTERNAME = cluster_name |
     CLUSTERNUMBER = cluster_number |
     CLUSTERID = cluster_id }

Arguments

You can specify the following attributes for the new SCAN:

  • SCANNAME : Specifies the DNS name for the SCAN

  • SCANPORT : Specifies the port for the SCAN. The default value is 1521.

  • SCANIPS : A comma-separated list of IP addresses for the SCAN, enclosed in single quotes.

The following arguments are available in the WHERE clause:

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERID : Specifies the ID of the cluster in the XML configuration file

4.3.14.2 ALTER SCAN
This command modifies the attributes of a SCAN for an individual cluster.

Syntax

ALTER SCAN { SCANNAME=scan_name | SCANPORT=scan_port | SCANIPS='scan_ip_addrs' }
 WHERE
 {   CLUSTERNAME = cluster_name |
     CLUSTERNUMBER = cluster_number |
     CLUSTERID = cluster_id }

Arguments

You can modify the following attributes for the SCAN:

  • SCANNAME : Specifies the DNS name for the SCAN

  • SCANPORT : Specifies the port for the SCAN.

  • SCANIPS : A comma-separated list of IP addresses for the SCAN, enclosed in single quotes.

The following arguments are available in the WHERE clause:

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERID : Specifies the ID of the cluster in the XML configuration file

4.3.14.3 DELETE SCAN
This command removes a SCAN for an individual cluster.

Syntax

DELETE SCAN 
 WHERE
 {   CLUSTERNAME = cluster_name |
     CLUSTERNUMBER = cluster_number |
     CLUSTERID = cluster_id }

Arguments

The following arguments are available in the WHERE clause:

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERID : Specifies the ID of the cluster in the XML configuration file

4.3.14.4 LIST SCANS
This command lists the SCAN details for all clusters or for an individual cluster.

Syntax

LIST SCANS 
[ WHERE
 {   SCANID = scan_id | 
     CLUSTERNAME = cluster_name |
     CLUSTERNUMBER = cluster_number |
     CLUSTERID = cluster_id } ]

Arguments

The following arguments are available in the WHERE clause:

  • SCANID : Specifies the ID of the SCAN object in the XML configuration file

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERID : Specifies the ID of the cluster in the XML configuration file

Usage Notes

If you do not specify a WHERE clause, then this command lists details about all the SCANS for all the clusters in the XML configuration file.

4.3.15 SWITCH

You can alter or list the switches.

4.3.15.1 ALTER SWITCH
This command alters attributes of an individual switch.

Syntax

ALTER SWITCH { DNSSERVERS='dns_servers' | NTPSERVERS= 'ntp_servers' |
   TIMEZONE = timezone } 
WHERE { 
   ID = switch_id | 
   HOSTNAME = switch_name }

Arguments

You can modify the following attributes for a switch:

  • DNSSERVERS : Specifies a comma-separated list of DNS servers that is enclosed in single quotes.

  • NTPSERVERS : Specifies a comma-separated list of NTP servers that is enclosed in single quotes.

  • TIMEZONE : Specifies a valid time zone for the switch.

The following arguments are available in the WHERE clause:

  • ID : Specifies the switch ID in the XML configuration file

  • HOSTNAME : Specifies the host name of the switch

4.3.15.2 LIST SWITCHES
This command lists the switch details for all switches or for an individual switch.

Syntax

LIST SWITCHES 
[ WHERE { 
   ID = switch_id | 
   HOSTNAME = switch_name } ]

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the switch ID in the XML configuration file

  • HOSTNAME : Specifies the host name of the switch

Usage Notes

If you do not specify a WHERE clause, then this command lists the details for all switches.

4.3.16 VIP

You can add, alter, delete, or list the VIPs for the clusters.

4.3.16.1 ADD VIP
This command adds a VIP for an individual node in a cluster.

Purpose

This command does not add additional VIPs. You should only use this command after previously issuing a DELETE VIP command.

Syntax

ADD VIP NAME=vip_name DOMAINNAME=domain_name IP=vip_ip_addr 
WHERE { 
   HOSTNAME = hostname |
   CLUSTERNAME = cluster_name COMPUTENUMBER = compute_number |
   CLUSTERNUMBER = cluster_number COMPUTENUMBER = compute_number |
   CLUSTERID = cluster_id COMPUTENUMBER = compute_number }

Arguments

You can specify the following attributes when adding a VIP:

  • NAME : Specifies the short DNS name for the VIP

  • DOMAINNAME : Specifies the domain name for the VIP

  • IP : Specifies the IP address for the VIP

The following arguments are available in the WHERE clause:

  • HOSTNAME : Specifies the host name for the compute node in the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • COMPUTENUMBER : Specifies the compute node number in the cluster, starting at 1

Usage Notes

When adding a VIP to a compute node, the node must not already have a VIP defined.

4.3.16.2 ALTER VIP
This command alters the attributes of a VIP for an individual node in a cluster.

Syntax

ALTER VIP { NAME=vip_name | DOMAINNAME=domain_name | 
   IP=vip_ip_addr } 
WHERE { 
   HOSTNAME = hostname |
   CLUSTERNAME = cluster_name COMPUTENUMBER = compute_number |
   CLUSTERNUMBER = cluster_number COMPUTENUMBER = compute_number |
   CLUSTERID = cluster_id COMPUTENUMBER = compute_number }

Arguments

You can modify the following attributes for the VIP:

  • NAME : Specifies the short DNS name for the VIP

  • DOMAINNAME : Specifies the domain name for the VIP

  • IP : Specifies the IP address for the VIP

The following arguments are available in the WHERE clause:

  • HOSTNAME : Specifies the host name for the compute node in the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the es.xml, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the es.xml ID of the cluster

  • COMPUTENUMBER : Specifies the compute node number in the cluster, starting at 1

4.3.16.3 DELETE VIP
This command removes a VIP from an individual node in a cluster.

Syntax

DELETE VIP  
WHERE { 
   ID = vip_id |
   HOSTNAME = hostname |
   CLUSTERNAME = cluster_name COMPUTENUMBER = compute_number |
   CLUSTERNUMBER = cluster_number COMPUTENUMBER = compute_number |
   CLUSTERID = cluster_id COMPUTENUMBER = compute_number }

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the ID for the VIP in the XML configuration file

  • HOSTNAME : Specifies the host name for the compute node in the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the ID of the cluster in the XML configuration file

  • COMPUTENUMBER : Specifies the compute node number in the cluster, starting at 1

4.3.16.4 LIST VIPS
This command lists the VIPs for all clusters or for an individual node in a cluster.

Syntax

LIST VIPS  
[ WHERE { 
   HOSTNAME = hostname |
   CLUSTERNAME = cluster_name [ COMPUTENUMBER = compute_number ] |
   CLUSTERNUMBER = cluster_number [ COMPUTENUMBER = compute_number ] |
   CLUSTERID = cluster_id [ COMPUTENUMBER = compute_number ] }

Arguments

The following arguments are available in the WHERE clause:

  • ID : Specifies the ID for the VIP in the XML configuration file

  • HOSTNAME : Specifies the host name for the compute node in the cluster

  • CLUSTERNUMBER : Specifies the cluster number in the XML configuration file, starting at 1

  • CLUSTERNAME : Specifies the name of the cluster

  • CLUSTERID : Specifies the ID of the cluster in the XML configuration file

  • COMPUTENUMBER : Specifies the compute node number in the cluster, starting at 1

Usage Notes

If you do not specify a WHERE clause, then this command lists the VIPs for all clusters.