Syntax

ALTER DBSERVER  {
  | SHUTDOWN SERVICES { RS | MS | ALL }
  | RESTART SERVICES { RS | MS | ALL }
  | RESTART BMC
  | STARTUP SERVICES { RS | MS | ALL }
  | LED { ON | OFF }
  | VALIDATE { MAIL | SNMP | CONFIGURATION }
  | VALIDATE SYSLOGCONF facility.priority
  | CONFIGUREBMC
  | { snmpuser=((user_clause1)[,(user_clauseN)]...) | snmpuser.name=(user_clause) }
  | attribute_name = attribute_value 
        [, attribute_name = attribute_value]...
  }

Usage Notes

The following table lists the arguments and options for the ALTER DBSERVER command:

([name=user1,] authProtocol=auth_type, authPassword=*
   [, privProtocol=priv_type, privPassword=*]) 
[,(name=userN, authProtocol=auth_type, authPassword=*
   [, privProtocol=priv_type, privPassword=*] )]...

The following are additional usage notes for the ALTER DBSERVER command:

• It may be necessary to restart, shut down, or start up a database server for the following reasons:
  • Software upgrades
  • Service outages that include any condition under which a database server is not responding to service requests
• To set up the database server to send notifications about alerts, you can configure the following database server attributes:
  • mailServer
  • smtpPort
  • smtpUseSSL
  • smtpFrom
  • smtpFromAddr
  • smtpToAddr
  • snmpSubscriber
  • snmpUser
  • snmpEngineID
  • notificationMethod
  • notificationPolicy
  • emailSubscriber

  The mailServer attribute specifies the fully qualified domain name of the email relay server used to send alert notifications. This attribute only requires specification in cases where DNS returns an unreachable or invalid mail exchange (MX) record for the email address specified in smtpToAddr. When you modify the mailServer attribute value, the Exadata Management Server (MS) automatically configures and restarts the sendmail service. You can clear the mailServer attribute and remove the email relay server from the sendmail configuration by setting mailServer to an empty string enclosed by quotation marks (mailServer='').

  The smtpToAddr attribute can be set to a list of comma-delimited email addresses that are the recipients of the alert notification. The list must be enclosed in quotation marks.

  The snmpSubscriber attribute can be set to a list of SNMP targets to which the SNMP alert notification is sent. The targets are specified as follows:

  snmpSubscriber[-|+]=(
    (host=host[,port=port][,type=subscriber_type][,community=community][,snmpuser=snmp_user_name][,fromIP="ip"][,asrmPort="ASRManager_port"])
  [,(host=host[,port=port][,type=subscriber_type][,community=community][,snmpuser=snmp_user_name][,fromIP="ip"][,asrmPort="ASRManager_port"])] ...)
  

  The snmpSubscriber attribute uses the following values:

  • The host must be specified as either a host name or an IP address. Enclose the host name or IP address in quotation marks if it contains non-alphanumeric characters.

  • The default value for port is 162. This value is optional.

  • The valid type values are v1, ASR, v3, and v3ASR.

    • Starting with Oracle Exadata System Software release 24.1.0, you must specify the type value.

      Previously, setting the type is optional, and the default value is v1.

    • The type=v3 and type=v3ASR options use SNMP V3. SNMP V3 is considered more secure than earlier SNMP versions, and should be used where possible.

    • The snmpSubscriber with type=ASR or type=v3ASR should only be configured to point to Oracle ASR Manager.

    • The type=ASR and type=v3ASR options set the Oracle ASR destination for Oracle Exadata Database Server, and its ILOM. Removing all snmpSubscriber entries with type=ASR and type=v3ASR from the SNMP subscriber list disables the Oracle ASR trap mechanism for Oracle Exadata Database Server and its ILOM.

    • For the v3ASR type, the user must be defined with authProtocol=SHA, and privProtocol=AES. These are the only protocols supported by Oracle ASR Manager. Setting the snmpSubscriber as type v3ASR also sets the ILOM properties and rules for traps sent by ILOM.

  • Starting with Oracle Exadata System Software release 24.1.0, you must specify the community value for subscribers with type=v1 or type=ASR. Also, common default values such as public and private are discouraged for security reasons.

    Previously, setting the community is optional, and the default value is public.

  • For subscribers with type=v3 or type=v3ASR, you must specify an SNMP user name (snmpuser=snmp_user_name), which is already configured within the server.

    For example:

    DBMCLI> ALTER DBSERVER snmpuser.snmpuser1=(authprotocol=SHA,authpassword=*)
    ...
    
    DBMCLI> ALTER DBSERVER snmpSubscriber=((host=newhost,port=162,type=v3,snmpuser=snmpuser1))
    

  • The fromIP field enables you to specify an IP address from which the trap is sent. If this field is not specified, it defaults to the IP address associated with eth0. Use this field if the default IP address is not registered with Oracle ASR Manager. Oracle ASR Manager only processes SNMP traps that are sent from IP addresses that it recognizes.

    The fromIP field is allowed only for SNMP subscribers whose type is either ASR or v3ASR.

    For example:

    DBMCLI> ALTER DBSERVER snmpSubscriber=((host=asrhost,port=162,community=asrcommunity,fromIP="1.1.1.1",type=ASR))
    

    The following example returns an error because the type is not ASR or v3ASR.

    DBMCLI> ALTER DBSERVER snmpSubscriber=((host=localhost,port=162,community=asrcommunity,fromIP="1.1.1.1",type=v1))
    DBM-00068: The fromIP field is only supported for ASR SNMP subscribers.
    

  • The asrmPort field enables you to specify the port number on an Oracle ASR Manager machine that MS uses to communicate with Oracle ASR Manager. This port must be the same as the HTTP port of Oracle ASR Manager’s HTTP Receiver. You can check this by running asr show_http_receiver on the Oracle ASR Manager machine.

    The asrmPort field is allowed only for SNMP subscribers whose type is either ASR or v3ASR. The default value for this port is 16161.

  By default, ALTER DBSERVER snmpSubscriber=(SNMPtargets) replaces the existing snmpSubscriber value. However, starting with Oracle Exadata System Software release 21.2.0, you can add to the existing list of SNMP targets by using snmpSubscriber+=(SNMPtarget). For example:

  DBMCLI> ALTER DBSERVER snmpSubscriber+=((host=newhost,port=162,community=snmpcommunity,type=v1))
  

  Also, starting with Oracle Exadata System Software release 22.1, you can remove an entry from the existing list of SNMP targets by using snmpSubscriber-=(SNMPtarget). For example:

  DBMCLI> ALTER DBSERVER snmpSubscriber-=((host=myhost,port=162,community=snmpcommunity,type=v1))
  

  After startup of the Management Server (MS), the snmpSubscriber list entries with type=ASR are added to the ILOM for the DBSERVER. This ensures that when an ILOM is replaced, the entries are set for the new ILOM. If the entries are removed from the ILOM, then they must be manually added to the ILOM using the ALTER DBSERVER ... snmpUser= command.

  The snmpUser attribute defines users who receives SNMP alerts. This command can only be run in interactive mode. There are two methods for configuring this attribute.

  snmpuser=((user_clause1)[,(user_clauseN)]...)
  
  snmpuser.name=(user_clause) 

  • If you specify snmpuser, then you must provide a user_clause for every configured user. If you omit a user, then that user will no longer receive SNMP alerts. The ((user_clause1)[,(user_clauseN)]...) string that you provide overwrites the previous string used for the snmpuser attribute.

  • If you specify snmpuser.name, then you must provide a user_clause for only the specified user. This allows you to add, delete, or modify each user individually, without having to supply the entire snmpuser attribute string each time.

  • If you use snmpuser='', then all SNMP users are removed. If you use snmpuser.name='', then only the specified user is removed. You cannot remove an SNMP user while it is still referenced by a V3 SnmpSubscriber.

  Each method uses a user_clause, which has the following general format:

  ([name=user1,] authProtocol=auth_type, authPassword=*
     [, privProtocol=priv_type, privPassword=*]) 
  [,(name=userN, authProtocol=auth_type, authPassword=*
     [, privProtocol=priv_type, privPassword=*] )]...

  If updating a single user using the snmpuser.name notation, do not include the phrase name=user1 in the user_clause.

  • name is the user name.

  • Only * is allowed for the password values in the command. Passwords are not stored or displayed. Secure hash keys are computed and used for trap authentication and encryption.

  • authProtocol specifies the authentication protocol.

    Options include MD5 and SHA. Additionally, Oracle Exadata System Software release 24.1.0 introduces the following SHA2 authentication protocols for SNMP V3 subscribers: SHA-224, SHA-256, SHA-384, and SHA-512.

    The authProtocol must be specified for the snmpUser attribute.

    The system prompts for the authentication password. The authentication password must have 8 to 12 alphanumeric characters.

  • privProtocol is encryption protocol. Options are none, AES, or DES. The default is none when the privProtocol attribute is not specified.

    The system prompts for an encryption password if the encryption protocol is specified. The password is exactly 8 alphanumeric characters, and they are case sensitive.

  The smtpUseSSL attribute enables Secure Socket Layer (SSL) encryption on the email notifications when the attribute is set to true.

  The notificationPolicy attribute value can be none or a combination of critical, warning, or clear, such as notificationPolicy='warning,clear.'

  • The critical value refers to hardware-generated alerts or alerts generated by Automatic Diagnostic Repository (ADR) or Baseboard Management Controller (BMC). The critical value also refers to a metric alert when the value exceeds the critical threshold specified in the metric definition.
  • The warning value refers to a metric alert when the value exceeds the warning threshold specified in the metric definition.
  • The clear value refers to a metric alert when the value is below the threshold boundary after having previously exceeded a warning or critical threshold.
  • The maintenance value refers to all hardware-related errors. The hardware errors are reported as "Maintenance" in email message subject lines.

