ubiosconfig(8) 맨 페이지 - 윈디하나의 솔라나라

개요

섹션
맨 페이지 이름
검색(S)

ubiosconfig(8)

UBIOSCONFIG(8)          System Administration Commands          UBIOSCONFIG(8)

NAME
       ubiosconfig - A UEFI BIOS configuration tool for Oracle x86 servers.

SYNOPSIS
       ubiosconfig <subcommand> <type> [options]

DESCRIPTION
       The ubiosconfig command line utility is used to update the UEFI BIOS
       configuration on Oracle x86 servers that support this feature. The
       utility works by importing and exporting an XML representation of the
       UEFI BIOS settings. Please refer to the documentation for your server
       when changing BIOS configuration for any special instructions or
       handling requirements.

       When using this utility to remotely access a service processor over the
       network, credentials must be provided as part of the command arguments.
       In addition, command execution over a remote network connection is
       encrypted using TLS by default. This means that a trusted SSL
       certificate for the Oracle ILOM SP must be present on the host to
       validate the connection.

       You must be in root permission level to run ubiosconfig commands.

       This utility interacts directly with physical hardware and can not run
       in a virtual environment.

       A complete list of currently supported Oracle servers is available at:

       http://www.oracle.com/goto/ohmp

       Refer to the user documentation for your server for specific UEFI BIOS
       information.

SUBCOMMANDS
       The following subcommands are supported by ubiosconfig.

       For help on a specific subcommand, type: ubiosconfig <subcommand>
       --help

           Available subcommands:

             import     Import a configuration XML file for
                        application to the server at next power cycle.
             export     Export the UEFI BIOS configuration to a local
                        XML file.
             cancel     Cancel pending UEFI BIOS configuration changes.
             list       List status information regarding UEFI BIOS
                        import/export operations.
             reset      Set UEFI BIOS back to factory defaults on next
                        power cycle.

           General Options:

             -?, -h, --help                  Command line help.
             -V, --version                   Show the version of the command.
             -H, --remote_hostname,
                 --remote-hostname=sp_ip     Remote SP host name or IP address
                                             (must be paired with option -U).
             -U, --remote_username,
                 --remote-username=username  User name to log in to remote SP
                                             (must be paired with option -H).
             -t, --intfname=interface        Specify IPMI Interface to use.
                                             Example: -t lanplus
             -T, --remote-intfname-fallback=interface
                                             Fallback socket IPMI interface limit
                                             (interfaces are tried starting with
                                             the most secured one).
                                             Example: -T lanplus
             --no-cert-check                 Do not perform certificate checking.
             --cert-dir=pathname             Location of trusted certificates.

       Details on each subcommand, including supported types and options, are
       listed below.

       Always refer to the user documentation for your server before
       attempting UEFI BIOS configuration changes.

       import
           Import a configuration XML file for application to the server at
           next power cycle.

           The schema for this XML is controlled by the server and is unique
           for each platform. In general, only import settings into a server
           which were exported from the same server model. Unsupported UEFI
           BIOS settings which are imported into a server will be ignored or
           rejected, depending on the server.

               ubiosconfig import <type> <-x xml_file> [options]

               <type>
                 all       Import all options from provided xml_file.
                 boot      Import only boot section of xml_file.
                 config    Import only configuration section of xml_file.

               [mandatory option]

                 -x, --xml_file   Use the specified XML file to change UEFI
                                  BIOS options.

               [options]
                 -y, --yes        Execute command without prompting for
                                  confirmation. Useful for scripting.
                 -f, --force      Ignore safeguards, and import BIOS XML
                                  file regardless of current system state.
                                  Potentially dangerous and not
                                  recommended.

       export
           Export the UEFI BIOS configuration to a local XML file.

               ubiosconfig export <type> [options]

               <type>
                 all       Export UEFI BIOS information from last power cycle.

               [options]
                 -y, --yes         Execute command without prompting for
                                   confirmation. Useful for scripting.
                 -x, --xml_file    Export to the specified file, otherwise
                                   dump to screen.
                 -f, --force       Ignore safeguards, and export BIOS XML
                                   file regardless of current system state.

       cancel
           Cancel pending UEFI BIOS configuration changes.

               ubiosconfig cancel <type>

               <type>
                  config    Cancel pending configuration changes. All currently
                            pending UEFI BIOS changes will be discarded.

       list
           List information about pending changes to UEFI BIOS settings at the
           next server boot.

               ubiosconfig list <type>

               <type>
                  status    Show status of all changes to UEFI BIOS configuration
                            operations.

       reset
           Set UEFI BIOS back to factory defaults on next power cycle.

               ubiosconfig reset <type>

               <type>
                  config    Sets UEFI BIOS to reset to factory defaults on next
                            power cycle.
                            Pending UEFI BIOS changes will be added on top of
                            defaults.
                  cancel    Cancels and resets to default settings.

