Class: MintPress::OracleGridInfrastructure::Grid

Inherits:
Object
  • Object
show all
Includes:
MintLogger, Mixins::Properties
Defined in:
src/oracle-database/lib/oracle-database/model/grid/grid.rb

Overview

An Oracle grid object that represents an entire Oracle Grid Infrastructure stack, including Installations, Instances, Nodes, etc. This class provides a set of methods (or pointers to all relevant sub-classes) to manage Grid Infrastructure and their associated components.

Properties (Read/Write)

  • #name ⇒ String (Default Value: self.class.to_s.gsub('::',''))

    Property Attributes
    • default ⇒ self.class.to_s.gsub('::','')
    

27
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 27

property :name, type: String, default: self.class.to_s.gsub('::','')
  • #exadata ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    "Is this Grid Infrastructure an Oracle Exadata deployment?"
    Property Attributes
    • default ⇒ false
    

29
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 29

property :exadata, type: [ TrueClass, FalseClass ], default: false, description: "Is this Grid Infrastructure an Oracle Exadata deployment?"
  • #grid ⇒ self.class (Default Value: self)
    Ensure everyone gets a reference to us, including us
    Property Attributes
    • default ⇒ self
    • auto_push ⇒ true
    • tree_root ⇒ true
    

32
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 32

property :grid, type: self.class, default: self, auto_push: true, tree_root: true
  • #nodes ⇒ Hash of ⇒ MintPress::OracleDatabase::Node (Default Value: {})

    Property Attributes
    • default ⇒ {}
    • canonical ⇒ true
    • required ⇒ true
    

33
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 33

property :nodes, type: MintPress::OracleDatabase::Node, default: {}, hash: true, canonical: true, required: true
  • #asm_diskgroup ⇒ Hash of ⇒ MintPress::OracleGridInfrastructure::ASMDiskGroup (Default Value: {})
    "Main Data Diskgroup for the Oracle Grid Infrastructure"
    Property Attributes
    • alias ⇒ :diskgroup
    • default ⇒ {}
    • canonical ⇒ true
    • required ⇒ true
    

35
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 35

property :asm_diskgroup, type: MintPress::OracleGridInfrastructure::ASMDiskGroup, alias: :diskgroup, default: {}, hash: true, canonical: true, required: true, description: "Main Data Diskgroup for the Oracle Grid Infrastructure"
  • #gimr_diskgroup ⇒ Hash of ⇒ MintPress::OracleGridInfrastructure::ASMDiskGroup (Default Value: {})
    "The Diskgroup for the Oracle Grid Infrastructure Metadata Repository (GIMR) separate to the the main Data Diskgroup above."
    Property Attributes
    • default ⇒ {}
    • canonical ⇒ true
    

36
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 36

property :gimr_diskgroup, type: MintPress::OracleGridInfrastructure::ASMDiskGroup, default: {}, hash: true, canonical: true, description: "The Diskgroup for the Oracle Grid Infrastructure Metadata Repository (GIMR) separate to the the main Data Diskgroup above."
  • #sysasm_username ⇒ String
    "Username for SYS user of Oracle ASM"
    Property Attributes
    • required ⇒ true
    

38
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 38

property :sysasm_username, type: String, required: true, description: "Username for SYS user of Oracle ASM"
  • #sysasm_password ⇒ Mint::Secret
    "Password for SYS user of Oracle ASM"
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    

39
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 39

property :sysasm_password, type: Mint::Secret, from: String, required: true, description: "Password for SYS user of Oracle ASM"
  • #install_type ⇒ String (Default Value: 'CRS_SWONLY')

    Property Attributes
    • required ⇒ true
    • default ⇒ 'CRS_SWONLY'
    • allowed_values ⇒ %w{CRS_CONFIG HA_CONFIG UPGRADE CRS_SWONLY HA_SWONLY CRS_ADDNODE}
    

41
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 41

property :install_type, type: String, required: true, default: 'CRS_SWONLY', allowed_values: %w{CRS_CONFIG HA_CONFIG UPGRADE CRS_SWONLY HA_SWONLY CRS_ADDNODE}
  • #asm_storage_option ⇒ String (Default Value: "ASM")
    "ASM Storage Type. Allowed values are : ASM and ASM_ON_NAS. ASM_ON_NAS applicable only if oracle.install.crs.config.ClusterConfiguration=STANDALONE"
    Property Attributes
    • allowed_values ⇒ %w(ASM ASM_ON_NAS),
    • default ⇒ "ASM"
    

50
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 50

