FPP Setup Automation

With FPP Setup Automation you can setup and provision an FPP server of client while provisioning new Grid Infrastructure or on existing Grid Infrastructure.

You will need to provision both an FPP server and client, in these examples you can see sample commands to provision both server and client in new Grid Infrastructure or into existing Grid Infrastructure through Enterprise Manager

Note:

This method is currently supported for 19c releases only.

List of Variables Used for Provisioning FPP Server and Client

List of supported variables for FPP server provisioning:

Variable Required Description
TARGET_NAME Yes Specify the cluster target name in EM to set up the FPP Client
NORMAL_USER Yes Specify the named credentials for the user who owns the Grid Infrastructure home (Credential Name:Owner).
ROOT_USER Yes Specify the named credentials for the privileged user (Credential Name:Owner). In the event that you do not have root access, the procedure will require manual intervention to run the root scripts.
FPP_DISK_GROUP Yes Specify the disk group that FPP Server can use to store the software images. Oracle recommends a minimum of 100 GB for this disk group.
FPP_IMAGES_MOUNTPOINT Yes Provide a mount path that exists on all nodes of the cluster. The FPP Server uses this path to mount gold images.
REST_USER_NAME Yes Specify the REST user name to be created on the FPP server. This REST user will be registered and used by Enterprise Manager to communicate with the FPP Server.
REST_USER_PASSWORD Yes Specify the password for the REST user to be created.
REST_USER_EMAIL Yes Specify the email for the REST user.
CONFIGURE_GIMR Optional For 19c database releases, Fleet Patching and Provisioning server setup requires Grid Infrastructure Management Repository (GIMR) as a prerequisite. This procedure will setup GIMR if it is not already set up.

Options: true/false.
GIMR_DISK_GROUP Optional Specify the disk group for the Grid Infrastructure Management Repository. If it is not provided, it will be configured with the same disk group as the Oracle Clusterware files.
CONFIGURE_GNS Optional Grid Naming Service is required as a prerequisite to setting up the Fleet Patching and Provisioning server. Options: true/false.
GNS_VIP_ADDRESS Optional The Grid Naming Service (GNS) virtual IP address is required as a prerequisite to setting up the Fleet Patching and Provisioning Server. GNS will be created if it does not already exist.
REFERENCE_HOST Optional Specify the node on which to perform the FPP setup. If not specified, any one of the nodes in the cluster will be automatically chosen.
WORKING_DIRECTORY Optional Specify the working directory path to stage the required binaries for execution. By default, it will use the agent stage directory.
MIN_HEAP_SIZE Optional Specify the minimum heap size to be configured for the FPP server. Supported formats in gigabytes. (Ex: 3G)
MAX_HEAP_SIZE Optional Specify the maximum heap size to be configured for the FPP server. Supported formats in gigabytes. (Ex: 5G)
PREREQS_ONLY Optional Only run the prerequisite checks to verify readiness to setup the FPP server.

Options: true/false (default: false).

List of supported variables for FPP client provisioning:

Variable Required Description
TARGET_NAME Yes Specify the cluster target name in EM to set up the FPP server.
NORMAL_USER Yes Specify the named credentials for the user who owns the Grid Infrastructure home (Credential Name:Owner).
ROOT_USER Yes Specify the named credentials for the privileged user (Credential Name:Owner). In the event that you do not have root access, the procedure will require manual intervention to run the root scripts.
FPP_SERVER_TARGET_NAME Yes Specify the cluster target name in EM which is already registered as an FPP Server.
FPP_SERVER_HOST_USER Yes Specify the named credentials for the user who owns the Grid Infrastructure home in FPP Server (Credential Name:Owner).
REFERENCE_HOST Optional Specify the node on which to setup the FPP Client. If not specified, any one of the nodes in the cluster will be automatically chosen.
WORKING_DIRECTORY Optional Specify the working directory path to stage the required binaries for execution. By default, it will use the agent stage directory.
FPP_SERVER_WORKING_DIRECTORY Optional Specify the working directory path from FPP Server to stage required binaries for execution. By default, it will use the agent stage directory.
PREREQS_ONLY Optional Only run the prerequisite checks to verify readiness to setup the FPP client.