OPTIONS
       The following short and long general options are supported with
       ubiosconfig:

       -?, -h, --help
           Display a brief usage message and then exit.

       -H, --remote-hostname=sp_ip
           Provide host name or IP address of remote SP (must be paired with
           option -U).

       -t, --intfname=interface
           Specifies the IPMI interface to use. No auto-detect is attempted.
           Supported interfaces that are compiled in are visible in the usage
           help output (socket interfaces in case -H option is used). See the
           -T description for more information.

       -T, --remote-intfname-fallback=interface
           Selects the least secured IPMI socket interface to use if more
           secure interfaces are not supported. The tool attempts the most
           secure interface first (orcltls). If the BMC does not support the
           interface, then attempt the next most secured socket interface
           until the specified interface. Supported socket interfaces that are
           compiled in are visible in the usage help output in the appropriate
           order. If lanplus or lan is specified, certificate checking is
           disabled when attempting the orcltls interface.

               Note
               If the -T or -t option is not specified, then no auto-detect is
               enabled and only the orcltls interface is attempted including
               certificate checking.

       -U, --remote-username=username
           Provide user name with root privileges to login to remote SP (must
           be paired with option -H).

       -V, --version
           Print version information for ubiosconfig and then exit.

       --cert-dir=pathname
           Location of trusted certificates if they are not in the expected
           default location. The expected default location is
           /etc/openssl/certs in Oracle Solaris.

       --no-cert-check
           Do not perform certificate checking.

       The following subcommand short and long options are supported. Refer to
       the subcommands section to see which options are supported for each
       subcommand.

       -f, --force
           Used with import and export subcommands to force the execution of
           the command regardless of system state. Not recommended.

       -x, --xml_file=filename
           Used with import and export subcommands to specify the target XML
           metadata file.

       -y, --yes
           Used with the import and export subcommands to execute the command
           without user prompts. Can be used for scripting.

ERRORS
       The following are ubiosconfig error codes:

           Error Code Error Description
           ---------- ------------------------------------------
           50         Cannot connect to IPMI bmc device.
           84, 85     Cannot update BIOS, update in progress.
           86         Invalid configuration file provided.
           87         Invalid boot configuration provided.
           88         Invalid boot and configuration provided.
           89         Failed to update BIOS.
           90         BIOS partially updated.
           91         BIOS out of sync.
           247        UEFI not supported.

FILES
       /var/log/ssm/ubiosconfig.log
           ubiosconfig specific log file.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes: allbox
       tab(:); cB cB.  T{

       ATTRIBUTE TYPE T}:T{

       ATTRIBUTE VALUE T} l l l l.  T{

       Availability T}:T{

       system/management/ubiosconfig T} T{

       Interface Stability T}:T{

       Committed T}


SEE ALSO
       For more information on certificates, refer to the openssl man page.

       For more information on Oracle Hardware Management Pack for Oracle
       Solaris, refer to http://www.oracle.com/goto/ohmp/solarisdocs

AUTHORS
       Oracle Corporation
           Publisher.

COPYRIGHT
       Copyright © 2010, 2022 Oracle and/or its affiliates. All rights
       reserved.

Oracle Corporation                07/05/2022                    UBIOSCONFIG(8)
맨 페이지 내용의 저작권은 맨 페이지 작성자에게 있습니다.
RSS ATOM XHTML 5 CSS3