property :asm_storage_option, type: String, allowed_values: %w(ASM ASM_ON_NAS), default: "ASM", description: "ASM Storage Type. Allowed values are : ASM and ASM_ON_NAS. ASM_ON_NAS applicable only if oracle.install.crs.config.ClusterConfiguration=STANDALONE"
  • #asm_configure_as_extended_cluster ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    "Specify 'true' if you would like to configure the cluster as Extended, else specify 'false'"
    Property Attributes
    • default ⇒ false
    

51
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 51

property :asm_configure_as_extended_cluster, type: [ TrueClass, FalseClass ], default: false, description: "Specify 'true' if you would like to configure the cluster as Extended, else specify 'false'"
  • #crs_scan_name ⇒ String
    "The name for SCAN"
    Property Attributes 
    

69
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 69

property :crs_scan_name, type: String, description: "The name for SCAN"
  • #crs_scan_port ⇒ Integer
    "Specify a unused port number for SCAN service"
    Property Attributes 
    

70
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 70

property :crs_scan_port, type: Integer, description: "Specify a unused port number for SCAN service"
  • #asm_configure_afd ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    "Configure AFD - ASM Filter Driver. Applicable only for FLEX_ASM_STORAGE option. Specify 'true' if you want to configure AFD, else specify 'false'"
    Property Attributes
    • default ⇒ false
    

72
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 72

property :asm_configure_afd, type: [ TrueClass, FalseClass ], default: false, description: "Configure AFD - ASM Filter Driver. Applicable only for FLEX_ASM_STORAGE option. Specify 'true' if you want to configure AFD, else specify 'false'"
  • #crs_cluster_name ⇒ String
    "Specify a name for the Cluster you are creating."
    Property Attributes 
    

80
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 80

property :crs_cluster_name, type: String, description: "Specify a name for the Cluster you are creating."
  • #crs_cluster_type ⇒ String (Default Value: 'STANDALONE')
    "Specify the required cluster configuration"
    Property Attributes
    • allowed_values ⇒ %w{STANDALONE DOMAIN MEMBERDB MEMBERAPP},
    • default ⇒ 'STANDALONE'
    

81
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 81

property :crs_cluster_type, type: String, allowed_values: %w{STANDALONE DOMAIN MEMBERDB MEMBERAPP}, default: 'STANDALONE', description: "Specify the required cluster configuration"
  • #crs_cluster_manifest ⇒ Pathname
    "Specify the Member Cluster Manifest file"
    Property Attributes
    • from ⇒ String
    

83
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 83

property :crs_cluster_manifest, type: Pathname, from: String, description: "Specify the Member Cluster Manifest file"
  • #crs_cluster_configure_gns ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    "Applicable only for STANDALONE, DOMAIN, MEMBERDB cluster configuration. Specify true if you would like to configure Grid Naming Service(GNS), else specify false"
    Property Attributes
    • default ⇒ false
    

85
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 85

property :crs_cluster_configure_gns, type: [ TrueClass, FalseClass ], default: false, description: "Applicable only for STANDALONE, DOMAIN, MEMBERDB cluster configuration. Specify true if you would like to configure Grid Naming Service(GNS), else specify false"
  • #crs_cluster_configure_vip_with_dhcp ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    "Applicable only for STANDALONE and DOMAIN cluster configuration if you choose to configure GNS. Specify true if you would like to assign SCAN name VIP and Node VIPs by DHCP, else specify false"
    Property Attributes
    • default ⇒ false
    

86
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 86

property :crs_cluster_configure_vip_with_dhcp, type: [ TrueClass, FalseClass ], default: false, description: "Applicable only for STANDALONE and DOMAIN cluster configuration if you choose to configure GNS. Specify true if you would like to assign SCAN name VIP and Node VIPs by DHCP, else specify false"
  • #crs_cluster_gns_option ⇒ String
    "Applicable only if you choose to configure GNS. Specify the type of GNS configuration for cluster. Allowed values are: CREATE_NEW_GNS and USE_SHARED_GNS. Only USE_SHARED_GNS value is allowed for MEMBERDB cluster configuration."
    Property Attributes
    • allowed_values ⇒ %w{CREATE_NEW_GNS USE_SHARED_GNS},
    

87
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 87

property :crs_cluster_gns_option, type: String, allowed_values: %w{CREATE_NEW_GNS USE_SHARED_GNS}, description: "Applicable only if you choose to configure GNS. Specify the type of GNS configuration for cluster. Allowed values are: CREATE_NEW_GNS and USE_SHARED_GNS. Only USE_SHARED_GNS value is allowed for MEMBERDB cluster configuration."
  • #crs_cluster_gns_client_datafile ⇒ Pathname
    "Applicable only if SHARED_GNS is being configured for cluster. Specify the path to the GNS client data file"
    Property Attributes
    • from ⇒ String
    