Options: true/false (default value: false)
  • Provision an FPP Server on Existing Grid Infrastructure
    emcli submit_procedure -input_file=data:"/home/user_name/FPP/input.properties" -name="SETUP_FPP_SERVER"

    Note:

    The parameter -name="SETUP_FPP_SERVER" is required when provisioning an FPP server. SETUP_FPP_SERVER is the command action name and not a user defined name for the operation.
    Sample input file: 
    TARGET_NAME=emracn0607
FPP_DISK_GROUP=MGMTDB
FPP_IMAGES_MOUNTPOINT=/scratch/cuser/fppImages
GNS_VIP_ADDRESS=emracn0607-gns.subnet1rg.emsubnet.companyvcn.com
NORMAL_USER=CUSER:SYSMAN
ROOT_USER=CUSER_ROOT:SYSMAN
MIN_HEAP_SIZE=3G
MAX_HEAP_SIZE=5G
REST_USER_NAME=restuser
REST_USER_PASSWORD=<password>
REST_USER_EMAIL=user@company.com
  • Provision an FPP Client on Existing Grid Infrastructure
    emcli submit_procedure -input_file=data:"/home/user_name/FPP/input.properties" -name="SETUP_FPP_CLIENT"

    Note:

    The parameter -name="SETUP_FPP_CLIENT" is required when provisioning an FPP server. SETUP_FPP_CLIENT is the command action name and not a user defined name for the operation.
    Sample input file: 
    TARGET_NAME=emracp1011
NORMAL_USER=CUSER:SYSMAN
ROOT_USER=CUSER_ROOT:SYSMAN
FPP_SERVER_TARGET_NAME=emracn0607
FPP_SERVER_HOST_USER=CUSER:SYSMAN
WORKING_DIRECTORY=/scratch/cuser/tmp
  • Provision an FPP Server and Grid Infrastructure
    emcli submit_procedure -input_file=data:"/home/user_name/FPP/gi_input.properties" -name="SETUP_FPP_SERVER"

    Note:

    The parameter -name="SETUP_FPP_SERVER" is required when provisioning an FPP server. SETUP_FPP_SERVER is the command action name and not a user defined name for the operation.
    Sample input file: 
    ASMDBA_GROUP=oinstall