• For each subscriber, the host must be specified as either a domain name or an IP address. Enclose the host name or IP address in quotation marks if it contains non-alphanumeric characters. Port and community values are optional. The default port value is 162. The default community value is public. The type value is optional. The default value for type is NULL. The types ASR, V3, and v3ASR are the only supported non-NULL value.

• After startup of the Management Server (MS), the snmpSubscriber list entries with type ASR or v3ASR are added to the ILOM for the database server. This ensures that when an ILOM is replaced, the entries are set for the new ILOM. If the entries are removed from the ILOM, then they must be manually added to the ILOM using the ALTER DBSERVER ... snmpUser= command.

• The snmpSubscriber with type=ASR or type=v3ASR should only be configured to point to Oracle ASR Manager.

• To validate that email messages are successfully sent for database server alerts or events, use the ALTER command with the VALIDATE MAIL option. The validation process sends a test email message to the configured recipient. If that test email message is not received, then an email configuration setting is not valid.

• The emailFormat attribute can be html or text. By default, email notifications are sent in HTML format. Change the value to text to receive plain text email notifications.

• The ALTER DBSERVER snmpEngineID command is used by the SNMP managers to subscribe to alerts from the database servers. The snmpEngineID parameter can be up to 20 characters. It should be unique for each target within a data center. The default is the database server name. This default is used if the snmpEngineID attribute is not set before the SNMP users are defined.

  The engine identifier should not be changed after SNMP users are defined. Any change to an engine identifier causes the user keys to be re-computed, and user passwords must be re-entered.

