org.glassfish.loadbalancer.admin.cli.export-http-lb-config.1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of load-balancer-admin Show documentation
The newest version!
export-http-lb-config(1)  asadmin Utility Subcommands  export-http-lb-config(1)

NAME
       export-http-lb-config - exports the load balancer configuration or load
       balancer to a file

SYNOPSIS
           export-http-lb-config [--help] --config config_name | --lbname load_balancer_name [--target target] [--retrievefile=false] [file_name]

DESCRIPTION
       The export-http-lb-config subcommand exports a load balancer
       configuration or load balancer into a file that the load balancer
       plug-in can use. The default file name is loadbalancer.xml, but you can
       specify a different name. Once exported, you manually copy the exported
       file to the load balancer plug-in location before configuration changes
       are applied. The --target option makes it possible to generate a
       loadbalancer.xml for clusters or standalone instances without having to
       manually create lb-config or load-balancer elements in the target's
       domain.xml.

       To apply changes to the load balancer without manually copying the
       configuration file, configure the load balancer to automatically apply
       changes with create-http-lb. If you use the create-http-lb subcommand,
       you do not need to use export-http-lb-config.

           Note
           +----------------------------------------+
           |           This subcommand is only      |
           |           applicable to Oracle         |
           |           GlassFish Server. This       |
           |           subcommand is not applicable |
           |           to GlassFish Server Open     |
           |           Source Edition.              |
           +----------------------------------------+

OPTIONS
       --help, -?
           Displays the help text for the subcommand.

       --config
           Specifies which load balancer configuration to export.

           Specify either a load balancer configuration or a load balancer.
           Specifying both results in an error.

       --lbname
           Specifies the load balancer to export.

           Specify either a load balancer configuration or a load balancer.
           Specifying both results in an error.

       --retrievefile
           If set to true, retrieves the loadbalancer.xml file from the remote
           machine. The default is false.

       --target
           Specifies the target to which the load balancer configuration will
           be exported. If a target is not specified, the load balancer
           configuration is exported to the location specified with file_name.

OPERANDS
       file_name
           Specifies the file name and location of the exported configuration.

           *   If you specify a directory (relative or absolute) but not a
               file name, the file named
               loadbalancer.xml.load_balancer_config_name is created in the
               specified directory. On Microsoft Windows systems the path must
               be in quotes.

           *   If you specify a file name in a relative or absolute path, the
               file is created with the name you specify in the directory you
               specify.

           *   If you specify a file name but do not specify a directory, the
               file is created with that name in the current working
               directory.

           *   If you do not specify this operand, the default value is a file
               named loadbalancer.xml.load_balancer_config_name created in the
               domain-dir/generated directory.

       target
           Specifies the target to which the configuration will be exported.

           Valid values are:

           *   cluster_name- Specifies a cluster and its server instances.

           *   stand-alone_instance_name- Specifies a specific server
               instance.

EXAMPLES
       Example 1, Exporting a Load Balancer Configuration on UNIX
           The following example exports a load balancing configuration named
           mycluster-http-lb-config to a file named loadbalancer.xml in the
           /Sun/AppServer directory .

               asadmin> export-http-lb-config --config mycluster-http-lb-config /Sun/AppServer/loadbalancer.xml
               Command export-http-lb-config executed successfully.

       Example 2, Exporting a Load Balancer Configuration on Windows
           The following example exports a load balancing configuration named
           mycluster-http-lb-config to a file named loadbalancer.xml in the
           C:\Sun\AppServer directory on a Microsoft Windows system.

               asadmin> export-http-lb-config --config mycluster-http-lb-config "C:\Sun\AppServer\loadbalancer.xml"
               Command export-http-lb-config executed successfully.

EXIT STATUS
       0
           subcommand executed successfully

       1
           error in executing the subcommand

SEE ALSO
       create-http-lb(1), create-http-lb-config(1), list-http-lb-configs(1)

       asadmin(1M)

Jakarta EE 10                   09 Aug 2017            export-http-lb-config(1)