88
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 88

property :crs_cluster_gns_client_datafile, type: Pathname, from: String, description: "Applicable only if SHARED_GNS is being configured for cluster. Specify the path to the GNS client data file"
  • #crs_ignore_down_nodes ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    "Specify whether to ignore down nodes during upgrade operation."
    Property Attributes
    • default ⇒ false
    

108
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 108

property :crs_ignore_down_nodes, type: [ TrueClass, FalseClass ], default: false, description: "Specify whether to ignore down nodes during upgrade operation."
  • #crs_storage_option ⇒ String

    Property Attributes
    • allowed_values ⇒ %w(FILE_SYSTEM_STORAGE FLEX_ASM_STORAGE CLIENT_ASM_STORAGE NEAR_ASM_STORAGE)
    

110
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 110

property :crs_storage_option, type: String, allowed_values: %w(FILE_SYSTEM_STORAGE FLEX_ASM_STORAGE CLIENT_ASM_STORAGE NEAR_ASM_STORAGE)
  • #crs_sharedfs_voting_disk_locations ⇒ String
    Only if crs_storage_option == 'FILE_SYSTEM_STORAGE' Example: crs_sharedfs_voting_disk_locations '/oracle/shared/crs/vote1,/oracle/shared/crs/vote2,/oracle/shared/crs/vote3'
    Property Attributes 
    

114
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 114

property :crs_sharedfs_voting_disk_locations, type: String
  • #crs_sharedfs_voting_disk_redundancy ⇒ String (Default Value: 'NORMAL')

    Property Attributes
    • allowed_values ⇒ %w(NORMAL EXTERNAL),
    • default ⇒ 'NORMAL'
    

115
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 115

property :crs_sharedfs_voting_disk_redundancy, type: String, allowed_values: %w(NORMAL EXTERNAL), default: 'NORMAL'
  • #crs_sharedfs_ocr_locations ⇒ String
    Exmaple: crs_sharedfs_ocr_locations '/oracle/shared/crs/ocr1,/oracle/shared/crs/ocr2,/oracle/shared/crs/ocr3'
    Property Attributes 
    

117
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 117

property :crs_sharedfs_ocr_locations, type: String
  • #crs_sharedfs_ocr_redundancy ⇒ String (Default Value: 'NORMAL')

    Property Attributes
    • allowed_values ⇒ %w(NORMAL EXTERNAL),
    • default ⇒ 'NORMAL'
    

118
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 118

property :crs_sharedfs_ocr_redundancy, type: String, allowed_values: %w(NORMAL EXTERNAL), default: 'NORMAL'
  • #config_management_option ⇒ String (Default Value: 'NONE')
    "Specify the management option to use for managing Oracle Grid Infrastructure. Options are: 1. CLOUD_CONTROL - If you want to manage your Oracle Grid Infrastructure with Enterprise Manager Cloud Control, 2. NONE -If you do not want to manage your Oracle Grid Infrastructure with Enterprise Manager Cloud Control."
    Property Attributes
    • allowed_values ⇒ %w(CLOUD_CONTROL NONE),
    • default ⇒ 'NONE'
    

120
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 120

property :config_management_option, type: String, allowed_values: %w(CLOUD_CONTROL NONE), default: 'NONE', description: "Specify the management option to use for managing Oracle Grid Infrastructure. Options are: 1. CLOUD_CONTROL - If you want to manage your Oracle Grid Infrastructure with Enterprise Manager Cloud Control, 2. NONE   -If you do not want to manage your Oracle Grid Infrastructure with Enterprise Manager Cloud Control."
  • #config_oms_host ⇒ String
    "Only if config_management_option == 'CLOUD_CONTROL'"
    Property Attributes 
    

122
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 122

property :config_oms_host, type: String, description: "Only if config_management_option == 'CLOUD_CONTROL'"
  • #config_oms_port ⇒ Integer
    "Only if config_management_option == 'CLOUD_CONTROL'"
    Property Attributes 
    

123
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 123

property :config_oms_port, type: Integer, description: "Only if config_management_option == 'CLOUD_CONTROL'"
  • #config_em_adminuser ⇒ String
    "Only if config_management_option == 'CLOUD_CONTROL'"
    Property Attributes 
    

124
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 124

property :config_em_adminuser, type: String, description: "Only if config_management_option == 'CLOUD_CONTROL'"
  • #config_em_adminpassword ⇒ Mint::Secret
    "Only if config_management_option == 'CLOUD_CONTROL'"
    Property Attributes
    • from ⇒ String
    