• If the database server name is changed, then you must choose a unique database server name.
• If an ipaddressN attribute is modified, then the network configuration file /etc/oracle/cell/network-config/cellinit.ora is modified.
• The ALTER DBSERVER snmpSubscriber command configures the Oracle ASR subscriber, and sends traps.

• The ALTER DBSERVER emailSubscriber command sets a list of comma-delimited email addresses that are the recipients of alert notifications for specific alert types. The following is an example of the syntax:

  ALTER DBSERVER emailSubscriber = ((email="email_address1",                \ 
             alertType="alert_type")                               \
            [, (email="email_address2",alertType="alert_type"), ...])
  

  The email address must be a valid email address. The email parameter is mandatory. The alertType parameter specifies the type of alert, and is optional. The alert types are HARDWARE, SOFTWARE, METRIC or ADR. If the alert type is not specified, then the subscription is for all alert types.

  An empty input string removes the current set of subscribers.

  The notification policy must be set before alert notifications can be received. The policy applies to all email subscribers. The notification policy for these alerts are the same as for snmpSubscriber alerts.

• The syslogconf attribute extends syslog rules for a database server. The attribute can be used to designate that syslog messages be forwarded to a specified management server. On the management server, the forwarded messages are directed to a file, console, or management application, depending on the syslog configuration on the management server. The following shows the syntax for the attribute:

  syslogconf = ('selector @node' [, 'selector @node']... )
  

  In the preceding syntax, selector is the message type, and node is the specified server. Both variables follow syslog.conf standard syntax rules.

  • The facility option for the syslogconf attribute must be one of the following: auth, authpriv, cron, daemon, ftp, kern, lpr, mail, mark, news, security, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7, none, or *.

  • The priority option for the syslogconf attribute must be one of the following: alert, crit, debug, emerg, err, error, info, notice, panic, warn, warning, none, or * (asterisk).