ASMOPER_GROUP=oinstall
ASM_DISK_LISTS=/mnt/emracdev/emracn0607/ASMDISK/disk1,/mnt/emracdev/emracn0607/ASMDISK/disk2,/mnt/emracdev/emracn0607/ASMDISK/disk3
ASM_DISK_STRINGS=/mnt/emracdev/emracn0607/ASMDISK/disk*;/mnt/emracdev/emracn0607/MGMTDB/disk*
AUTOVIP_ENABLED=false
CLUSTER_NAME=emracn0607
CONFIGURE_ASMFD=false
CONFIGURE_GIMR=true
CONFIGURE_MODE=CONFIGURE_ASM
CVU_CHECK_ERRORMODE=stop
DB_COMPONENT=Fleet/OH19/linux64/DB19_18 - OH19 RU18
DB_HOST_NORMAL_CREDNAMES=CUSER:SYSMAN
DB_HOST_ROOT_CREDNAMES=CUSER_ROOT:SYSMAN
DB_INS_CS_GUID=0
DB_ORACLE_BASE_LOC=/scratch/cuser/19c/racbase
DB_ORACLE_HOME_LOC=/scratch/cuser/19c/rachome
DB_PRODUCT_VERSION=19.0.0.0.0
DEPLOY_MODE=DEPLOY_GI
DISKGROUP_AU_COMPATIBLE=DATA:4:::;MGMTDB:4:::
DISK_GROUP_NAMES=DATA,MGMTDB
FLEX_ENABLED=false
GIMR_DB_ORACLE_BASE_LOC=/scratch/cuser/19c/racbase
GIMR_DB_ORACLE_HOME_LOC=/scratch/cuser/19c/rachome
GIMR_DISK_GROUP=MGMTDB
GIMR_TYPE=NOGIMR
GI_AU_SIZE=4
GI_CLUSTER_TYPE=1
GI_COMPONENT=Fleet/GI1919/linux64/GI_19_19 - GI 19 RU19
GI_HOME_SHARED=false
GI_HOST_NORMAL_CREDNAMES=CUSER:SYSMAN
GI_HOST_ROOT_CREDNAMES=CUSER_ROOT:SYSMAN
GI_ORACLE_BASE_LOC=/scratch/gridbase
GI_ORACLE_HOME_LOC=/scratch/gridhome
GI_PRODUCT_VERSION=19.0.0.0.0
GI_STORAGE_TYPE=1
GNS_ENABLED=true
GNS_VIP_ADDRESS=emracp1011-gns.subnet1rg.emsubnet.companyvcn.com
GRID_DISK_FLAG=true
GROUP_VERSION=19.0.0.0.0
INTERFACE_PARAM_VALUE=ens3:100.75.0.0:1,ens4:192.168.1.0:5
NOT_RELINK_DB_HOME_SELECTED=false
NOT_RELINK_GIMR_DB_HOME_SELECTED=false
NOT_RELINK_GI_HOME_SELECTED=false
OCR_VDSK_DISK_GROUP=DATA
OINSTALL_GROUP=oinstall
OSASM_GROUP=oinstall
OSBACKUPDBA_GROUP=oinstall
OSDBA_GROUP=oinstall
OSDGDBA_GROUP=oinstall
OSKMDBA_GROUP=oinstall
OSOPER_GROUP=oinstall
OSRACDBA_GROUP=oinstall
PAUSE_AFTER_PREREQ=false
PLATFORM_ARUID=226
PREREQ_CHECK_ERRORMODE=continue
RAC_DBCA_MODE=CreateRACDatabase
RAC_HOME_SHARED=false
RAC_STORAGE_TYPE=1
REDUNDANCYS=NORMAL,NORMAL
ROLE_NODENAMES=HUB,HUB
RUN_CVU_FROM_OH=true
SCAN_NAME=emracn0607-r.racdb-scan.emsubnet.companyvcn.com
SCAN_PORT=1521
SKIP_CVU_CHECK=false
SKIP_PREREQUISITE_CHECKS=false
SOURCE_TYPE=SOFTWARE_LIBRARY
SSH_SETUP=false
TARGET_HOST_LIST=emracn07.subnet1rg.emsubnet.companyvcn.com,emracn06.subnet1rg2.emsubnet.companyvcn.com
VERSION_GREATER_12102=true
VIP_NODENAMES=emracn07-vip.subnet1rg.emsubnet.companyvcn.com,emracn06-vip.subnet1rg.emsubnet.companyvcn.com
WORK_DIR_LOC=/tmp/
ASM_SYS_PASSWORD=oracle
FPP_CONFIGURATION_TYPE=server
FPP_DISK_GROUP=MGMTDB
FPP_IMAGES_MOUNTPOINT=/scratch/cuser/mount
REST_USER_NAME=restuser
REST_USER_PASSWORD=<password>
REST_USER_EMAIL=user@company.com
  • Provision an FPP Client and Grid Infrastructure
    emcli submit_procedure -input_file=data:"/home/user_name/FPP/gi_client_input.properties" -name="RACPROV2"

    Note:

    The parameter -name="RAC_PROV" is required when provisioning an FPP Client and Grid Infrastructure. RAC_PROV is the command action name and not a user defined name for the operation.
    Sample input file: 
    ASMDBA_GROUP=oinstall