125
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 125

property :config_em_adminpassword, type: Mint::Secret, from: String, description: "Only if config_management_option == 'CLOUD_CONTROL'"
  • #cluvfy_pre_verification ⇒ [ TrueClass, FalseClass ] (Default Value: true)

    Property Attributes
    • default ⇒ true
    

127
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 127

property :cluvfy_pre_verification, type: [ TrueClass, FalseClass ], default: true
  • #cluvfy_post_verification ⇒ [ TrueClass, FalseClass ] (Default Value: true)

    Property Attributes
    • default ⇒ true
    

128
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 128

property :cluvfy_post_verification, type: [ TrueClass, FalseClass ], default: true
  • #ignore_prereqs ⇒ [ TrueClass, FalseClass ] (Default Value: false)

    Property Attributes
    • default ⇒ false
    

129
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 129

property :ignore_prereqs, type: [ TrueClass, FalseClass ], default: false
  • #ignore_sysprereqs ⇒ [ TrueClass, FalseClass ] (Default Value: false)

    Property Attributes
    • default ⇒ false
    

130
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 130

property :ignore_sysprereqs, type: [ TrueClass, FalseClass ], default: false
  • #wait_for_completion ⇒ [ TrueClass, FalseClass ] (Default Value: true)

    Property Attributes
    • default ⇒ true
    

131
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 131

property :wait_for_completion, type: [ TrueClass, FalseClass ], default: true
  • #optional_args ⇒ String (Default Value: "")

    Property Attributes
    • default ⇒ ""
    

133
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 133

property :optional_args, type: String, default: ""
  • #target_tmp_dir ⇒ String (Default Value: '#{oracle_home}/../tmp')
    Single quotes for late binding
    Property Attributes
    • default ⇒ '#{oracle_home}/../tmp'
    

136
    		 
    # File 'src/oracle-database/lib/oracle-database/model/grid/grid.rb', line 136

property :target_tmp_dir, type: String, default: '#{oracle_home}/../tmp'

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Grid

Returns a new instance of Grid.

Instance Method Details

#admin_transport ⇒ Object

#execute_config_tools ⇒ Object

#execute_root_sh ⇒ Object

#exists? ⇒ Boolean

Returns:

  • (Boolean)

#get_instance_variables ⇒ Object

#grid_setup ⇒ Object

#install_packages ⇒ Object

#installation ⇒ Object

#oracleasm_configure ⇒ Object

#to_hash ⇒ Hash

Return a Hash representation for the Installation and all its sub-classes.

Returns:

  • (Hash) —
    the object in Hash format

#transport ⇒ Object

#usage ⇒ Object

#verify(options:, ignore_failure: false) ⇒ Object

USAGE: runcluvfy.sh comp [-verbose] Valid Components are: nodereach : checks reachability between nodes nodecon : checks node connectivity ssa : checks shared storage accessibility space : checks space availability sys : checks minimum system requirements clu : checks cluster integrity clumgr : checks cluster manager integrity ocr : checks OCR integrity olr : checks OLR integrity ha : checks HA integrity freespace : checks free space in CRS Home crs : checks CRS integrity nodeapp : checks node applications existence admprv : checks administrative privileges peer : compares properties with peers software : checks software distribution acfs : checks ACFS integrity asm : checks ASM integrity gpnp : checks GPnP integrity gns : checks GNS integrity scan : checks SCAN configuration ohasd : checks OHASD integrity clocksync : checks Clock Synchronization vdisk : checks Voting Disk configuration and UDEV settings healthcheck : checks mandatory requirements and/or best practice recommendations dhcp : checks DHCP configuration dns : checks DNS configuration baseline : collect and compare baselines USAGE: runcluvfy.sh stage -pre|-post [-verbose] Valid Stages are: -pre cfs : pre-check for CFS setup -pre crsinst : pre-check for CRS installation -pre acfscfg : pre-check for ACFS Configuration. -pre dbinst : pre-check for database installation -pre dbcfg : pre-check for database configuration -pre hacfg : pre-check for HA configuration -pre nodeadd : pre-check for node addition. -pre appcluster : pre-check for Oracle Clusterware Application Cluster Installation -post hwos : post-check for hardware and operating system -post cfs : post-check for CFS setup -post crsinst : post-check for CRS installation -post acfscfg : post-check for ACFS Configuration. -post hacfg : post-check for HA configuration -post nodeadd : post-check for node addition. -post nodedel : post-check for node deletion. -post appcluster : post-check for Oracle Clusterware Application Cluster Installation