• The ALTER DBSERVER VALIDATE syslogconf selector command sends a test log message. The test message is directed as specified by rules in the /etc/syslog.conf file. If the syslogconf assignment extends the syslog rules, then a test message is forwarded to the specified management servers.

• Starting with Oracle Exadata System Software release 19.1.0, you can use the syslogFormat attribute to change the standard format for syslog to any format by setting the value to the desired format string. Setting the syslogFormat attribute to an empty string removes the format change, reverting the syslog format to the default format. If the format string contains a control character, it must be preceded by a backslash when entering the command.

  See Example 9-24 for examples.

• Starting with Oracle Exadata System Software release 19.3.0, you can use the syslogFormat attribute to enable sending syslog in an encrypted format. For the complete configuration steps, refer to Encrypting System Log Information.

• You can turn off the diagnostic pack attachment to emails by running the following command:

  ALTER DBSERVER diagPackEmailAttach=FALSE

• Starting with Oracle Exadata System Software release 19.1.0, the httpsAccess attribute can be used to specify a list of IP addresses or IP subnet masks that control who can access the RESTful service via HTTPs. The value you specify for httpsAccess overwrites any previous value. You can use the following values for httpsAccess:

  • ALL — to allow access to all hosts (Default)
  • NONE — to disable the HTTPs port completely
  • IP1, IP2,..., IPn — to only allow access to hosts with IP addresses IP1, IP2,..., IPn where IPn is a valid IP address in IPv4, IPv4 subnet, IPv6 or IPv4-embedded IPv6 format. You can specify a maximum of 512 IP addresses for the access control list.

  Additionally, instead of a single IP address, you can use the / character to specify a range of IP addresses using a subnet mask. For example the range '192.168.10.0/24' corresponds to hosts having IP addresses from 192.168.10.1 to 192.168.10.255. If you specify an IP address range, you need to enclose the IP address string in quotes.

• Starting with Oracle Exadata System Software release 24.1.0, the listeningInterface attribute specifies the network interfaces that listen for commands using the Exadata RESTful service. The value you specify for listeningInterface overwrites any previous value. You can use the following values for listeningInterface:

  • ALL — to allow access on all network interfaces (Default)
  • NONE — to disable access on all network interfaces
  • IP1, IP2, ..., IPn — to allow access only through the network interfaces associated with the specified IP addresses

  The listeningInterface attribute complements the httpsAccess attribute. The listeningInterface attribute specifies which server network interfaces accept REST requests, while the httpsAccess attribute restricts the source of requests to the Exadata RESTful service.

