Review this section to understand the odacli create-appliance command and see an example JSON file.
Topics:
Use the readme and example JSON file to create a JSON file to use the command-line interface to create the appliance.
Readme
Review this readme carefully along with the provided JSON example files. Create a JSON file with the necessary changes based on your environment and requirements. The examples on this page and the readme are also located in the /opt/oracle/dcs/sample directory.
Note:
It is important to review the readme and the examples carefully before creating your JSON file. If you do not enter your network and Oracle ILOM information correctly based on your setup, you will lose network access to both the host and Oracle ILOM.Definitions
instance:
name: display name for the appliance instance resource
instanceBaseName: This is the base name used for the service to derive the names for the other entities
dbEdition: Enter "EE" for enterprise edition, or "SE" for standard edition
timeZone: OS timeZone
ntpServers: IP address for ntp server configured in /etc/ntp.conf, enter null if NTP is not configured
dnsServers: IP address for DNS server configured in /etc/resolv.conf, enter null if dns is not configured.
domainName: domain name (for example, example.com)
isRoleSeperated: true|false
set isRoleSeperated=true if role separation is required during the installation.
need to specify 6 groups and two users. groupName and userName can be customized
Set isRoleSeperated=false if role separation is not required.
Need to specify 2 groups and one user. groupName and userName can be customized
nodes:
nodeNumber: 0 (Use 0 for ODA S|M|L)
nodeName: the Name used to configure the host name.
network:
nicName: the NIC name used for the network.
For ODA S: btbond1, sfpbond1
For ODA M: btbond1, btbond2, sfpbond1
For ODA L: btbond1, btbond2, sfpbond1
ipAddress: IP address for this network
subNetMask: subnet mask for this network
gateway: gateway address for this network
networkType: Public|Backup|Other
isDefaultNetwork: true|false
ilom:
ilomName: ilom name
ipAddress: ilom ip address
subNetMask: subnet mask for the ilom network
gateway: gateway for ilom network
grid:
diskGroup: (ODA S|M|L contains DATA and RECO Diskgroups)
diskgroupName: DATA|RECO
redundancy: Normal|High (for 2 NVMEs, only Normal is supported, for 4 NVMEs, both Normal and High is supported)
diskPercentage: Percentage of NVMe drive capacity is used for this particular diskgroup.
language: language used for GI installation
database:
dbName: dbname for the database
dbVersion: Use "12.1.0.2" for 12c database, "11.2.0.4" for 11.2 database.
instanceOnly:
true: only database instance is created without any data files
false: create a complete database (with datafiles, redo logs, etc)
isCdb: "true" if this database is container DB. Only valid for 12.1.0.2 database. "False" if this is non-cdb
pdBName: pdbName if isCdb is "true", use "null" if isCdb is "false"
pdbAdminuserName: pdb admin user name, use "null" if isCdb is "false"
adminPassword: master password for the database.
dbType: use "SI" , single instance database for ODA S|M|L
dbTargetNodeNumber: use "0" for ODA S|M
dbClass: OLTP|DSS|IMDB. For SE, only OLTP is supported. For EE, OLTP, DSS, IMDB(12c db only) are supported
dbShape: database shape, decide which database template to use for this database.
dbStorage: ACFS|ASM. Only ACFS is supported for 11.2.0.4. Both ACFS and ASM are supported for 12.1.0.2.
dbCharacterSet: Characterset for this database.
dbConsoleEnable: true|false. Whether or not to create dbconsole (11.2.0.4) or EM express (12.1.0.2)
asr:
userName/password: username/password for the ASR
proxyServerName/proxyPort/proxyUserName/proxyPassword: information about proxy server.
snmpVersion: use "v3"
Use these JSON file examples and the readme to create a JSON file that you can use to create the appliance with the command-line interface.
You must create a JSON file to use the odacli create-appliance command. You can use the example JSON files that are located here and the information located in the readme as a template to create a file for your environment. The examples on this page and the readme are also located in the /opt/oracle/dcs/sample directory.
Note:
It is important to review the readme and the examples carefully before creating your JSON file. If you do not enter your network and Oracle ILOM information correctly based on your setup, then network access is lost to both the host and Oracle ILOM.Example C-1 JSON File to Create an Oracle Database Appliance X6-2 with Role Separation
The following is an example of a JSON file that creates an Oracle Database Appliance X6-2S, X6-2M, or X6-2L. The example uses role separation.
$ cat create-appliance.json
{
"instance" : {
"name" : "odambox",
"instanceBaseName" : "odambox",
"dbEdition" : "EE",
"timeZone" : "UTC",
"ntpServers" : ["10.0.3.14"],
"dnsServers" : ["10.0.4.10","10.0.4.11","10.0.4.12"],
"domainName" : "example.com",
"isRoleSeparated" : true,
"osUserGroup" : {
"groups" : [ {
"groupId" : 1001,
"groupName" : "oinstall",
"groupRole" : "oinstall"
}, {
"groupId" : 1002,
"groupName" : "dbaoper",
"groupRole" : "dbaoper"
}, {
"groupId" : 1003,
"groupName" : "dba",
"groupRole" : "dba"
}, {
"groupId" : 1004,
"groupName" : "asmadmin",
"groupRole" : "asmadmin"
}, {
"groupId" : 1005,
"groupName" : "asmoper",
"groupRole" : "asmoper"
}, {
"groupId" : 1006,
"groupName" : "asmdba",
"groupRole" : "asmdba"
} ],
"users" : [ {
"userId" : 1000,
"userName" : "oracle",
"userRole" : "oracleUser"
}, {
"userId" : 1001,
"userName" : "grid",
"userRole" : "gridUser"
} ]
}
},
"nodes" : [ {
"nodeNumber" : "0",
"nodeName" : "odambox",
"network" : [ {
"nicName" : "btbond1",
"ipAddress" : "10.0.1.11",
"subNetMask" : "255.255.255.0",
"gateway" : "10.0.1.1",
"networkType" : [ "Public" ],
"isDefaultNetwork" : true
},
{
"nicName" : "btbond2",
"ipAddress" : "192.168.18.24",
"subNetMask" : "255.255.255.0",
"gateway" : "192.168.18.1",
"networkType" : [ "Backup" ],
"isDefaultNetwork" : false
}
],
"ilom" : {
"ilomName":"odambox-c",
"ipAddress":"10.0.2.10",
"subNetMask":"255.255.255.0",
"gateway":"10.0.2.1"
}
} ],
"grid" : {
"diskGroup" : [ {
"diskGroupName" : "DATA",
"redundancy" : "NORMAL",
"diskPercentage" :70
}, {
"diskGroupName" : "RECO",
"redundancy" : "NORMAL",
"diskPercentage" :30
} ],
"language" : "en"
},
"database" : {
"dbName" : "db1",
"dbVersion" : "12.1.0.2",
"instanceOnly" : false,
"isCdb" : true,
"pdBName" : "pdb1",
"pdbAdminuserName" : "pdbuser",
"adminPassword" : "welcome1",
"dbType" : "SI",
"dbTargetNodeNumber" : "0",
"dbClass" : "OLTP",
"dbShape" : "odb1",
"dbStorage" : "ACFS",
"dbCharacterSet" : {
"characterSet" : "AL32UTF8",
"nlsCharacterset" : "AL16UTF16",
"dbTerritory" : "AMERICA",
"dbLanguage" : "AMERICAN"
},
"dbConsoleEnable" : false
},
"asr" :{
"userName":"john.smith@example.com",
"password":"xxxxx",
"proxyServerName":"www-proxy.example.com",
"proxyPort":"80",
"proxyUserName":"",
"proxyPassword":"",
"snmpVersion":"v3"
}
}
Example C-2 JSON File to Create an Oracle Database Appliance X6-2 without Role Separation
The following is an example of a JSON file that creates an Oracle Database Appliance X6-2S, X6-2M, or X6-2L without using role separation. This example creates two groups (oinstall and dba) and one user ("oracle").
$ cat create-appliance.json
{
"instance" : {
"name" : "odambox",
"instanceBaseName" : "odambox",
"dbEdition" : "EE",
"timeZone" : "UTC",
"ntpServers" : ["10.0.3.14"],
"dnsServers" : ["10.0.4.10","10.0.4.11","10.0.4.12"],
"domainName" : "example.com",
"isRoleSeparated" : false,
"osUserGroup" : {
"groups" : [ {
"groupId" : 1001,
"groupName" : "oinstall",
"groupRole" : "oinstall"
}, {
"groupId" : 1002,
"groupName" : "dba",
"groupRole" : "dba"
} ],
"users" : [ {
"userId" : 1000,
"userName" : "oracle",
"userRole" : "oracleUser"
} ]
}
},
"nodes" : [ {
"nodeNumber" : "0",
"nodeName" : "odambox",
"network" : [ {
"nicName" : "btbond1",
"ipAddress" : "10.0.1.11",
"subNetMask" : "255.255.255.0",
"gateway" : "10.0.1.1",
"networkType" : [ "Public" ],
"isDefaultNetwork" : true
},
{
"nicName" : "btbond2",
"ipAddress" : "192.168.18.24",
"subNetMask" : "255.255.255.0",
"gateway" : "192.168.18.1",
"networkType" : [ "Backup" ],
"isDefaultNetwork" : false
}
],
"ilom" : {
"ilomName":"odambox-c",
"ipAddress":"10.0.2.10",
"subNetMask":"255.255.255.0",
"gateway":"10.0.2.1"
}
} ],
"grid" : {
"diskGroup" : [ {
"diskGroupName" : "DATA",
"redundancy" : "NORMAL",
"diskPercentage" :70
}, {
"diskGroupName" : "RECO",
"redundancy" : "NORMAL",
"diskPercentage" :30
} ],
"language" : "en"
},
"database" : {
"dbName" : "db1",
"dbVersion" : "12.1.0.2",
"instanceOnly" : false,
"isCdb" : true,
"pdBName" : "pdb1",
"pdbAdminuserName" : "pdbuser",
"adminPassword" : "welcome1",
"dbType" : "SI",
"dbTargetNodeNumber" : "0",
"dbClass" : "OLTP",
"dbShape" : "odb1",
"dbStorage" : "ACFS",
"dbCharacterSet" : {
"characterSet" : "AL32UTF8",
"nlsCharacterset" : "AL16UTF16",
"dbTerritory" : "AMERICA",
"dbLanguage" : "AMERICAN"
},
"dbConsoleEnable" : false
},
"asr" :{
"userName":"john.smith@example.com",
"password":"xxxxx",
"proxyServerName":"www-proxy.example.com",
"proxyPort":"80",
"proxyUserName":"",
"proxyPassword":"",
"snmpVersion":"v3"
}
}