ASMOPER_GROUP=oinstall
ASM_DISK_LISTS=/mnt/emracdev/emracp1011/ASMDISK/disk1,/mnt/emracdev/emracp1011/ASMDISK/disk2,/mnt/emracdev/emracp1011/ASMDISK/disk3
ASM_DISK_STRINGS=/mnt/emracdev/emracp1011/ASMDISK/disk*
ASM_FAILURE_AND_QUORUM_GROUPS=/mnt/emracdev/emracp1011/ASMDISK/disk1||false,/mnt/emracdev/emracp1011/ASMDISK/disk2||false,/mnt/emracdev/emracp1011/ASMDISK/disk3||false
ASM_OCRVDSK_FAILURE_AND_QUORUM_GROUPS=/mnt/emracdev/emracp1011/ASMDISK/disk1||false,/mnt/emracdev/emracp1011/ASMDISK/disk2||false,/mnt/emracdev/emracp1011/ASMDISK/disk3||false
ASM_SYS_PASSWORD=sample1
AUTOVIP_ENABLED=false
CLUSTER_NAME=emracp1011
CONFIGURE_ASMFD=false
CONFIGURE_GIMR=false
CONFIGURE_MODE=CONFIGURE_ASM
DB_ORACLE_BASE_LOC=/u02/app/oracle
DB_ORACLE_HOME_LOC=/u02/app/oracle/app/product/19.0.0.0.0/db
DB_PRODUCT_VERSION=19.0.0.0.0
DEPLOY_MODE=DEPLOY_GI
DISKGROUP_AU_COMPATIBLE=DATA:4:::
DISK_GROUP_NAMES=DATA
FLEX_ENABLED=false
GIMR_DB_ORACLE_BASE_LOC=/u03/app/oracle
GIMR_DB_ORACLE_HOME_LOC=/u03/app/oracle/app/product/21.0.0.0/gimrdb
GIMR_DISK_GROUP=DATA
GIMR_TYPE=NOGIMR
GI_AU_SIZE=4
GI_CLUSTER_TYPE=1
GI_COMPONENT=Fleet/OH19/linux64/DB19 - RU19
GI_HOME_SHARED=false
GI_HOST_NORMAL_CREDNAMES=CUSER:SYSMAN
GI_HOST_ROOT_CREDNAMES=CUSER_ROOT:SYSMAN
GI_ORACLE_BASE_LOC=/scratch/gridbase
GI_ORACLE_HOME_LOC=/scratch/gridhome
GI_PRODUCT_VERSION=19.0.0.0.0
GI_STORAGE_TYPE=1
GNS_ENABLED=false
GRID_DISK_FLAG=true
GROUP_VERSION=19.0.0.0.0
INTERFACE_PARAM_VALUE=ens3:100.75.0.0:1,ens4:192.168.1.0:5
NOT_RELINK_DB_HOME_SELECTED=false
NOT_RELINK_GIMR_DB_HOME_SELECTED=false
NOT_RELINK_GI_HOME_SELECTED=false
OCR_VDSK_DISK_GROUP=DATA
OINSTALL_GROUP=oinstall
OSASM_GROUP=oinstall
PAUSE_AFTER_PREREQ=false
PLATFORM_ARUID=226
PREREQ_CHECK_ERRORMODE=continue
RAC_DBCA_MODE=CreateRACDatabase
RAC_HOME_SHARED=false
RAC_STORAGE_TYPE=1
REDUNDANCYS=NORMAL
ROLE_NODENAMES=HUB,HUB
RUN_CVU_FROM_OH=true
SCAN_NAME=emracp1011-r.racdb-scan.emsubnet.companyvcn.com
SCAN_PORT=1521
SKIP_CVU_CHECK=true
SKIP_PREREQUISITE_CHECKS=false
SOURCE_TYPE=SOFTWARE_LIBRARY
SSH_SETUP=false
TARGET_HOST_LIST=emracp10.subnet1rg2.emsubnet.companyvcn.com,emracp11.subnet1rg2.emsubnet.company.com
VERSION_GREATER_12102=true
VIP_NODENAMES=emracp10-vip.subnet1rg2.emsubnet.companyvcn.com,emracp11-vip.subnet1rg2.emsubnet.companyvcn.com
FPP_SERVER_TARGET_NAME=emracn0607
FPP_SERVER_HOST_USER=CUSER:SYSMAN
FPP_CONFIGURATION_TYPE=client
#PREREQS_ONLY=true
WORK_DIR_LOC=/tmp/

Optional FPP Client Registration

FPP Client registration occurs automatically using Enterprise Manager, should you optionally need to register the FPP client manually use the following EM CLI or REST API operations.
  • REST API: Register FPP Client
  • EM CLI: Use command emcli db_software_maintenance -setup -registerFPPClient-input_file="data:<fileLocation>"w with the following input file:
    "serverName": "<Server Name>",  
"clientName": "<Client Name>"