• To set up CA-certified security certificates on the cell for use with ExaCLI, use the following attributes:

  Note:

  The following attributes can be used only if you are running the ALTER CELL command from ExaCLI.

  • securityPubKey - Specifies the URL to the public key file.

  • securityPrivKey - Specifies the URL to the private key file.

  • securityPrivKeyPW - Specifies the password to use if the private key file is encrypted.

  For example:

  ExaCLI> alter cell securityPubKey="http://www.example.com/security/newkey.crt",  -
                     securityPrivKey="http://www.example.com/security/newkey.key", -
                     securityPrivKeyPW=*
  
  password=****************
  

  After you upload the CA-certified security certificate, you must restart MS before the new security certificate is visible.

  CellCLI> alter cell restart services ms

  See Also:

  Using a CA-Certified Security Certificate

• Starting with Oracle Exadata System Software release 21.2.0, the ilomSyslogClients attribute specifies the remote destination to forward syslog messages from the Integrated Lights Out Manager (ILOM) service processor (SP).

  The ilomSyslogClients attribute accepts a comma-separated list of up to two loghost servers. For each loghost server, you must specify a valid hostname or IP address.

  For example:

  DBMCLI> ALTER DBSERVER ilomSyslogClients="192.0.2.101,192.0.2.201"

  Note:

  The specified ilomSyslogClients must listen on port 514 to receive the ILOM syslog messages.

• Starting with Oracle Exadata System Software release 22.1, the syslogInput attribute enables syslog on the local host (database server or storage server) to forward additional logs to remote log servers.

  The syntax for configuring the syslogInput attribute is:

  syslogInput = ('selector @[@]node[:remote_port]' [, 'selector @[@]node[:remote_port]']... )
  

  In the preceding syntax, selector specifies the additional logs being forwarded. The selector value can contain the following entries:

  • audit - Specifies the audit log at /var/log/audit/audit.log.

  • aide - Specifies the Advanced Intrusion Detection Environment (AIDE) log at /var/log/aide/aide.log.

  • yum - Specifies the YUM log at /var/log/yum.log.

  Multiple selector entries must be separated by a semicolon (;) character.

  Each node is specified using the hostname or IP address preceded by one or two at sign (@) characters. You can include one at sign (@) to use UDP for communications or specify two at sign characters (@@) to use TCP.

  By default, the remote system receives communications on port 514, which is the default rsyslogd port. You can specify another port number by appending a colon (:) character and remote port number to the node specification

  In the following example, loghost1 is configured to receive audit and AIDE logs using UDP on the default rsyslogd port (514). Also, loghost2 is configured to receive YUM logs using TCP on port 10514.

  DBMCLI> ALTER DBSERVER syslogInput=('audit;aide @loghost1','yum @@loghost2:10514')

  To stop and remove additional log forwarding, set syslogInput to an empty string. For example:

  DBMCLI> ALTER DBSERVER syslogInput=''

• Set the pendingCoreCount attribute to increase the number of active cores on Oracle Exadata using capacity-on-demand.

  See also:

  • Restrictions for Capacity-On-Demand on Oracle Exadata Database Machine
  • Increasing the Number of Active Cores on Database Servers

Examples

Example 9-8 shows how to set the asrmPort field for an snmpSubscriber.

Example 9-9 shows how to enable and disable the auto diagpack upload feature.

Example 9-10 shows how to set up email notifications for the database server.

Example 9-11 shows how to modify the SNMP user.

Example 9-12 shows how to modify a single SNMP user.

Example 9-13 shows how to validate the email setup on a database server.

Example 9-14 shows how to change the format of email messages.

Example 9-15 shows how to validate the SNMP setup on a database server.

Example 9-16 shows how to specify the type of email alerts. In the example, one subscriber gets hardware and software alerts, and the other subscriber gets ADR alerts.

Example 9-17 shows how to start up and shut down database server services.

Example 9-18 shows how to set the LED on the database server.

Example 9-19 shows setting the pending core count for capacity-on-demand.

Example 9-20 shows how to add a rule using the syslogconf attribute.

Example 9-21 shows how to add and validate a rule with test message.

Example 9-22 shows how to remove the syslog.conf rule.

Example 9-23 shows how to restrict HTTPS Access to the Exadata RESTful service to a specific range of IP addresses.